Skip to content

Commit

Permalink
[ILM] [DOCS] add general info about steps (#36081)
Browse files Browse the repository at this point in the history
it is important for users to understand that phases
are compiled into Steps that are exposed via the
Explain Lifecycle API.
  • Loading branch information
talevy committed Dec 6, 2018
1 parent 8adec27 commit 4b0900a
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/reference/ilm/policy-definitions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,19 @@ relative to when data was written last to a rolled over index.
The previous phase's actions must complete before {ILM} will check `min_age` and
transition into the next phase.

=== Phase Execution

beta[]

The current phase definition, of an index's policy being executed, is stored
in the index's metadata. The phase and its actions are compiled into a series
of discrete steps that are executed sequentially. Since some {ILM} actions are
more complex and involve multiple operations against an index, each of these
operations are done in isolation in a unit called a "step". The
<<ilm-explain-lifecycle,Explain Lifecycle API>> exposes this information to us
to see which step our index is either to execute next, or is currently
executing.

=== Actions

beta[]
Expand Down

0 comments on commit 4b0900a

Please sign in to comment.