Perform a rolling update with Alibaba Cloud CLI

Procedure

Step 1: Create a RAM user and add permissions

1. Log on to the RAM console.

2. Create a RAM user.

   In this example, a RAM user named clitest is created. For more information, see Create a RAM user.

   1. In the left-side navigation pane, choose Identities > Users.

   2. Click Create User.

   3. On the Create User page, specify the user settings and click OK.

      The following table describes the example settings.

      Parameter	Example
      Logon Name	example@sample.com
      Display name	example
      Access Mode	Select Using permanent AccessKey to access. An AccessKey pair is automatically generated for the RAM user, which you can use to access Alibaba Cloud resources by calling API operations or using other development tools.

   4. On the User Information page, click Download CSV File.

      Note

      The AccessKey secret is displayed only when it is created and cannot be retrieved later. Keep your AccessKey secret secure. If an AccessKey pair is lost or compromised, create a new one.

3. Grant permissions to the RAM user to manage resources.

   1. In the left-side navigation pane, choose Identities > Users.

   2. Find the RAM user clitest that you created and click Add Permissions in the Actions column.

   3. On the Add Permissions page, select the required permissions for the rolling update and click OK.

      The following table describes the example settings.

      Parameter	Example
      Resource Range	Retain the default value Account.
      Principal	Retain the default value example@sample.com.
      Policies	Select the following system policies: AliyunECSFullAccess: Grants permissions to manage ECS resources, including ECS instances. AliyunESSFullAccess: Grants permissions to manage Auto Scaling resources, including scaling groups. AliyunOOSFullAccess: Grants permissions to manage CloudOps Orchestration Service (OOS) resources, including executions. AliyunOSSFullAccess: Grants permissions to manage Object Storage Service resources, including buckets.

Step 2: Configure and verify Alibaba Cloud CLI

For more information about the configuration items, see the Configure Alibaba Cloud CLI section in the Alibaba Cloud CLI documentation.

1. Open the command-line tool on your local machine.

2. Configure Alibaba Cloud CLI.

   1. Run the following command to open the configuration file.

      aliyun configure

   2. Enter information such as the AccessKey ID and AccessKey secret as prompted.

      

3. Run the following command to verify your Alibaba Cloud CLI configuration.

   aliyun ecs DescribeRegions

   This command queries the supported regions. If a list of regions is returned, the configuration is correct. The following figure shows a sample output.

Step 3: Perform a rolling update

This step provides sample commands to update the image of ECS instances in a scaling group, run a script on the ECS instances, and install an OOS package on the ECS instances.

1. Enter the Alibaba Cloud CLI command to perform the rolling update.

   For more information about the OOS template parameters that are used in the sample code, see Template parameters.

   • This example updates the image of the ECS instances in the scaling group to Alibaba Cloud Linux 2.1903 LTS 64-bit.

     aliyun oos StartExecution --TemplateName ACS-ESS-RollingUpdateByReplaceSystemDiskInScalingGroup --Parameters "{
             \"invokeType\": \"invoke\",
             \"scalingGroupId\": \"asg-bp18p2yfxow2dloq****\",
             \"scalingConfigurationId\": \"asc-bp1bx8mzur534edp****\",
             \"imageId\": \"aliyun_2_1903_x64_20G_alibase_20200529.vhd\",
             \"sourceImageId\": \"centos_7_8_x64_20G_alibase_20200717.vhd\",
             \"OOSAssumeRole\": \"\",
             \"enterProcess\": [
               \"ScaleIn\",
               \"ScaleOut\",
               \"HealthCheck\",
               \"AlarmNotification\",
               \"ScheduledAction\"
             ],
             \"exitProcess\":  [
               \"ScaleIn\",
               \"ScaleOut\",
               \"HealthCheck\",
               \"AlarmNotification\",
               \"ScheduledAction\"
             ],
             \"batchNumber\": 2,
             \"batchPauseOption\": \"Automatic\"
           }"

   • The following sample command for script execution runs the Shell commands df -h and ifconfig on ECS instances in a scaling group to view the disk and network configuration information of the instances.

     aliyun oos StartExecution --TemplateName ACS-ESS-RollingUpdateByRunCommandInScalingGroup --Parameters "{
             \"invokeType\": \"invoke\",
             \"scalingGroupId\": \"asg-bp18p2yfxow2dloq****\",
             \"commandType\": \"RunShellScript\",
             \"invokeScript\": \"df -h\nifconfig\",
             \"rollbackScript\": \"df -h\nifconfig\",
             \"OOSAssumeRole\": \"\",
             \"exitProcess\": [
               \"ScaleIn\",
               \"ScaleOut\",
               \"HealthCheck\",
               \"AlarmNotification\",
               \"ScheduledAction\"
             ],
             \"enterProcess\": [
               \"ScaleIn\",
               \"ScaleOut\",
               \"HealthCheck\",
               \"AlarmNotification\",
               \"ScheduledAction\"
             ],
             \"batchNumber\": 2,
             \"batchPauseOption\": \"Automatic\"
           }"

   • This example installs the WordPress package that is created in OOS on the ECS instances in the scaling group.

     aliyun oos StartExecution --TemplateName ACS-ESS-RollingUpdateByConfigureOOSPackage --Parameters "{
             \"invokeType\": \"invoke\",
             \"scalingGroupId\": \"asg-bp18p2yfxow2dloq****\",
             \"packageName\": \"wordpress\",
             \"packageVersion\": \"v4\",
             \"action\": \"install\",
             \"OOSAssumeRole\": \"\",
             \"enterProcess\": [
               \"ScaleIn\",
               \"ScaleOut\",
               \"HealthCheck\",
               \"AlarmNotification\",
               \"ScheduledAction\"
             ],
             \"exitProcess\": [
               \"ScaleIn\",
               \"ScaleOut\",
               \"HealthCheck\",
               \"AlarmNotification\",
               \"ScheduledAction\"
             ],
             \"batchNumber\": 2,
             \"batchPauseOption\": \"Automatic\"
           }"

