Skip to content

Commit 410b079

Browse files
authored
[DOCS] Added info about refresh interval & max_docs and step execution. Closes #49151. (#56315)
1 parent 30e7a51 commit 410b079

File tree

3 files changed

+16
-2
lines changed

3 files changed

+16
-2
lines changed

docs/reference/ilm/actions/ilm-rollover.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,9 @@ Triggers roll over after the specified maximum primary shard index storage size
4949

5050
`max_docs`::
5151
(Optional, integer)
52-
Triggers roll over after the specified maximum number of documents in the index is reached.
52+
Triggers roll over after the specified maximum number of documents is reached.
53+
Documents added since the last refresh are not included in the document count.
54+
The document count does *not* include documents in replica shards.
5355

5456
`max_age`::
5557
(Optional, <<time-units, time units>>)

docs/reference/ilm/ilm-index-lifecycle.asciidoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,17 @@ This ensures that policy updates don't put the index into a state where it can n
4848
If changes can be safely applied, {ilm-init} updates the cached phase definition.
4949
If they cannot, phase execution continues using the cached definition.
5050

51+
{ilm-init} runs periodically, checks to see if an index meets policy criteria,
52+
and executes whatever steps are needed.
53+
To avoid race conditions, {ilm-init} might need to run more than once to execute all of the steps
54+
required to complete an action.
55+
For example, if {ilm-init} determines that an index has met the rollover criteria,
56+
it begins executing the steps required to complete the rollover action.
57+
If it reaches a point where it is not safe to advance to the next step, execution stops.
58+
The next time {ilm-init} runs, {ilm-init} picks up execution where it left off.
59+
This means that even if `indices.lifecycle.poll_interval` is set to 10 minutes and an index meets
60+
the rollover criteria, it could be 20 minutes before the rollover is complete.
61+
5162
[discrete]
5263
[[ilm-phase-actions]]
5364
=== Phase actions

docs/reference/indices/rollover-index.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,8 @@ Maximum age of the index.
138138
`max_docs`::
139139
(Optional, integer)
140140
Maximum number of documents in the index.
141-
This number does *not* include documents in replica shards.
141+
Documents added since the last refresh are not included in the document count.
142+
The document count does *not* include documents in replica shards.
142143

143144
`max_size`::
144145
(Optional, <<byte-units, byte units>>)

0 commit comments

Comments
 (0)