Tair (Redis® OSS-Compatible):Automatically manage ECS instances in a Tair whitelist

Procedure

This tutorial shows how to use the public OOS template ACS-ESS-LifeCycleModifyRedisIPWhitelist to add an ECS instance to a Tair instance whitelist during a scale-out.

Step 1: Grant permissions to the OOS RAM role

Executing the ACS-ESS-LifeCycleModifyRedisIPWhitelist OOS template requires permissions for the involved Elastic Compute Service, Auto Scaling, and Tair (Redis OSS-compatible) resources.

1. Log on to the RAM console.

2. Create a permission policy.

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

   2. Click Create Policy.

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

      The following table describes the parameters. Use the default values for the parameters that are not mentioned.

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

3. Attach the permission policy to the OOSServiceRole RAM role.

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

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

      Grant the required permissions to the OOSServiceRole RAM role that OOS assumes. This completes the authorization.

   3. On the Grant Permission page, configure the authorization scope and permissions, and then click OK.

      The following table describes the parameters. Use the default values for the parameters that are not mentioned.

      Parameter	Description
      Resource Range	Select Account.
      Policies	Attach the custom policy named ESSHookPolicyForRedisWhitelist.

Step 2: Create and trigger a scale-out hook

When creating a lifecycle hook, select OOS Template as the notification method and configure the required parameters. This ensures an ECS instance is automatically added to the Tair instance whitelist when a scale-out is triggered.

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.

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

   2. Click Create Lifecycle Hook.

   3. Configure the lifecycle hook and click OK.

      The following table describes the parameters. Use the default values for the parameters that are not mentioned.

      Parameter	Description
      Name	Enter ESSHookForAddRedisWhitelist.
      Scaling Activity Type	Select Scale-Out.
      Timeout Period	Enter an appropriate timeout period, such as 300 seconds. Note The timeout period is the time available to perform custom actions. If this period is too short, the actions may fail. Evaluate the time required for your custom actions and set an appropriate timeout period.
      Default Execution Policy	Select Continue.
      Send Notification When Lifecycle Hook Takes Effect	Configure the template with the following settings: Notification Method: Select OOS Template. OOS Template Type: Select Public Templates. Public Template: Select ACS-ESS-LifeCycleModifyRedisIPWhitelist. Configure the execution parameters for ACS-ESS-LifeCycleModifyRedisIPWhitelist with the following settings: RedisInstanceId: Enter the ID of your Tair instance. ModifyIPWhitelistMode: Select Append, which corresponds to a scale-out and adds the ECS instance to the Tair instance whitelist. RAM role assumed by OOS: Select OOSServiceRole. In the procedure, permissions to manage ECS, Auto Scaling, and Redis resources have been added to the OOSServiceRole RAM role. The OOS service assumes this role to obtain the required permissions.

6. Trigger a scale-out.

   This tutorial shows how to manually execute a scaling rule to trigger a scale-out. You can also use scheduled tasks or event-triggered tasks to trigger a scale-out.

   Note

   Lifecycle hooks take effect only when a scaling rule triggers a scale-out or scale-in. They do not take effect when you manually add or remove existing ECS instances.

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

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

   3. Set the parameters for the scaling rule and click OK.

      The following table describes the parameters. Use the default values for the parameters that are not mentioned.

      Parameter	Description
      Rule Name	Enter Add1.
      Rule Type	Select Simple Scaling Rule.
      Operation	Set the value to Add 1 instance.

   4. Find the Add1 scaling rule that you created and click Perform in the Actions column.

   5. Click OK.

   After the scaling rule executes, an ECS instance is automatically created. The ESSHookForAddRedisWhitelist lifecycle hook then places the instance on hold and notifies the OOS service to execute the operations defined in the ACS-ESS-LifeCycleModifyRedisIPWhitelist template.

Step 3: View the Tair instance whitelist

1. Log on to the console of Tair (Redis OSS-compatible).

2. In the left-side navigation pane, click Instance List.

3. Find your Tair instance and click its ID in the Instance ID/Name column.

4. In the left-side navigation pane, click Whitelist Settings.

   • If the new ECS instance's private IP address appears on the Tair instance whitelist, the ACS-ESS-LifeCycleModifyRedisIPWhitelist template has executed successfully.

   • If the ECS instance exists but its private IP address is not on the Tair instance whitelist, check the OOS task's execution status in the OOS console. For details, see (Optional) Step 4: Check the OOS execution.

(Optional) Step 4: Check the OOS execution

1. Log on to the OOS console.

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

3. Find the execution by its start 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 a task execution.

   Note

   If an execution fails, the execution details page displays the error message.

FAQ