Skip to content

Commit

Permalink
[DOCS] Note index rollover is not automatically monitored (#40464)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig committed Apr 3, 2019
1 parent 9feede7 commit b100f04
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/reference/indices/rollover-index.asciidoc
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit b100f04

Please sign in to comment.