All Products
Search
Document Center

CloudOps Orchestration Service:ACS-ESS-LifeCycleAttachNASFileSystemToInstance

Last Updated:Jan 13, 2025

Template name

ACS-ESS-LifeCycleAttachNASFileSystemToInstance

Execute Now

Template description

Uses a lifecycle hook to mount a File Storage NAS (NAS) file system to Elastic Compute Service (ECS) instances. This template supports only scale-out events.

Template type

Automated

Owner

Alibaba Cloud

Input parameters

Parameter

Description

Type

Required

Default value

Limit

mountTargetDomain

The domain name of the mount target.

String

Yes

mountDir

The directory to which the file system is mounted.

String

No

/mnt

fileSystemVersion

The version of the file system.

String

No

0

regionId

The region ID.

String

No

${regionId}

instanceIds

The IDs of the ECS instances.

List

No

['${instanceIds}']

lifecycleHookId

The lifecycle hook ID.

String

No

${lifecycleHookId}

lifecycleActionToken

The token of a specific scaling activity that is associated with the instances.

String

No

${lifecycleActionToken}

rateControl

The rate control settings.

Json

No

{'Mode': 'Concurrency', 'MaxErrors': 0, 'Concurrency': 5}

OOSAssumeRole

The Resource Access Management (RAM) role that is assumed by CloudOps Orchestration Service (OOS).

String

No

OOSServiceRole

Output parameters

None

Policy that is required to execute the template

{
    "Version": "1",
    "Statement": [
        {
            "Action": [
                "ecs:DescribeInstances",
                "ecs:DescribeInvocationResults",
                "ecs:DescribeInvocations",
                "ecs:RunCommand"
            ],
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": [
                "ess:CompleteLifecycleAction"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

References

ACS-ESS-LifeCycleAttachNASFileSystemToInstance

Template content

FormatVersion: OOS-2019-06-01
Description:
  en: Use lifecyclehook to attach NAS file system to instance (only supports elastic expansion activities)
  zh-cn: 使用生命周期挂钩挂载NAS文件系统到实例上(仅支持弹性扩张活动)
  name-en: ACS-ESS-LifeCycleAttachNASFileSystemToInstance
  name-zh-cn: 使用生命周期挂钩挂载NAS文件系统到实例
  categories:
    - elastic_manage
Parameters:
  mountTargetDomain:
    Label:
      en: MountTargetDomain
      zh-cn: 挂载点域名
    Type: String
  mountDir:
    Label:
      en: MountDir
      zh-cn: 挂载目录
    Description:
      en: The dir to mount file systen in instance
      zh-cn: 实例中挂载文件系统的目录
    Type: String
    Default: /mnt
  fileSystemVersion:
    Label:
      en: FileSystemVersion
      zh-cn: 文件系统版本
    Description:
      en: The version of file system.0 means V4, 1 means V3
      zh-cn: 文件系统版本。 0表示V4,1表示V3
    Type: String
    Default: 0
  regionId:
    Label:
      en: RegionId
      zh-cn: 地域ID
    Description:
      en: The ID of region
      zh-cn: '地域ID,请使用弹性伸缩系统默认值 ${regionId}'
    Type: String
    Default: '${regionId}'
  instanceIds:
    Label:
      en: InstanceIds
      zh-cn: ECS实例ID列表
    Description:
      en: The ID list of the ECS instance
      zh-cn: 'ECS实例ID列表,请使用弹性伸缩系统默认值 ["${instanceId}"]'
    Type: List
    Default:
      - '${instanceIds}'
  lifecycleHookId:
    Label:
      en: LifecycleHookId
      zh-cn: 生命周期挂钩ID
    Description:
      en: The ID of the lifecycle hook
      zh-cn: '生命周期挂钩ID,请使用弹性伸缩系统默认值 ${lifecycleHookId}'
    Type: String
    Default: '${lifecycleHookId}'
  lifecycleActionToken:
    Label:
      en: LifecycleActionToken
      zh-cn: 实例关联的特定伸缩活动的令牌
    Description:
      en: The token that indicates a specific scaling activity associated with an instance
      zh-cn: '实例关联的特定伸缩活动的令牌,请使用弹性伸缩系统默认值 ${lifecycleActionToken}'
    Type: String
    Default: '${lifecycleActionToken}'
  rateControl:
    Label:
      en: RateControl
      zh-cn: 速率控制
    Type: Json
    AssociationProperty: RateControl
    Default:
      Mode: Concurrency
      MaxErrors: 0
      Concurrency: 5
  OOSAssumeRole:
    Label:
      en: OOSAssumeRole
      zh-cn: OOS扮演的RAM角色
    Type: String
    Default: OOSServiceRole
RamRole: '{{ OOSAssumeRole }}'
Tasks:
  - Name: attachNASFileSystemToInstance
    Action: 'ACS::ECS::AttachNASFileSystemToInstance'
    OnSuccess: CompleteLifecycleActionForContinue
    OnError: CompleteLifecycleActionForAbandon
    Description:
      en: Attach NAS file ststem to instance
      zh-cn: 挂载NAS文件系统到实例
    Properties:
      regionId: '{{regionId}}'
      instanceId: '{{ ACS::TaskLoopItem }}'
      mountTargetDomain: '{{ mountTargetDomain }}'
      mountDir: '{{ mountDir }}'
      fileSystemVersion: '{{ fileSystemVersion }}'
    Loop:
      RateControl: '{{ rateControl }}'
      Items: '{{ instanceIds }}'
  - Name: CompleteLifecycleActionForContinue
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Modify lifecycle action for continue
      zh-cn: 修改伸缩活动的等待状态为继续完成
    OnSuccess: 'ACS::END'
    Properties:
      Service: ESS
      API: CompleteLifecycleAction
      Parameters:
        RegionId: '{{ regionId }}'
        LifecycleHookId: '{{ lifecycleHookId }}'
        LifecycleActionToken: '{{ lifecycleActionToken }}'
        LifecycleActionResult: CONTINUE
  - Name: CompleteLifecycleActionForAbandon
    Action: 'ACS::ExecuteAPI'
    Description:
      en: Complete lifecycle action for Abandon
      zh-cn: 修改伸缩活动的等待状态为弃用
    Properties:
      Service: ESS
      API: CompleteLifecycleAction
      Parameters:
        RegionId: '{{ regionId }}'
        LifecycleHookId: '{{ lifecycleHookId }}'
        LifecycleActionToken: '{{ lifecycleActionToken }}'
        LifecycleActionResult: ABANDON