Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ILM] [DOCS] add general info about steps #36081

Merged
merged 9 commits into from
Dec 6, 2018
Merged

Conversation

talevy
Copy link
Contributor

@talevy talevy commented Nov 29, 2018

it is important for users to understand that phases
are compiled into Steps that are exposed via the
Explain Lifecycle API.

related to #34937

it is important for users to understand that phases
are compiled into Steps that are exposed via the
Explain Lifecycle API.
@talevy talevy added the WIP label Nov 29, 2018
@talevy talevy requested a review from colings86 December 3, 2018 02:04
@talevy talevy added :Data Management/ILM+SLM Index and Snapshot lifecycle management and removed WIP labels Dec 3, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features

docs/reference/ilm/policy-definitions.asciidoc Outdated Show resolved Hide resolved
docs/reference/ilm/policy-definitions.asciidoc Outdated Show resolved Hide resolved
@talevy talevy requested review from colings86 and gwbrown December 3, 2018 18:53
docs/reference/ilm/policy-definitions.asciidoc Outdated Show resolved Hide resolved
docs/reference/ilm/policy-definitions.asciidoc Outdated Show resolved Hide resolved
in the index's metadata. The phase and its actions are compiled into a series
of discrete steps that are executed. Since some {ILM} actions are more complex
and involve multiple actions against an index, each of these are done in their
own step. This provides better visibility into the execution of the phases. The
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This provides better visibility into the execution of the phases -> I'm not sure about this sentence since this is not actually the reason we have steps (Though it is the reason why we expose steps in the ILM explain API). The reason we split the actions into steps is so we have better control over the execution of the lifecycle and so we know exactly which operations have been executed and which are still to be done.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

another sentence that is unnecessary

@talevy talevy requested a review from colings86 December 4, 2018 21:06
@talevy talevy merged commit e944764 into elastic:master Dec 6, 2018
@talevy talevy deleted the ilm-doc-step branch December 6, 2018 18:41
talevy added a commit that referenced this pull request Dec 6, 2018
it is important for users to understand that phases
are compiled into Steps that are exposed via the
Explain Lifecycle API.
@tomcallahan tomcallahan added the >docs General docs changes label Dec 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/ILM+SLM Index and Snapshot lifecycle management >docs General docs changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants