Elasticsearch:modify a scenario-specific configuration template

Scope

This feature applies only to existing v2 architecture clusters.

Important Notes

• Scenario-specific configuration templates vary by instance version and type. Refer to the console for actual configurations. Instances with the Indexing Service enabled support only the log scenario.

• Modifying a scenario-specific template is equivalent to running the PUT _template/aliyun_default_index_template command. This change does not trigger a restart. It does not affect existing indexes or cluster status.

• The system-recommended index template is named aliyun_default_index_template. It has a low order priority and does not override custom templates.

• The system-recommended index lifecycle policy is named aliyun_default_ilm_policy. By default, this policy applies to the aliyun_default_index_template template.

• When purchasing a new instance, select a scenario on the purchase page. Commercial Edition instances default to the general scenario. Kernel-enhanced Edition instances default to the log scenario. After purchase, the corresponding template configuration automatically applies to the cluster. If the Scenario is None, you can enable it manually. After enabling, the template does not apply automatically. You must submit the configuration to apply it.

• ES instance management versions vary. Scenario-specific configurations in the console may differ across instances. If the console does not display scenario-specific configuration options, use the ES API (PUT _template/aliyun_default_index_template) to configure them.

Procedure

1. Log on to the Alibaba Cloud Elasticsearch console.

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

3. Go to the target instance.

   1. In the top menu bar, select a resource group and region.

   2. On the Elasticsearch Clusters page, click the target instance ID.

4. In the left navigation pane, click Cluster Configuration.

5. In the Scenario-based Configuration section, click Modify next to Scenario.

   

6. In the Select Scenario dialog box, select a Scenario, and click OK. Modifying the scenario-specific configuration is a dynamic change. No cluster restart is required.

7. Modify the scenario configuration template.

   

   The scenario configuration template includes three configuration types:

   • Dynamic cluster configuration: Dynamically modify cluster settings. This is equivalent to running the PUT /_cluster/settings command. For more information, see Cluster update settings.

   • Index template configuration: Define a template that automatically applies when creating a new index. Changing the template does not affect existing indexes. This is equivalent to running the PUT _template/aliyun_default_index_template command. For more information, see Index templates.

   • Index lifecycle configuration: Instances of version 6.7.0 or later support enabling the index lifecycle template. This is equivalent to running the PUT _ilm/policy/aliyun_default_ilm_policy command. For more information, see Setting up a new policy.

   The following steps describe modifying the Index Template Configuration. Other configuration types follow the same procedure.

   1. Click Index Template Configuration.

   2. On the Index Template Configuration page, click Apply.

      

      Feature descriptions are as follows:

      • Apply: Apply the recommended template from the right to the current configuration on the left. Modify the current configuration only after applying the template.

      • Compare: View differences between the current configuration and the recommended template. This option is available only after modifying the current configuration. You cannot edit the configuration in comparison mode.

      • Reset: Reset the current configuration to the configuration currently applied to the cluster.

   3. In the Current Configuration section on the left, modify the current template's configuration.

   4. After modifying the configuration, click Compare to see the differences between the modified and recommended template configurations.

      

   5. Click Cancel.

8. Click Submit.

   After submission, the modified configuration applies to the cluster.