IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Index lifecycle management settings in Elasticsearch
editIndex lifecycle management settings in Elasticsearch
editThese are the settings available for configuring index lifecycle management (ILM).
Cluster level settings
edit-
xpack.ilm.enabled -
(boolean)
Whether ILM is enabled or disabled, setting this to
falsedisables any ILM REST API endpoints and functionality. Defaults totrue. -
indices.lifecycle.history_index_enabled -
(boolean)
Whether ILM’s history index is enabled. If enabled, ILM will record the
history of actions taken as part of ILM policies to the
ilm-history-*indices. Defaults totrue. -
indices.lifecycle.poll_interval -
(Dynamic, time unit value)
How often index lifecycle management checks for indices that meet policy criteria. Defaults to
10m.
Index level settings
editThese index-level ILM settings are typically configured through index templates. For more information, see Create a lifecycle policy.
-
index.lifecycle.name - (Dynamic, string) The name of the policy to use to manage the index.
-
index.lifecycle.rollover_alias - (Dynamic, string) The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more information about rollover, see Configure rollover.
-
index.lifecycle.parse_origination_date -
(Dynamic, boolean)
When configured to
truethe origination date will be parsed from the index name. The index format must match the pattern^.*-{date_format}-\\d+, where thedate_formatisyyyy.MM.ddand the trailing digits are optional (an index that was rolled over would normally match the full format eg.logs-2016.10.31-000002). If the index name doesn’t match the pattern the index creation will fail. -
index.lifecycle.origination_date - (Dynamic, long) The timestamp that will be used to calculate the index age for its phase transitions. This allows the users to create an index containing old data and use the original creation date of the old data to calculate the index age. Must be a long (Unix epoch) value.