honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Added info about refresh interval & max_docs and step execution. Closes #49151. (#56315) (#56554)

This commit is contained in:
debadair 2020-05-11 15:10:57 -07:00 committed by GitHub
parent 7d002bc263
commit 8f2c1cda2e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/ilm/actions/ilm-rollover.asciidoc
View File

@ -49,7 +49,9 @@ Triggers roll over after the specified maximum primary shard index storage size
`max_docs`:: `max_docs`::
(Optional, integer) (Optional, integer)
Triggers roll over after the specified maximum number of documents in the index is reached. Triggers roll over after the specified maximum number of documents is reached.
Documents added since the last refresh are not included in the document count.
The document count does *not* include documents in replica shards.
`max_age`:: `max_age`::
(Optional, <<time-units, time units>>) (Optional, <<time-units, time units>>)

11
docs/reference/ilm/ilm-index-lifecycle.asciidoc
View File

@ -48,6 +48,17 @@ This ensures that policy updates don't put the index into a state where it can n
If changes can be safely applied, {ilm-init} updates the cached phase definition. If changes can be safely applied, {ilm-init} updates the cached phase definition.
If they cannot, phase execution continues using the cached definition. If they cannot, phase execution continues using the cached definition.
{ilm-init} runs periodically, checks to see if an index meets policy criteria,
and executes whatever steps are needed.
To avoid race conditions, {ilm-init} might need to run more than once to execute all of the steps
required to complete an action.
For example, if {ilm-init} determines that an index has met the rollover criteria,
it begins executing the steps required to complete the rollover action.
If it reaches a point where it is not safe to advance to the next step, execution stops.
The next time {ilm-init} runs, {ilm-init} picks up execution where it left off.
This means that even if `indices.lifecycle.poll_interval` is set to 10 minutes and an index meets
the rollover criteria, it could be 20 minutes before the rollover is complete.
[discrete] [discrete]
[[ilm-phase-actions]] [[ilm-phase-actions]]
=== Phase actions === Phase actions

3
docs/reference/indices/rollover-index.asciidoc
View File

@ -140,7 +140,8 @@ Maximum age of the index.
`max_docs`:: `max_docs`::
(Optional, integer) (Optional, integer)
Maximum number of documents in the index. Maximum number of documents in the index.
This number does *not* include documents in replica shards. Documents added since the last refresh are not included in the document count.
The document count does *not* include documents in replica shards.
`max_size`:: `max_size`::
(Optional, <<byte-units, byte units>>) (Optional, <<byte-units, byte units>>)