mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 21:48:39 +00:00
c0156cbb5d
* [DOCS] Align with ILM API docs (#48705) * [DOCS] Reconciled with Snapshot/Restore reorg * [DOCS] Split off ILM overview to a separate topic. (#51287) * [DOCS} Split off overview to a separate topic. * [DOCS] Incorporated feedback from @jrodewig. * [DOCS] Edit ILM GS tutorial (#51513) * [DOCS] Edit ILM GS tutorial * [DOCS] Incorporated review feedback from @andreidan. * [DOCS] Removed test link & fixed anchor & title. * Update docs/reference/ilm/getting-started-ilm.asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Fixed glossary merge error. Co-authored-by: James Rodewig <james.rodewig@elastic.co>
69 lines
2.9 KiB
Plaintext
69 lines
2.9 KiB
Plaintext
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[overview-index-lifecycle-management]]
|
|
== Index lifecycle management overview
|
|
|
|
++++
|
|
<titleabbrev>Overview</titleabbrev>
|
|
++++
|
|
|
|
You can create and apply {ilm-cap} ({ilm-init}) policies to automatically manage your indices
|
|
according to your performance, resiliency, and retention requirements.
|
|
Index lifecycle policies can trigger actions such as:
|
|
|
|
* **Rollover** -
|
|
include::../glossary.asciidoc[tag=rollover-def-short]
|
|
* **Shrink** -
|
|
include::../glossary.asciidoc[tag=shrink-def-short]
|
|
* **Force merge** -
|
|
include::../glossary.asciidoc[tag=force-merge-def-short]
|
|
* **Freeze** -
|
|
include::../glossary.asciidoc[tag=freeze-def-short]
|
|
* **Delete** - Permanently remove an index, including all of its data and metadata.
|
|
|
|
Typically, you associate a lifecycle policy with an index template so it is automatically applied
|
|
to new indices.
|
|
You can also apply a policy manually when you create an index.
|
|
|
|
{ilm-init} simplifies managing indices in hot-warm-cold architectures,
|
|
which are common when you're working with time-series data such as logs and metrics.
|
|
|
|
As an index ages, it moves through four possible phases:
|
|
|
|
* Hot--the index is actively being updated and queried.
|
|
* Warm--the index is no longer being updated, but is still being queried.
|
|
* Cold--the index is no longer being updated and is seldom queried. The
|
|
information still needs to be searchable, but it's okay if those queries are
|
|
slower.
|
|
* Delete--the index is no longer needed and can safely be deleted.
|
|
|
|
A lifecycle policy controls how an index moves between phases and
|
|
what actions to perform during each phase. You can specify:
|
|
|
|
* The maximum size or age at which you want to roll over to a new index.
|
|
* The point at which the index is no longer being updated and the number of
|
|
primary shards can be reduced.
|
|
* When to force a merge to permanently delete documents marked for deletion.
|
|
* The point at which the index can be moved to less performant hardware.
|
|
* The point at which the availability is not as critical and the number of
|
|
replicas can be reduced.
|
|
* When the index can be safely deleted.
|
|
|
|
For example, if you are indexing metrics data from a fleet of ATMs into
|
|
Elasticsearch, you might define a policy that says:
|
|
|
|
. When the index reaches 50GB, roll over to a new index.
|
|
. Move the old index into the warm stage, mark it read only, and shrink it down
|
|
to a single shard.
|
|
. After 7 days, move the index into the cold stage and move it to less expensive
|
|
hardware.
|
|
. Delete the index once the required 30 day retention period is reached.
|
|
|
|
[IMPORTANT]
|
|
===========================
|
|
To use {ilm-init}, all nodes in a cluster must run the same version.
|
|
Although it might be possible to create and apply policies in a mixed-version cluster,
|
|
there is no guarantee they will work as intended.
|
|
Attempting to use a policy that contains actions that aren't
|
|
supported on all nodes in a cluster will cause errors.
|
|
=========================== |