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

[DOCS] Note index rollover is not automatically monitored (#40464)

This commit is contained in:
James Rodewig 2019-04-03 13:49:20 -04:00
parent 41a2b37a55
commit 050c0ec21e
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,8 +1,14 @@
[[indices-rollover-index]]
== Rollover Index
The rollover index API rolls an alias over to a new index when the existing
index is considered to be too large or too old.
The rollover index API rolls an <<indices-aliases, alias>> to a new index when
the existing index meets a condition you provide. You can use this API to retire
an index that becomes too large or too old.
NOTE: To roll over an index, a condition must be met *when you call the API*.
{es} does not monitor the index after you receive an API response. To
automatically roll over indices when a condition is met, you can use {es}'s
<<index-lifecycle-management, index lifecycle management (ILM) policies>>.
The API accepts a single alias name and a list of `conditions`. The alias must point to a write index for
a Rollover request to be valid. There are two ways this can be achieved, and depending on the configuration, the