All Products
Search

This Product

    Elasticsearch:Use a scenario-based template to modify the configurations of a cluster

    Document Center

    Elasticsearch:Use a scenario-based template to modify the configurations of a cluster

    Last Updated:Jan 16, 2024

    Alibaba Cloud Elasticsearch provides the scenario-based configuration feature. This feature allows you to use the scenario-based templates that are provided by Alibaba Cloud Elasticsearch to modify the configurations of your Alibaba Cloud Elasticsearch cluster. These templates help you achieve optimal cluster and index configurations and avoid cluster exceptions and performance issues that are caused by incorrect configurations. Before you use the templates, you must specify a scenario. General, data analysis, database acceleration, and search scenarios are supported. This topic describes how to use a scenario-based template to modify the configurations of a cluster.

    Background information

    Before you use a scenario-based template to modify the configurations of a cluster, take note of the following items:

    • Different versions and types of clusters support different templates. You can view the supported templates in the console.

    • The default index template is named aliyun_default_index_template. This template has a low order value and does not affect your custom index templates.

    • The policy defined in the default index lifecycle template is named aliyun_default_ilm_policy. This policy has been applied to the default index template aliyun_default_index_template.

    • When you purchase a cluster, you can select a scenario on the buy page. The default scenario for a Standard Edition cluster is General and that for a Kernel-enhanced Edition cluster is Logging. After a cluster is purchased, the system automatically applies the configurations in related templates to the cluster.

      Note

      If Scenario is None, you can configure it based on the following steps. If you set Scenario to a value other than None, you must submit the related templates before they can be applied to the cluster.

    • The operation of using a scenario-based template to modify the configurations of a cluster does not trigger a cluster restart. Therefore, this operation does not affect the status of the cluster and indexes in the cluster. This operation is equivalent to running the PUT _template/aliyun_default_index_template command.

    Procedure

    1. Log on to the Alibaba Cloud Elasticsearch console.
    2. In the left-side navigation pane, click Elasticsearch Clusters.
    3. Navigate to the desired cluster.
      1. In the top navigation bar, select the resource group to which the cluster belongs and the region where the cluster resides.
      2. On the Elasticsearch Clusters page, find the cluster and click its ID.

    4. In the left-side navigation pane of the page that appears, click Cluster Configuration.

    5. In the Scenario-based Configuration section, click Modify on the right side of Scenario.

      修改场景化模板

    6. In the Select Scenario dialog box, select a scenario from the Scenario drop-down list and click OK.

      Note

      Modifications in the Scenario-based Configuration section immediately take effect. You do not need to restart your cluster.

    7. Use scenario-based templates to modify the configurations of your cluster.

      修改场景配置

      • Dynamic Cluster Configuration: allows you to dynamically modify cluster configurations. Dynamic Cluster Configuration functions the same as the PUT /_cluster/settings command. For more information, see Cluster update settings.

      • Index Template Configuration: defines the template that is automatically used only when an index is created. Index Template Configuration functions the same as the PUT _template/aliyun_default_index_template command. The modifications of the index template do not affect existing indexes. For more information, see Index Templates.

      • Index Lifecycle Configuration: supports clusters of V6.7.0 or later. Index Lifecycle Configuration functions the same as the PUT _ilm/policy/aliyun_default_ilm_policy command. For more information, see Setting up a new policy.

      The following substeps demonstrate how to modify the configurations in an index template.

      1. Click Index Template Configuration.

      2. In the Index Template Configuration panel, click Apply.

        一键应用模板

        The following features are provided:

        • Apply: applies the configurations in the Template section to the Current Configuration section. Then, you can modify the configurations.

        • Compare: compares the configurations in the Current Configuration section with those in the Template section. If no modifications are made, this feature is unavailable. During the comparison, you cannot modify the configurations.

        • Reset: restores the configurations in the Current Configuration section to the original values.

      3. In the Current Configuration section, modify the configurations based on your business requirements.

      4. Click Compare.

        查看对比

      5. Click Cancel.

    8. Click Submit.

      After you click Submit, the modifications immediately take effect on your cluster.