Configure index management for templates

If you create a deployment template that includes more than one data configuration, you must also specify how Elastic Cloud Enterprise should manage indices for your users when they create their deployments. For time-series use cases such as logging, metrics, and APM, providing a template that enables index management ensures that data is being stored in the most cost-effective way possible as it ages.

In a template that creates a hot-warm architecture, configuring index management typically means specifying where new indices get created initially and then where they get moved to later on through index curation. If you also configure index lifecycle management (ILM), additional features are available to your users, including the automatic roll-over of index aliases to new indices when existing indices are getting too large or too old, and deleting indices when they are no longer useful.

Before you begin

Configuring index management is part of the larger task of creating deployment templates or editing them. The choices you make here determine which index management methods are available to your users when they create deployments.

You should configure all index management methods that you want your users to be able to choose from when they create their deployments from your template. At a minimum, you must always configure index curation. If you are not sure which index management methods to configure, take a look at how your users are asked to configure index management when they customize their deployments.

Steps

To configure index management when you create a deployment template:

  1. On the Index Management page, configure the index curation methods that you want to be available when your users create deployments:

    Index lifecycle management (Elastic Stack 6.7 and later)

    Uses the ILM feature of the Elastic Stack that provides an integrated and streamlined way to manage time-based data, making it easier to follow best practices for managing your indices. Compared to index curation, ILM gives you more fine-grained control over the lifecycle of each index.

    To configure index lifecycle management:

    1. Specify the node attributes for your data configurations.

      Node attributes are simple key-value pairs, such as node_type: hot, node_type: warm, and node_type: cold. These node attributes add defining metadata attributes to each data configuration in your template that tell your users what they can be used for. What you define here should help guide your users when they set up the the main phases of their index lifecycle management policy in Kibana, such as a hot-warm policy.

      1. Enter values into the Key and Value fields.
      2. Click Add.
      3. Repeat the previous step until you have added all the node attributes that you want to be available to your users when they create an index lifecycle policy later on.
    Index curation

    Creates new indices on hot nodes first and moves them to warm nodes later on, based on the index patterns you specify. Also manages replica counts for you, so that all shards of an index can fit on the right data nodes. Compared to index lifecycle management, index curation for time-based indices supports only one action, to move indices from nodes on one data configuration to another, but it is more straightforward to set up initially and all setup can be done directly from the Cloud UI.

    If your user need to delete indices once they are no longer useful to them, they can run Curator on-premise to manage indices for Elasticsearch clusters hosted on Elastic Cloud Enterprise.

    To configure index curation:

    1. Select the hot data configuration where new indices get created initially.
    2. Select the warm nodes where older indices get moved to later on when they get curated.
    3. Specify which indices get curated by including at least one index pattern.

      By default, the pattern is *, which means that all indices get curated. For logging use cases, you could specify to curate only the logstash-*, metricbeat-*, or filebeat-* index patterns, for example.

    4. Specify the time interval after which indices get curated.
  2. Click Next.

After you have completed these steps, continue with creating your deployment template.