Skip to content

Commit 725f379

Browse files
authored
Add advice on restoring ILM indices into unmanaged state (#89140) (#89992)
1 parent b1de8c9 commit 725f379

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

docs/reference/settings/ilm-settings.asciidoc

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,42 +23,46 @@ indices. Defaults to `true`.
2323

2424
[[indices-lifecycle-poll-interval]]
2525
`indices.lifecycle.poll_interval`::
26-
(<<dynamic-cluster-setting,Dynamic>>, <<time-units, time unit value>>)
26+
(<<dynamic-cluster-setting,Dynamic>>, <<time-units, time unit value>>)
2727
How often {ilm} checks for indices that meet policy criteria. Defaults to `10m`.
2828

2929
==== Index level settings
3030
These index-level {ilm-init} settings are typically configured through index
3131
templates. For more information, see <<ilm-gs-create-policy>>.
3232

3333
`index.lifecycle.indexing_complete`::
34-
(<<indices-update-settings,Dynamic>>, Boolean)
35-
Indicates whether or not the index has been rolled over.
34+
(<<indices-update-settings,Dynamic>>, Boolean)
35+
Indicates whether or not the index has been rolled over.
3636
Automatically set to `true` when {ilm-init} completes the rollover action.
3737
You can explicitly set it to <<skipping-rollover, skip rollover>>.
3838
Defaults to `false`.
3939

40+
[[index-lifecycle-name]]
4041
`index.lifecycle.name`::
4142
(<<indices-update-settings, Dynamic>>, string)
4243
The name of the policy to use to manage the index. For information about how
4344
{es} applies policy changes, see <<update-lifecycle-policy>>.
45+
If you are restoring an index from snapshot that was previously managed by {ilm},
46+
you can override this setting to null during the restore operation to disable
47+
further management of the index. See also <<index-lifecycle-rollover-alias>>.
4448

4549
[[index-lifecycle-origination-date]]
4650
`index.lifecycle.origination_date`::
47-
(<<indices-update-settings,Dynamic>>, long)
48-
If specified, this is the timestamp used to calculate the index age for its phase transitions.
49-
Use this setting if you create a new index that contains old data and
50-
want to use the original creation date to calculate the index age.
51+
(<<indices-update-settings,Dynamic>>, long)
52+
If specified, this is the timestamp used to calculate the index age for its phase transitions.
53+
Use this setting if you create a new index that contains old data and
54+
want to use the original creation date to calculate the index age.
5155
Specified as a Unix epoch value in milliseconds.
5256

5357
[[index-lifecycle-parse-origination-date]]
5458
`index.lifecycle.parse_origination_date`::
55-
(<<indices-update-settings,Dynamic>>, Boolean)
56-
Set to `true` to parse the origination date from the index name.
57-
This origination date is used to calculate the index age for its phase transitions.
58-
The index name must match the pattern `^.*-{date_format}-\\d+`,
59+
(<<indices-update-settings,Dynamic>>, Boolean)
60+
Set to `true` to parse the origination date from the index name.
61+
This origination date is used to calculate the index age for its phase transitions.
62+
The index name must match the pattern `^.*-{date_format}-\\d+`,
5963
where the `date_format` is `yyyy.MM.dd` and the trailing digits are optional.
60-
An index that was rolled over would normally match the full format,
61-
for example `logs-2016.10.31-000002`).
64+
An index that was rolled over would normally match the full format,
65+
for example `logs-2016.10.31-000002`).
6266
If the index name doesn't match the pattern, index creation fails.
6367

6468
[[index-lifecycle-step-wait-time-threshold]]
@@ -68,9 +72,13 @@ Time to wait for the cluster to resolve allocation issues during an {ilm-init}
6872
<<ilm-shrink,`shrink`>> action. Must be greater than `1h` (1 hour). Defaults to
6973
`12h` (12 hours). See <<ilm-shrink-shard-allocation>>.
7074

75+
[[index-lifecycle-rollover-alias]]
7176
`index.lifecycle.rollover_alias`::
72-
(<<indices-update-settings,Dynamic>>, string)
77+
(<<indices-update-settings,Dynamic>>, string)
7378
The index alias to update when the index rolls over. Specify when using a
7479
policy that contains a rollover action. When the index rolls over, the alias is
7580
updated to reflect that the index is no longer the write index. For more
7681
information about rolling indices, see <<index-rollover, Rollover>>.
82+
If you are restoring an index from snapshot that was previously managed by {ilm},
83+
you can override this setting to null during the restore operation to disable
84+
further management of future indices. See also <<index-lifecycle-name>>.

0 commit comments

Comments
 (0)