テンプレート名
ACS-ESS-RollingUpdateByRunCommandInScalingGroup
テンプレートの説明
スケーリンググループの Elastic Compute Service (ECS) インスタンスでコマンドを実行してローリングアップデートを実行します。
テンプレートタイプ
自動化
所有者
Alibaba Cloud
入力パラメータ
パラメータ | 説明 | タイプ | 必須 | デフォルト値 | 制限 |
invokeType | 操作タイプ。 | String | はい | ||
scalingGroupId | スケーリンググループ ID。 | String | はい | ||
enterProcess | 実行前に一時停止するスケーリングプロセス。 | List | いいえ | ['ScaleIn', 'ScaleOut', 'HealthCheck', 'AlarmNotification', 'ScheduledAction'] | |
exitProcess | 実行後に再開するスケーリングプロセス。 | List | いいえ | ['ScaleIn', 'ScaleOut', 'HealthCheck', 'AlarmNotification', 'ScheduledAction'] | |
lifecycleState | ライフサイクル状態。 | List | いいえ | InService | |
commandType | コマンドタイプ。 | String | いいえ | RunShellScript | |
invokeScript | アップデートを実行するために使用されるスクリプト。 | String | いいえ | "" | |
rollbackScript | ロールバックを実行するために使用されるスクリプト。 | String | いいえ | "" | |
sourceExecutionId | ロールバックされる CloudOps Orchestration Service (OOS) 実行の ID。 | String | いいえ | "" | |
batchPauseOption | 一時停止ポリシー。 | String | いいえ | Automatic | |
batchNumber | バッチ数。 | Number | いいえ | 5 | |
OOSAssumeRole | OOS によってアシュームされる Resource Access Management (RAM) ロール。 | String | いいえ | "" |
出力パラメータ
パラメータ | 説明 | タイプ |
commandOutputs | List |
テンプレートを実行するために必要なポリシー
{
"Version": "1",
"Statement": [
{
"Action": [
"ess:DescribeScalingInstances",
"ess:EnterStandby",
"ess:ExitStandBy",
"ess:ResumeProcesses",
"ess:SetInstancesProtection",
"ess:SuspendProcesses"
],
"Resource": "*",
"Effect": "Allow"
},
{
"Action": [
"ecs:DescribeInstances",
"ecs:DescribeInvocationResults",
"ecs:DescribeInvocations",
"ecs:RunCommand",
"ecs:TagResources"
],
"Resource": "*",
"Effect": "Allow"
},
{
"Action": [
"oos:ListExecutions"
],
"Resource": "*",
"Effect": "Allow"
}
]
}
参照
ACS-ESS-RollingUpdateByRunCommandInScalingGroup
テンプレートコンテンツ
FormatVersion: OOS-2019-06-01
Description:
en: Rolling update ECS instances that in scaling group by run command
zh-cn: 通过执行命令的方式滚动更新伸缩组内的ECS实例
name-en: ACS-ESS-RollingUpdateByRunCommandInScalingGroup
name-zh-cn: 通过执行命令的方式滚动更新伸缩组内的ECS实例
categories:
- elastic_manage
Parameters:
invokeType:
Label:
en: InvokeType
zh-cn: 操作タイプ
Type: String
AllowedValues:
- invoke
- rollback
scalingGroupId:
Label:
en: ScalingGroupId
zh-cn: スケーリンググループ ID
Type: String
enterProcess:
Label:
en: EnterProcess
zh-cn: 実行開始前に一時停止するスケーリンググループプロセス
Type: List
Default:
- ScaleIn
- ScaleOut
- HealthCheck
- AlarmNotification
- ScheduledAction
exitProcess:
Label:
en: ExitProcess
zh-cn: 実行終了後に再開するスケーリンググループプロセス
Type: List
Default:
- ScaleIn
- ScaleOut
- HealthCheck
- AlarmNotification
- ScheduledAction
lifecycleState:
Label:
en: LifecycleState
zh-cn: ライフサイクル状態
Description:
en: The lifecycle state of the ECS instance to be upgraded
zh-cn: アップグレード対象の ECS インスタンスのライフサイクル状態
Type: List
AllowedValues:
- InService
- Protected
Default: InService
commandType:
Label:
en: CommandType
zh-cn: コマンドタイプ
Type: String
AllowedValues:
- RunBatScript
- RunPowerShellScript
- RunShellScript
Default: RunShellScript
invokeScript:
Label:
en: InvokeScript
zh-cn: 実行用のスクリプト
Type: String
Default: ''
rollbackScript:
Label:
en: RollbackScript
zh-cn: ロールバック用のスクリプト
Type: String
Default: ''
sourceExecutionId:
Label:
en: SourceExecutionId
zh-cn: ロールバックに使用する OOS 実行 ID
Type: String
Default: ''
batchPauseOption:
Label:
en: BatchPauseOption
zh-cn: バッチモード
Type: String
AllowedValues:
- Automatic
- FirstBatchPause
- EveryBatchPause
Default: Automatic
batchNumber:
Label:
en: BatchNumber
zh-cn: バッチ実行のバッチ数
Type: Number
MinValue: 1
MaxValue: 100
Default: 5
OOSAssumeRole:
Label:
en: OOSAssumeRole
zh-cn: OOS がアシュームする RAM ロール
Type: String
Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
- Name: choiceNextTask
Action: 'ACS::Choice'
Description:
en: Choose next task by invoke type
zh-cn: 実行タイプによって次のタスクを選択します
Properties:
DefaultTask: getInstance
Choices:
- When:
'Fn::Equals':
- rollback
- '{{ invokeType }}'
NextTask: getExecutionInstanceIds
- Name: getInstance
Description:
en: Views the ECS instances
zh-cn: ECS インスタンスを表示します
Action: 'ACS::ExecuteApi'
Properties:
Service: ESS
API: DescribeScalingInstances
Parameters:
ScalingGroupId: '{{ scalingGroupId }}'
LifecycleStates: '{{ lifecycleState }}'
CreationTypes:
- AutoCreated
- Attached
Outputs:
instanceIds:
Type: List
ValueSelector: 'ScalingInstances.ScalingInstance | map({"InstanceId": (.InstanceId), "LifecycleState": (.LifecycleState)})[]'
- Name: whetherTheScalingGroupInstanceIsEmpty
Action: 'ACS::Choice'
Description:
en: Check whether the instances in the services in the scaling group are empty
zh-cn: スケーリンググループ内のサービスのインスタンスが空かどうかを確認します
Properties:
DefaultTask: whetherTosuspendProcess
Choices:
- When:
'Fn::Equals':
- [ ]
- '{{ getInstance.instanceIds }}'
NextTask: 'ACS::END'
- Name: whetherTosuspendProcess
Action: 'ACS::Choice'
Description:
en: Choose next task by process
zh-cn: プロセスによって次のタスクを選択します
Properties:
DefaultTask: suspendProcess
Choices:
- When:
'Fn::Equals':
- []
- '{{ enterProcess }}'
NextTask: invokeByRunCommand
- Name: suspendProcess
Action: 'ACS::ExecuteAPI'
Description:
en: Suspend process
zh-cn: プロセスを一時停止します
Properties:
Service: ESS
API: SuspendProcesses
Parameters:
ScalingGroupId: '{{ scalingGroupId }}'
Process: '{{ enterProcess }}'
- Name: invokeByRunCommand
Action: 'ACS::ESS::RunCommand'
Description:
en: Execute cloud assistant command
zh-cn: クラウドアシスタントコマンドを実行します
Properties:
commandContent: '{{ invokeScript }}'
instanceId:
Fn::Select:
- 'InstanceId'
- '{{ ACS::TaskLoopItem }}'
lifecycleState:
Fn::Select:
- 'LifecycleState'
- '{{ ACS::TaskLoopItem }}'
commandType: '{{ commandType }}'
scalingGroupId: '{{ scalingGroupId }}'
Loop:
Items: '{{ getInstance.instanceIds }}'
BatchPauseOption: '{{ batchPauseOption }}'
Concurrency:
'Fn::CalculateBatch':
- '{{ batchNumber }}'
- '{{ getInstance.instanceIds }}'
Outputs:
commandOutputs:
AggregateType: 'Fn::ListJoin'
AggregateField: commandOutput
Outputs:
commandOutput:
Type: String
ValueSelector: invocationOutput
- Name: tagInstance
Action: ACS::ExecuteApi
Description:
en: Creates and attaches tag to ECS instance
zh-cn: ECS インスタンスにタグを作成してアタッチします
Properties:
Service: ECS
API: TagResources
Parameters:
ResourceIds:
- Fn::Select:
- 'InstanceId'
- '{{ ACS::TaskLoopItem }}'
ResourceType: Instance
Tags:
- Key: 'ess:rollingupdate'
Value: 'oos:{{ ACS::ExecutionId }}'
Loop:
Items: '{{ getInstance.instanceIds }}'
Mode: Concurrency
MaxErrors: 0
Concurrency: 10
- Name: whetherToResumeProcesses
Action: 'ACS::Choice'
Description:
en: Choose next task by process
zh-cn: プロセスによって次のタスクを選択します
Properties:
DefaultTask: resumeProcesses
Choices:
- When:
'Fn::Equals':
- []
- '{{ exitProcess }}'
NextTask: 'ACS::END'
- Name: resumeProcesses
Action: 'ACS::ExecuteAPI'
OnSuccess: 'ACS::END'
Description:
en: Resume process
zh-cn: プロセスを再開します
Properties:
Service: ESS
API: ResumeProcesses
Parameters:
ScalingGroupId: '{{ scalingGroupId }}'
Process: '{{ exitProcess }}'
- Name: getExecutionInstanceIds
Action: 'ACS::ExecuteAPI'
Description:
en: Get the instance that has been executed
zh-cn: 実行されたインスタンスを取得します
Properties:
Service: OOS
API: ListExecutions
Parameters:
ParentExecutionId: '{{ sourceExecutionId }}'
Outputs:
instanceIds:
Type: List
ValueSelector: 'Executions[].Parameters.instanceId'
lifecycleStates:
Type: List
ValueSelector: '.Executions | map({"InstanceId": (.Parameters.instanceId), "LifecycleState": (.Parameters.lifecycleState)})[]'
- Name: getExistInstanceIds
Description:
en: Views the ECS instances
zh-cn: ECS インスタンスを表示します
Action: ACS::SelectTargets
Properties:
ResourceType: ALIYUN::ECS::Instance
Filters:
- Type: ResourceIds
ResourceIds: '{{ getExecutionInstanceIds.instanceIds }}'
Outputs:
instanceIds:
Type: List
ValueSelector: Instances.Instance[].InstanceId
- Name: getRollbackProcess
Action: 'ACS::ExecuteAPI'
Description:
en: Views resource parameters
zh-cn: リソースパラメータを表示します
Properties:
Service: OOS
API: ListExecutions
Parameters:
ExecutionId: '{{ sourceExecutionId }}'
Outputs:
enterProcess:
Type: List
ValueSelector: 'Executions[].Parameters.enterProcess[]'
exitProcess:
Type: List
ValueSelector: 'Executions[].Parameters.exitProcess[]'
- Name: suspendProcessWithRollBack
Action: 'ACS::ExecuteAPI'
Description:
en: Suspend process
zh-cn: プロセスを一時停止します
Properties:
Service: ESS
API: SuspendProcesses
Parameters:
ScalingGroupId: '{{ scalingGroupId }}'
Process: '{{ getRollbackProcess.enterProcess }}'
- Name: rollbackByRunCommand
Action: 'ACS::ESS::RunCommand'
Description:
en: Execute cloud assistant command
zh-cn: クラウドアシスタントコマンドを実行します
Properties:
commandContent: '{{ rollbackScript }}'
instanceId: '{{ ACS::TaskLoopItem }}'
lifecycleState:
Fn::Jq:
- First
- '.[] | select(.InstanceId == "{{ ACS::TaskLoopItem }}") | .LifecycleState'
- '{{ getExecutionInstanceIds.lifecycleStates }}'
commandType: RunShellScript
scalingGroupId: '{{ scalingGroupId }}'
rollBack: 'true'
Loop:
Items: '{{ getExistInstanceIds.instanceIds }}'
BatchPauseOption: '{{ batchPauseOption }}'
Concurrency:
'Fn::CalculateBatch':
- '{{ batchNumber }}'
- '{{ getExistInstanceIds.instanceIds }}'
Outputs:
commandOutputs:
AggregateType: 'Fn::ListJoin'
AggregateField: commandOutput
Outputs:
commandOutput:
Type: String
ValueSelector: invocationOutput
- Name: whetherToResumeProcessesWithRollback
Action: 'ACS::Choice'
Description:
en: Choose next task by process
zh-cn: プロセスによって次のタスクを選択します
Properties:
DefaultTask: resumeProcessesWithRollback
Choices:
- When:
'Fn::Equals':
- []
- '{{ getRollbackProcess.exitProcess }}'
NextTask: 'ACS::END'
- Name: resumeProcessesWithRollback
Action: 'ACS::ExecuteAPI'
Description:
en: Resume process
zh-cn: プロセスを再開します
Properties:
Service: ESS
API: ResumeProcesses
Parameters:
ScalingGroupId: '{{ scalingGroupId }}'
Process: '{{ getRollbackProcess.exitProcess }}'
Outputs:
commandOutputs:
Type: List
Value:
'Fn::If':
- 'Fn::Equals':
- invoke
- '{{ invokeType }}'
- '{{ invokeByRunCommand.commandOutputs }}'
- '{{ rollbackByRunCommand.commandOutputs }}'