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

[DOCS] Split off ILM overview to a separate topic. #51287

Merged
merged 4 commits into from
Jan 28, 2020

Conversation

debadair
Copy link
Contributor

No description provided.

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (:Docs)

* <<overview-index-lifecycle-management, Overview>>
* <<getting-started-index-lifecycle-management, Getting Started with {ilm-init}>>
* <<ilm-policy-definition, Policy phases and actions>>
* <<set-up-lifecycle-policy, Creating policies>>
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not a huge fan of gerund titles. Not a huge deal though.

Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

I left a few comments where I think we could improve, but nothing I would consider blocking. Thanks for putting this together @debadair.

docs/reference/ilm/overview-ilm.asciidoc Outdated Show resolved Hide resolved
docs/reference/ilm/overview-ilm.asciidoc Outdated Show resolved Hide resolved
Comment on lines 18 to 19
Index lifecycle policies are most often used to manage time-series indices.
Time-series indices have a four stage lifecycle:
Copy link
Contributor

Choose a reason for hiding this comment

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

I think I'd frame this as "ILM is often used to manage hot-cold architecture. Hot-warm-cold architectures are common for time series data, such as logging or metrics."

In any case, the second sentence implies that time-series data always has a hot-cold architecture, which isn't necessarily true. I think it also confuses hot-cold architecture with time-series data. Hot-cold architecture is helpful in contexts outside of time-series data.

I'd also note that hot-cold architecture can include up to four stages. For example, you could easily pull out the warm or delete stages.

slower.
* Delete--the index is no longer needed and can safely be deleted.

A lifecycle policy governs how the index transitions through these stages and
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
A lifecycle policy governs how the index transitions through these stages and
You can use a lifecycle policy to govern how an index transitions through these stages and

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tweaked this a bit, but left the focus on the policy driving the transitions and actions.

docs/reference/ilm/overview-ilm.asciidoc Outdated Show resolved Hide resolved
docs/reference/ilm/overview-ilm.asciidoc Outdated Show resolved Hide resolved
@debadair debadair merged commit d5cacd8 into elastic:master Jan 28, 2020
debadair added a commit to debadair/elasticsearch that referenced this pull request Feb 5, 2020
* [DOCS} Split off overview to a separate topic.

* [DOCS] Incorporated feedback from @jrodewig.
debadair added a commit that referenced this pull request Feb 5, 2020
* [DOCS] Align with ILM API docs (#48705)

* [DOCS] Reconciled with Snapshot/Restore reorg

* [DOCS] Split off ILM overview to a separate topic. (#51287)

* [DOCS} Split off overview to a separate topic.

* [DOCS] Incorporated feedback from @jrodewig.

* [DOCS] Edit ILM GS tutorial (#51513)

* [DOCS] Edit ILM GS tutorial

* [DOCS] Incorporated review feedback from @andreidan.

* [DOCS] Removed test link & fixed anchor & title.

* Update docs/reference/ilm/getting-started-ilm.asciidoc

Co-Authored-By: James Rodewig <[email protected]>

* Fixed glossary merge error.

Co-authored-by: James Rodewig <[email protected]>
debadair added a commit to debadair/elasticsearch that referenced this pull request Feb 5, 2020
* [DOCS] Align with ILM API docs (elastic#48705)

* [DOCS] Reconciled with Snapshot/Restore reorg

* [DOCS] Split off ILM overview to a separate topic. (elastic#51287)

* [DOCS} Split off overview to a separate topic.

* [DOCS] Incorporated feedback from @jrodewig.

* [DOCS] Edit ILM GS tutorial (elastic#51513)

* [DOCS] Edit ILM GS tutorial

* [DOCS] Incorporated review feedback from @andreidan.

* [DOCS] Removed test link & fixed anchor & title.

* Update docs/reference/ilm/getting-started-ilm.asciidoc

Co-Authored-By: James Rodewig <[email protected]>

* Fixed glossary merge error.

Co-authored-by: James Rodewig <[email protected]>
debadair added a commit that referenced this pull request Feb 5, 2020
* [DOCS] Align with ILM API docs (#48705)

* [DOCS] Reconciled with Snapshot/Restore reorg

* [DOCS] Split off ILM overview to a separate topic. (#51287)

* [DOCS} Split off overview to a separate topic.

* [DOCS] Incorporated feedback from @jrodewig.

* [DOCS] Edit ILM GS tutorial (#51513)

* [DOCS] Edit ILM GS tutorial

* [DOCS] Incorporated review feedback from @andreidan.

* [DOCS] Removed test link & fixed anchor & title.

* Update docs/reference/ilm/getting-started-ilm.asciidoc

Co-Authored-By: James Rodewig <[email protected]>

* Fixed glossary merge error.

Co-authored-by: James Rodewig <[email protected]>

Co-authored-by: James Rodewig <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants