更新时间:2024-08-20 GMT+08:00
分享

构建程序

本例提供了支持优雅关机功能的程序,使用空白模板创建函数,用户可以学习使用。

创建函数

  1. 登录函数工作流控制台,在左侧导航栏选择“函数 > 函数列表”,进入函数列表界面。
  2. 单击“创建函数”,进入创建函数流程。
  3. 选择“创建空白函数”,填写函数配置信息。输入基础配置信息,完成后单击“创建函数”。
    • 函数类型:事件函数。
    • 函数名称:输入“as_graceful_shutdown”。
    • 委托名称:选择创建委托中创建的“ASOperation”。
    • 运行时语言:选择“Python3.6”。
  4. 进入as_graceful_shutdown函数详情页,在“代码”页签,代码选择“上传自ZIP文件”,将如下程序保存成扩展名为“.py”的文件格式,压缩成zip包,并上传。然后,在“设置 > 常规设置”页签,设置如下信息,完成后单击“保存”。
    # -*- coding:utf-8 -*-
    import json
    import time
    
    from huaweicloudsdkas.v1 import AsClient
    from huaweicloudsdkas.v1 import AttachCallbackInstanceLifeCycleHookRequest
    from huaweicloudsdkas.v1 import CallbackLifeCycleHookOption
    from huaweicloudsdkas.v1.region.as_region import AsRegion
    from huaweicloudsdkecs.v2.region.ecs_region import EcsRegion
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkecs.v2 import EcsClient
    from huaweicloudsdkecs.v2 import ServerId
    from huaweicloudsdkecs.v2 import BatchStopServersOption
    from huaweicloudsdkecs.v2 import BatchStopServersRequest
    from huaweicloudsdkecs.v2 import BatchStopServersRequestBody
    
    
    def handler(event, context):
        # 用户配置需要在FuctionGraph前台配置处手动加入环境变量
        # Need to configure environmental variables at FuctionGraph console page
        # 客户的project_id
        # your project_id
        # region为华为云的局点名,例如cn-north-4
        # Huawei region alias,like cn-north-4 for Beijing4
        # 客户账户名与密码ak/sk
        # your ak/sk code
        project_id = context.getUserData('projectId', '').strip()
        region = context.getUserData('region', '').strip()
        ak = context.getAccessKey().strip()
        sk = context.getSecretKey().strip()
    
        if not project_id:
            raise Exception("'project_id' not configured")
    
        if not region:
            raise Exception("'region' not configured")
    
        if not ak or not sk:
            ak = context.getUserData('ak', '').strip()
            sk = context.getUserData('sk', '').strip()
            if not ak or not sk:
                raise Exception("ak/sk empty")
    
        logger = context.getLogger()
        logger.info("get incoming scaling activity, %s", event)
    
        credentials = BasicCredentials(ak, sk).with_project_id(project_id)
    
        # 从SMN传入的event中获取ECS虚拟机的实例ID与伸缩组ID信息
        # Get ECS instance ID and scaling group ID from SMN event message
        instance_id, group_id, hook_name = get_event_info(event, logger)
        if not instance_id or not group_id or not hook_name:
            logger.info("no need to perform gracefully shutdown op")
            return
    
        # 将获取到的实例ID进行关机操作
        # Execute soft shutdown given the instance ID
        stop_ecs_instance(credentials, instance_id, logger, region)
        logger.info("finish stop op")
    
        # 等待实例关机等业务后置逻辑的执行
        # Waiting for the workload after the instance shutdown
        time.sleep(5)
    
        # 关机完成后,调用AS的生命周期挂钩回调接口,执行继续操作,避免等待生命周期设置的超时时间
        # After everything is done, start to trigger callback interface for life cycle hook,
        # directly remove the instance rather than waiting for life cycle hook timeout
        execute_hook_callback(credentials, instance_id, group_id, hook_name, logger, region)
        logger.info("finish hook callback op")
    
    
    def get_event_info(event, logger):
        record = event.get("record")[0]
        message = record.get("smn").get("message").replace("\"{", "{").replace("}\"", "}")
        parsed_message = json.loads(message)
        if parsed_message.get("lifecycle_hook_type") is None:
            # 伸缩组对接SMN后,伸缩活动、伸缩组异常,生命周期都会发送消息给生命周期都会发送消息给FunctionGraph
            # 这里只处理由生命周期挂钩终止实例发来的事件,也可以在console上只配置生命周期-终止实例的消息通知
            # After connecting to SMN, the scaling group activity will be sent to FunctionGraph
            # here only deal with the message sent from group_lifecycle_hook
            logger.info("current op is not triggered by life cycle")
            return None, None, None
    
        if parsed_message.get("lifecycle_hook_type") != "INSTANCE_TERMINATING":
            # 本示例展示实例删除前的优雅关机操作,这里的动作需识别为实例删除
            # This example is the showcase of graceful shutdown before instance remove,
            # so here need to identify as INSTANCE_TERMINATING
            logger.info("current op is not instance terminate")
            return None, None, None
    
        return parsed_message.get("scaling_instance").get("instance_id"), parsed_message.get("scaling_group").get("scaling_group_id"), parsed_message.get("lifecycle_hook_name")
    
    
    def stop_ecs_instance(credentials, instance_id, logger, region):
        ecs_client = EcsClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(EcsRegion.value_of(region)) \
            .build()
    
        try:
            logger.info(f"fulfill ECS request with instance_id:{instance_id}")
            request = BatchStopServersRequest()
            list_servers_os_stop = list()
            list_servers_os_stop.append(ServerId(id=instance_id))
            os_stop_body = BatchStopServersOption(servers=list_servers_os_stop, type="SOFT")
            request.body = BatchStopServersRequestBody(os_stop=os_stop_body)
            ecs_client.batch_stop_servers(request)
        except exceptions.ClientRequestException as e:
            logger.error(e.status_code)
            logger.error(e.request_id)
            logger.error(e.error_code)
            logger.error(e.error_msg)
    
    
    def execute_hook_callback(credentials, instance_id, group_id, hook_name, logger, region):
        as_client = AsClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(AsRegion.value_of(region)) \
            .build()
    
        try:
            logger.info(f"fulfill AS request with instance_id:{instance_id},group_id:{group_id},hook_name:{hook_name}")
            request = AttachCallbackInstanceLifeCycleHookRequest()
            request.scaling_group_id = group_id
            request.body = CallbackLifeCycleHookOption(
                lifecycle_action_result="CONTINUE", instance_id=instance_id, lifecycle_hook_name=hook_name)
            as_client.attach_callback_instance_life_cycle_hook(request)
        except exceptions.ClientRequestException as e:
            logger.error(e.status_code)
            logger.error(e.request_id)
            logger.error(e.error_code)
            logger.error(e.error_msg)
    • 内存:选择“128”。
    • 执行超时时间:输入“10”。
    • 函数执行入口:默认“index.handler”,无需修改。
    • 所属应用:默认“default”。
    • 描述:输入“AS优雅关机”。

