Skip to content

Commit 46fc073

Browse files
ILM docs: Update 'Skip rollover' (#3320)
This updates the [Skip rollover](https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management/skip-rollover) page to include the UI steps and to provide some guidance about why one would do this. @yetanothertw I tried to do this in a way that preserves the original (advanced) content. Please let me know what you think. Closes: #1564 --------- Co-authored-by: Vlada Chirmicci <[email protected]>
1 parent ac8313b commit 46fc073

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

manage-data/lifecycle/index-lifecycle-management/skip-rollover.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,40 @@ products:
99

1010
# Skip rollover [skipping-rollover]
1111

12-
When `index.lifecycle.indexing_complete` is set to `true`, {{ilm-init}} won’t perform the rollover action on an index, even if it otherwise meets the rollover criteria. It’s set automatically by {{ilm-init}} when the rollover action completes successfully.
12+
You can use {{ilm}} to manage index lifecycle transitions without rolling over your indices. For example, when working with data that isn't continuously ingested, you might prefer to create a new index on a set schedule, such as the first Monday of each month. In this case, you can still use an {{ilm-init}} policy to automatically move indices through [lifecycle phases](/manage-data/lifecycle/index-lifecycle-management/index-lifecycle.md#ilm-phase-transitions) as they age and control when new indices are created by disabling the rollover action.
1313

14-
You can set it manually to skip rollover if you need to make an exception to your normal lifecycle policy and update the alias to force a roll over, but want {{ilm-init}} to continue to manage the index. If you use the rollover API, it is not necessary to configure this setting manually.
14+
You can configure indices to skip rollover either as part of an {{ilm-init}} policy or manually by adjusting the index settings.
15+
16+
17+
## Skip rollover through an {{ilm-init}} policy
18+
19+
When you [configure a lifecycle policy](/manage-data/lifecycle/index-lifecycle-management/configure-lifecycle-policy.md) in {{kib}}, you can choose whether or not rollover is enabled.
20+
21+
To update the automatic rollover setting in an {{ilm-init}} policy:
22+
23+
1. Go to **Stack Management > Index Lifecycle Policies**.
24+
25+
1. Select a policy to update, and from the **Actions** menu select **Edit**.
26+
27+
1. In the **Hot phase** section, expand the advanced settings.
28+
29+
1. Update the **Enable rollover** option to enable or disable automatic rollover.
30+
31+
![Create policy page](/manage-data/images/elasticsearch-reference-create-policy.png "")
32+
33+
34+
## Skip rollover manually
35+
36+
When the [`index.lifecycle.indexing_complete`](elasticsearch://reference/elasticsearch/configuration-reference/index-lifecycle-management-settings.md#_index_level_settings_2) setting is `true`, {{ilm-init}} won’t perform the rollover action on an index, even if it otherwise meets the rollover criteria. This setting is updated to `true` automatically by {{ilm-init}} when the rollover action completes successfully.
37+
38+
You can update this setting manually to skip rollover if, for instance, you need to make an exception to your normal lifecycle policy and update the alias to force a rollover, but you want {{ilm-init}} to continue to manage the index. If you use the rollover API rather than an {{ilm-init}} policy to roll over indices, it is not necessary to configure this setting manually.
1539

1640
If an index’s lifecycle policy is removed, this setting is also removed.
1741

1842
::::{important}
19-
When `index.lifecycle.indexing_complete` is `true`, {{ilm-init}} verifies that the index is no longer the write index for the alias specified by `index.lifecycle.rollover_alias`. If the index is still the write index or the rollover alias is not set, the index is moved to the [`ERROR` step](../../../troubleshoot/elasticsearch/index-lifecycle-management-errors.md).
43+
When `index.lifecycle.indexing_complete` is set to `true`, {{ilm-init}} verifies that the index is no longer the write index for the alias specified by `index.lifecycle.rollover_alias`. If the index is still the write index or the rollover alias is not set, the index is moved to the [`ERROR` step](../../../troubleshoot/elasticsearch/index-lifecycle-management-errors.md).
2044
::::
2145

22-
2346
For example, if you need to change the name of new indices in a series while retaining previously-indexed data in accordance with your configured policy, you can:
2447

2548
1. Create a template for the new index pattern that uses the same policy.

0 commit comments

Comments
 (0)