Configure lifecycle policy

For ILM to manage an index, a valid policy must be specified in the index.lifecycle.name index setting.

To configure a lifecycle policy for rolling indices, you create the policy and add it to the index template.

To use a policy to manage an index that doesn’t roll over, you can specify the policy directly when you create it.

You use the create policy API to define a new lifecycle policy. For example, the following request creates my_policy, a policy that defines a hot and and delete phase. When the index reaches 25GB, it rolls over directly to the delete phase. The index is deleted 30 days after rollover.

PUT _ilm/policy/my_policy
{
  "policy": {
    "phases": {
      "hot": {
        "actions": {
          "rollover": {
            "max_size": "25GB" 
          }
        }
      },
      "delete": {
        "min_age": "30d",
        "actions": {
          "delete": {} 
        }
      }
    }
  }
}

To use a policy that triggers the rollover action, you need to configure the policy in the index template used to create each new index.

In addition to specifying the name of the policy in the index.lifecycle.name setting, you specify a index.lifecycle.rollover_alias for referencing the indices managed by this policy.

PUT _template/my_template
{
  "index_patterns": ["test-*"], 
  "settings": {
    "number_of_shards": 1,
    "number_of_replicas": 1,
    "index.lifecycle.name": "my_policy", 
    "index.lifecycle.rollover_alias": "test-alias" 
  }
}

You need to manually create the first index managed by a policy that uses the rollover action and designate it as the write index. The name of the index must match the pattern defined in the index template and end with a number. This number is incremented to generate the name of indices created by the rollover action.

For example, the following request creates the test-00001 index. Because it matches the index pattern specified in my_template, Elasticsearch automatically applies the settings from that template.

PUT test-000001
{
  "aliases": {
    "test-alias":{
      "is_write_index": true 
    }
  }
}

Now you can start indexing data to the rollover alias specified in the lifecycle policy. With the sample my_policy policy, the rollover action is triggered once the initial index exceeds 25GB. ILM then creates a new index that becomes the write index for the test-alias.

When you create an index directly, you can apply a lifecycle policy by specifying the index.lifecycle.name setting. This causes ILM to immediately start managing the index.

PUT test-index
{
  "settings": {
    "number_of_shards": 1,
    "number_of_replicas": 1,
    "index.lifecycle.name": "my_policy"
  }
}