Auto Scaling:Automatically add and remove ECS instances from an AnalyticDB cluster IP address whitelist

Procedure

This tutorial shows how to use the ACS-ESS-LifeCycleModifyAnalyticDBIPWhitelist public OOS template to add an ECS instance to the IP address whitelist of an AnalyticDB for MySQL cluster during a scale-out event. Perform the following steps:

Step 1: Grant OOS permissions to a RAM role

You must have permissions to execute OOS templates. The ACS-ESS-LifeCycleModifyAnalyticDBIPWhitelist template requires permissions to perform operations on ECS, Auto Scaling, and AnalyticDB for MySQL resources.

1. Log on to the RAM console.

2. Create a policy.

   1. In the left-side navigation pane, choose Permissions > Policies.

   2. On the Policies page, click Create Policy.

   3. On the Create Policy page, click the JSON tab, configure the parameters, and then click OK.

      The following table describes the parameters that are used in this tutorial. Use the default values for other parameters.

      Parameter	Description
      Name	Enter ESSHookPolicyForAnalyticDBWhitelist.
      Policy Document	Enter the following content: { "Version": "1", "Statement": [ { "Action": [ "ecs:DescribeInstances" ], "Resource": "*", "Effect": "Allow" }, { "Action": [ "adb:ModifyDBClusterAccessWhiteList" ], "Resource": "*", "Effect": "Allow" }, { "Action": [ "ess:CompleteLifecycleAction" ], "Resource": "*", "Effect": "Allow" } ] }

3. Attach the policy to the OOSServiceRole RAM role.

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

   2. Find the OOSServiceRole RAM role and click Grant Permission in the Actions column.

      Add the required permissions for the OOSServiceRole RAM role that is assumed by OOS to complete the authorization.

   3. On the Grant Permission page, configure the parameters, and then click OK.

      The following table describes the parameters that are used in this tutorial. Use the default values for other parameters.

      Parameter	Description
      Authorized scope	Select Alibaba Cloud Account.
      Policy	Select the ESSHookPolicyForAnalyticDBWhitelist custom policy.

Step 2: Create and trigger a scale-out lifecycle hook

1. Log on to the Auto Scaling console.

2. In the navigation pane on the left, click Scaling Groups.

3. In the top navigation bar, select a region.

4. Find the scaling group that you want to manage and open its details page in one of the following ways:

   • In the Scaling Group Name/ID column, click the ID of the scaling group.

   • In the Actions column, click Details.

5. Create a lifecycle hook for the scale-out event.

   1. At the top of the page, click the Event and adhesive hook tab.

   2. Click Create Lifecycle Hook.

   3. Configure the lifecycle hook parameters and click OK.

      The following table describes the parameters that are used in this tutorial. Use the default values for other parameters.

      Parameter	Description
      Name	Enter ESSHookForAddAnalyticDBWhitelist.
      Scaling Activity Type	Select Scale-Out.
      Timeout Period	Enter an appropriate timeout period, for example, 300 seconds. Note The timeout period is the time allowed for the custom action to run. Evaluate the time required for the action and set an appropriate timeout to prevent failures.
      Default Execution Policy	Select Continue.
      Send Notification When Lifecycle Hook Takes Effect	Configure the template as follows: Notification Method: Select OOS Template. OOS Template Type: Select Public Templates. Public Template: Select ACS-ESS-LifeCycleModifyAnalyticDBIPWhitelist. Configure the execution parameters for ACS-ESS-LifeCycleModifyAnalyticDBIPWhitelist as follows: dbClusterId: Enter the ID of your AnalyticDB for MySQL cluster. modifyMode: Select Append. This applies to a scale-out event and adds the ECS instance to the IP address whitelist of the AnalyticDB for MySQL cluster. RAM role assumed by OOS: Select OOSServiceRole. In the procedure, the OOSServiceRole RAM role has been granted the permissions to manage ECS, Auto Scaling, and AnalyticDB for PostgreSQL. The OOS service assumes this role to obtain these permissions.

6. Trigger a scale-out event.

   This tutorial uses a manually executed scaling rule as an example, but you can also trigger a scale-out event with a scheduled or event-triggered task.

   Note

   If scaling activities are triggered when you manually execute scaling rules, lifecycle hooks take effect. Lifecycle hooks do not take effect when you manually add or remove ECS instances to or from a scaling group.

   1. Click the Scaling Rules and Event-triggered Tasks tab.

   2. On the Scaling Rules tab, click Create Scaling Rule.

   3. Set the scaling rule properties and click OK.

      The following table describes the parameters that are used in this tutorial. Use the default values for other parameters.

      Parameter	Description
      Rule Name	Enter Add1.
      Rule Type	Select Simple Scaling Rule.
      Operation	Set this to Add 1 Instances.

   4. In the scaling rule list, find the Add1 scaling rule that you created and click Recurrently in the Actions column.

   5. Click OK.

   After the scaling rule is executed, one ECS instance is automatically created. Because the ESSHookForAddAnalyticDBWhitelist lifecycle hook is created in the scaling group, the instance enters a wait state. OOS is then notified to run the operations defined in the ACS-ESS-LifeCycleModifyAnalyticDBIPWhitelist template.

Step 3: Check the AnalyticDB for MySQL whitelist

1. Log on to the AnalyticDB for MySQL console.

2. In the navigation pane on the left, click Clusters.

3. Find the target cluster and click its ID in the Cluster ID/Description column.

4. In the navigation pane on the left, click Data Security.

   • If the private IP address of the new ECS instance appears in the IP address whitelist of the AnalyticDB for MySQL cluster, the ACS-ESS-LifeCycleModifyAnalyticDBIPWhitelist public template is working correctly.

   • If an ECS instance is created but its private IP address does not appear in the IP address whitelist, check the task's execution status in the OOS console. For more information, see (Optional) Step 4: View OOS execution details.

(Optional) Step 4: View OOS execution details

1. Log on to the OOS console.

2. In the left-side navigation pane, choose Automated Task > Task Execution Management.

3. Find the execution task by time and click Details in the Actions column.

4. On the execution details page, view the execution information.

   For example, you can view the execution ID and status in the Basic Information section. You can also click a task node in the Execution Result section to view its details. For more information, see View the details of an execution.

   Note

   If the execution fails, a corresponding error message is displayed on the execution details page.

FAQ