You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: manage-data/lifecycle/index-lifecycle-management/index-lifecycle.md
+77-38Lines changed: 77 additions & 38 deletions
Original file line number
Diff line number
Diff line change
@@ -8,16 +8,14 @@ products:
8
8
- id: elasticsearch
9
9
---
10
10
11
-
12
-
13
11
# Index lifecycle [ilm-index-lifecycle]
14
12
15
13
16
-
[{{ilm-init}}](../index-lifecycle-management.md) defines five index lifecycle *phases*:
14
+
[{{ilm-cap}}](../index-lifecycle-management.md) ({{ilm-init}}) defines five index lifecycle *phases*:
17
15
18
16
***Hot**: The index is actively being updated and queried.
19
-
***Warm**: The index is no longer being updated but is still being queried.
20
-
***Cold**: The index is no longer being updated and is queried infrequently. The information still needs to be searchable, but it’s okay if those queries are slower.
17
+
***Warm**: The index is updated infrequently or not at all, but is still being queried.
18
+
***Cold**: The index is updated infrequently or not at all, and is also queried infrequently. The information still needs to be searchable, but it’s okay if those queries are slower.
21
19
***Frozen**: The index is no longer being updated and is queried rarely. The information still needs to be searchable, but it’s okay if those queries are extremely slow.
22
20
***Delete**: The index is no longer needed and can safely be removed.
23
21
@@ -56,46 +54,87 @@ When an index enters a phase, {{ilm-init}} caches the phase definition in the in
56
54
57
55
## Phase actions [ilm-phase-actions]
58
56
59
-
{{ilm-init}} supports the following actions in each phase. {{ilm-init}} executes the actions in the order listed.
57
+
{{ilm-init}} supports the following actions in each phase. The order in which actions are performed varies for different lifecycle phase. Refer to the [Phases and available actions](#phases-availability) table for a summary of the phases for which each action is available.
58
+
59
+
### Hot phase
60
+
61
+
The following actions are available in the `hot` lifecycle phase. Actions are performed in the order listed.
62
+
63
+
| Action | Description |
64
+
| --- | --- |
65
+
|[Set priority](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-set-priority.md)| Sets the priority level of the index, which determines the order in which indices are recovered following a node restart. |
66
+
|[Unfollow](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-unfollow.md)| Converts a [{{ccr-init}}](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-ccr) follower index into a regular index, enabling the shrink, rollover, and searchable snapshot actions to be performed safely on follower indices. |
67
+
|[Rollover](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-rollover.md)| Rolls over a target to a new index when the existing index satisfies the specified rollover conditions. |
68
+
|[Read-only](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-readonly.md)| Makes the index data read-only, disabling data write operations against it. |
69
+
|[Downsample](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-downsample.md)| Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. |
70
+
|[Shrink](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-shrink.md)| Blocks write operations on a source index and shrinks it into a new index with fewer primary shards. |
71
+
|[Force merge](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-forcemerge.md)| Reduces the number of segments in each shard by merging some of them together. |
72
+
|[Searchable snapshot](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-searchable-snapshot.md)| Takes a snapshot of the managed index in the configured repository and mounts it as a [searchable snapshot](/deploy-manage/tools/snapshot-and-restore/searchable-snapshots.md). |
73
+
74
+
### Warm phase
75
+
76
+
The following actions are available in the `warm` lifecycle phase. Actions are performed in the order listed.
77
+
78
+
| Action | Description |
79
+
| --- | --- |
80
+
|[Set priority](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-set-priority.md)| Sets the priority level of the index, which determines the order in which indices are recovered following a node restart. |
81
+
|[Unfollow](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-unfollow.md)| Converts a [{{ccr-init}}](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-ccr) follower index into a regular index, enabling the shrink, rollover, and searchable snapshot actions to be performed safely on follower indices. |
82
+
|[Read-only](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-readonly.md)| Makes the index data read-only, disabling data write operations against it. |
83
+
|[Downsample](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-downsample.md)| Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count`, and `avg`) for each metric field grouped by a configured time interval. |
84
+
|[Allocate](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-allocate.md)| Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas. |
85
+
|[Migrate](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-migrate.md)| Moves the index to the [data tier](/manage-data/lifecycle/data-tiers.md) that corresponds to the current phase by updating the `index.routing.allocation.include._tier_preference` index setting. |
86
+
|[Shrink](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-shrink.md)| Blocks writes on a source index and shrinks it into a new index with fewer primary shards. |
87
+
|[Force merge](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-forcemerge.md)| Reduces the number of segments in each shard by merging some of them together. |
88
+
89
+
### Cold phase
90
+
91
+
The following actions are available in the `cold` lifecycle phase. Actions are performed in the order listed.
92
+
93
+
| Action | Description |
94
+
| --- | --- |
95
+
|[Set priority](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-set-priority.md)| Sets the priority level of the index, which determines the order in which indices are recovered following a node restart. |
96
+
|[Unfollow](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-unfollow.md)| Converts a [{{ccr-init}}](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-ccr) follower index into a regular index, enabling the shrink, rollover, and searchable snapshot actions to be performed safely on follower indices. |
97
+
|[Read-only](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-readonly.md)| Makes the index data read-only, disabling data write operations against it. |
98
+
|[Downsample](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-downsample.md)| Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval. |
99
+
|[Searchable snapshot](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-searchable-snapshot.md)| Takes a snapshot of the managed index in the configured repository and mounts it as a [searchable snapshot](/deploy-manage/tools/snapshot-and-restore/searchable-snapshots.md). |
100
+
|[Allocate](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-allocate.md)| Updates the index settings to change which nodes are allowed to host the index shards and change the number of replicas. |
101
+
|[Migrate](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-migrate.md)| Moves the index to the [data tier](/manage-data/lifecycle/data-tiers.md) that corresponds to the current phase by updating the `index.routing.allocation.include._tier_preference` index setting. |
102
+
103
+
### Frozen phase
60
104
61
-
* Hot
105
+
The following actions are available in the `frozen` lifecycle phase. Actions are performed in the order listed.
|[Unfollow](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-unfollow.md)| Converts a [{{ccr-init}}](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-ccr) follower index into a regular index, enabling the shrink, rollover, and searchable snapshot actions to be performed safely on follower indices. |
110
+
|[Searchable snapshot](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-searchable-snapshot.md)| Takes a snapshot of the managed index in the configured repository and mounts it as a [searchable snapshot](/deploy-manage/tools/snapshot-and-restore/searchable-snapshots.md). |
The following actions are available in the `delete` lifecycle phase. Actions are performed in the order listed.
82
115
83
-
* Cold
116
+
| Action | Description |
117
+
| --- | --- |
118
+
|[Wait for snapshot](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-wait-for-snapshot.md)| Waits for the specified snapshot lifecycle management (SLM) policy to be executed before removing the index, ensuring that a snapshot of the deleted index is available. |
119
+
|[Delete](elasticsearch://reference/elasticsearch/index-lifecycle-actions/ilm-delete.md)| Permanently removes the index. |
0 commit comments