Skip to content

Commit 4b0900a

Browse files
committed
[ILM] [DOCS] add general info about steps (#36081)
it is important for users to understand that phases are compiled into Steps that are exposed via the Explain Lifecycle API.
1 parent 8adec27 commit 4b0900a

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/reference/ilm/policy-definitions.asciidoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,19 @@ relative to when data was written last to a rolled over index.
7474
The previous phase's actions must complete before {ILM} will check `min_age` and
7575
transition into the next phase.
7676

77+
=== Phase Execution
78+
79+
beta[]
80+
81+
The current phase definition, of an index's policy being executed, is stored
82+
in the index's metadata. The phase and its actions are compiled into a series
83+
of discrete steps that are executed sequentially. Since some {ILM} actions are
84+
more complex and involve multiple operations against an index, each of these
85+
operations are done in isolation in a unit called a "step". The
86+
<<ilm-explain-lifecycle,Explain Lifecycle API>> exposes this information to us
87+
to see which step our index is either to execute next, or is currently
88+
executing.
89+
7790
=== Actions
7891

7992
beta[]

0 commit comments

Comments
 (0)