2. View the execution details.

   Running the rolling update command automatically creates an OOS execution. You can use the returned execution ID to view details, such as the result and output. The following example shows how to obtain the execution ID and view the execution details of a script.

   1. Find the execution ID of the rolling update in the returned information.

      The following figure shows a sample execution ID.

   2. Run the following Alibaba Cloud CLI command to view the execution details.

      aliyun oos ListExecutions --ExecutionId exec-40e2e17ef7e04****

      The following figure shows sample execution details.

Rollback: Handle exceptions

If an exception occurs during a rolling update, or if you need to revert to a previous configuration, you can perform a rollback. A rollback restores the original configuration of the ECS instances in the scaling group. This step provides a sample command to roll back a rolling update.

1. Find the execution ID of the rolling update in the returned information.

   The following figure shows a sample execution ID.

2. Enter the Alibaba Cloud CLI command to perform the rollback.

   For more information about the OOS template parameters that are used in the sample code, see Template parameters.

   Note

   When you perform a rollback, OOS automatically filters the ECS instances to be rolled back and suspends and resumes the scaling processes of the scaling group based on the rolling update. This allows you to omit certain parameters.

   • This example rolls back the image of the ECS instances to CentOS 7.8 64-bit.

     aliyun oos StartExecution --TemplateName ACS-ESS-RollingUpdateByReplaceSystemDiskInScalingGroup --Parameters "{
             \"invokeType\": \"rollback\",
             \"scalingGroupId\": \"asg-bp18p2yfxow2dloq****\",
             \"scalingConfigurationId\": \"asc-bp1bx8mzur534edp****\",
             \"sourceImageId\": \"centos_7_8_x64_20G_alibase_20200717.vhd\",
             \"sourceExecutionId\": \"exec-83dba59be77d430****\",
             \"OOSAssumeRole\": \"\",
             \"batchNumber\": 2,
             \"batchPauseOption\": \"Automatic\"
           }"

   • The following example command executes a rollback script on an ECS instance. This example uses the Shell commands df -h and ifconfig. You can replace the script as needed.

     aliyun oos StartExecution --TemplateName ACS-ESS-RollingUpdateByRunCommandInScalingGroup --Parameters "{
             \"invokeType\": \"rollback\",
             \"commandType\": \"RunShellScript\",
             \"rollbackScript\": \"df -h\nifconfig\",
             \"scalingGroupId\": \"asg-bp18p2yfxow2dloq****\",
             \"sourceExecutionId\": \"exec-40e2e17ef7e046****\",
             \"OOSAssumeRole\": \"\",
             \"batchNumber\": 2,
             \"batchPauseOption\": \"Automatic\"
           }"

   • This example rolls back an OOS package installation by installing a previous version of the WordPress package on the ECS instances.

     aliyun oos StartExecution --TemplateName ACS-ESS-RollingUpdateByConfigureOOSPackage --Parameters "{
             \"invokeType\": \"rollback\",
             \"scalingGroupId\": \"asg-bp18p2yfxow2dloq****\",
             \"packageVersion\": \"v3\",
             \"packageName\": \"wordpress\",
             \"sourceExecutionId\": \"exec-f4e61f2f21fe490****\",
             \"OOSAssumeRole\": \"\",
             \"batchNumber\": 2,
             \"batchPauseOption\": \"Automatic\"
           }"

3. View the execution details.

   When you run the CLI command to perform a rollback, an execution is also automatically created in OOS. You can also use the method described in Step 3 to view the details of the execution, such as the result and output.

Template parameters