设置环境变量

进入as_graceful_shutdown函数,在“设置 > 环境变量”页签,配置环境变量,说明如表1所示,完成后单击“保存”。

图1 配置环境变量
表1 环境变量说明

环境变量

说明

region

伸缩组所在的区域

projectId

伸缩组所在的Project ID

ak

AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。如何获取AK请参考获取AK/SK

sk

SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。如何获取SK请参考获取AK/SK

添加依赖包

  1. 制作“huaweicloudsdk_ecs_core_py3.6”与“huaweicloudsdk_as_core_py3.6”依赖包。制作依赖包详细操作请参见配置函数依赖

    函数工作流服务除了支持用户自定义创建依赖包外,平台也提供了现成依赖包供用户使用,下载请参见如下:

  2. 返回函数工作流控制台,在左侧导航栏选择“函数 > 依赖包管理 > 创建依赖包”,分别创建“huaweicloudsdk_ecs_core_py3.6”与“huaweicloudsdk_as_core_py3.6”依赖包。
  3. 填写依赖包信息,输入依赖包信息,完成后单击“确定”。
    • 依赖包名称:输入“huaweicloudsdk_ecs_core_py3.6或者huaweicloudsdk_as_core_py3.6”。
    • 上传方式:选择“上传ZIP文件”。
    • 文件上传:选择需要上传的zip包文件。
    • 运行时语言:选择“Python3.6”。
      图2 创建依赖包
  4. 用户进入as_graceful_shutdown函数详情页,在“代码”页签,单击页面最底部的“添加依赖包”。
  5. 添加“huaweicloudsdk_ecs_core_py3.6”与“huaweicloudsdk_as_core_py3.6”依赖包。

相关文档