@@ -23,42 +23,46 @@ indices. Defaults to `true`.
23
23
24
24
[[indices-lifecycle-poll-interval]]
25
25
`indices.lifecycle.poll_interval`::
26
- (<<dynamic-cluster-setting,Dynamic>>, <<time-units, time unit value>>)
26
+ (<<dynamic-cluster-setting,Dynamic>>, <<time-units, time unit value>>)
27
27
How often {ilm} checks for indices that meet policy criteria. Defaults to `10m`.
28
28
29
29
==== Index level settings
30
30
These index-level {ilm-init} settings are typically configured through index
31
31
templates. For more information, see <<ilm-gs-create-policy>>.
32
32
33
33
`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.
36
36
Automatically set to `true` when {ilm-init} completes the rollover action.
37
37
You can explicitly set it to <<skipping-rollover, skip rollover>>.
38
38
Defaults to `false`.
39
39
40
+ [[index-lifecycle-name]]
40
41
`index.lifecycle.name`::
41
42
(<<indices-update-settings, Dynamic>>, string)
42
43
The name of the policy to use to manage the index. For information about how
43
44
{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>>.
44
48
45
49
[[index-lifecycle-origination-date]]
46
50
`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.
51
55
Specified as a Unix epoch value in milliseconds.
52
56
53
57
[[index-lifecycle-parse-origination-date]]
54
58
`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+`,
59
63
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`).
62
66
If the index name doesn't match the pattern, index creation fails.
63
67
64
68
[[index-lifecycle-step-wait-time-threshold]]
@@ -68,9 +72,13 @@ Time to wait for the cluster to resolve allocation issues during an {ilm-init}
68
72
<<ilm-shrink,`shrink`>> action. Must be greater than `1h` (1 hour). Defaults to
69
73
`12h` (12 hours). See <<ilm-shrink-shard-allocation>>.
70
74
75
+ [[index-lifecycle-rollover-alias]]
71
76
`index.lifecycle.rollover_alias`::
72
- (<<indices-update-settings,Dynamic>>, string)
77
+ (<<indices-update-settings,Dynamic>>, string)
73
78
The index alias to update when the index rolls over. Specify when using a
74
79
policy that contains a rollover action. When the index rolls over, the alias is
75
80
updated to reflect that the index is no longer the write index. For more
76
81
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