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

[DOC+] ILM min_age interpretation #98245

Merged
merged 2 commits into from
Aug 9, 2023
Merged

[DOC+] ILM min_age interpretation #98245

merged 2 commits into from
Aug 9, 2023

Conversation

stefnestor
Copy link
Contributor

👋 hiya, team!

From the time y'all helped me write this ILM Troubleshooting blog in 2021 and @jrodewig later helped me port errors to this doc via #75849, the remaining top-gotcha user's are still encountering in EO2023 is "Common issue 3" that ILM's min_age calculates off rollover time fallback index creation time. (Users consistently expect this to only calculate from creation time.)

This PR cross-pollinates the blog quote into the docs so that Support can link it to users and so it becomes Google-able.

Common issue 3: min_age calculation clarification
When working with customers, I have seen confusion about how min_age works. The min_age must increase between subsequent phases. If rollover is used, min_age is calculated off the rollover date. This is because rollover generates a new index and the new index’s creation date is used in the calculation. Otherwise, min_age is calculated off the original index’s creation date.

👋 hiya, team!

From the time y'all helped me write this [ILM Troubleshooting blog](https://www.elastic.co/blog/troubleshooting-elasticsearch-ilm-common-issues-and-fixes) in 2021 and we later ported errors to [this doc](https://www.elastic.co/guide/en/elasticsearch/reference/master/index-lifecycle-error-handling.html) via #75849, the remaining top-gotcha user's raise is "Common issue 3" that ILM's `min_age` calculates off rollover time fallback index creation time.

This PR cross-pollinates the blog quote into the docs so that Support can link it to users and so it becomes Google-able.

> Common issue 3: min_age calculation clarification
> When working with customers, I have seen confusion about how min_age works. The min_age must increase between subsequent phases. If rollover is used, min_age is calculated off the rollover date. This is because rollover generates a new index and the new index’s creation date is used in the calculation. Otherwise, min_age is calculated off the original index’s creation date.
@stefnestor stefnestor added >enhancement >docs General docs changes :Data Management/ILM+SLM Index and Snapshot lifecycle management Team:Data Management Meta label for data/management team labels Aug 6, 2023
@github-actions
Copy link

github-actions bot commented Aug 6, 2023

Documentation preview:

@elasticsearchmachine
Copy link
Collaborator

@stefnestor please enable the option "Allow edits and access to secrets by maintainers" on your PR. For more information, see the documentation.

@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team external-contributor Pull request authored by a developer outside the Elasticsearch team v8.10.0 labels Aug 6, 2023
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-data-management (Team:Data Management)

Copy link
Contributor

@abdonpijpelink abdonpijpelink left a comment

Choose a reason for hiding this comment

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

I've left some formatting/wording suggestions.

docs/reference/ilm/error-handling.asciidoc Outdated Show resolved Hide resolved
docs/reference/ilm/error-handling.asciidoc Outdated Show resolved Hide resolved
docs/reference/ilm/error-handling.asciidoc Outdated Show resolved Hide resolved
docs/reference/ilm/error-handling.asciidoc Outdated Show resolved Hide resolved
@abdonpijpelink abdonpijpelink added auto-backport-and-merge Automatically create backport pull requests and merge when ready v8.9.1 labels Aug 7, 2023
Copy link
Contributor

@abdonpijpelink abdonpijpelink left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @stefnestor !

@abdonpijpelink abdonpijpelink merged commit 93d36db into main Aug 9, 2023
5 checks passed
@abdonpijpelink abdonpijpelink deleted the stefnestor-patch-3 branch August 9, 2023 14:41
@stefnestor
Copy link
Contributor Author

👋 @abdonpijpelink I see this is live in master but not 8.9 nor current, will you kindly help me backport/fix?

@jrodewig
Copy link
Contributor

I think it's after @abdonpijpelink's working hours. I'll work on backporting this. I think the auto-backport-and-merge label only works for ES team folks. Thanks for catching this, @stefnestor!

@jrodewig
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.9

Questions ?

Please refer to the Backport tool documentation

jrodewig added a commit that referenced this pull request Aug 24, 2023
Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
Co-authored-by: Stef Nestor <26751266+stefnestor@users.noreply.github.com>
fixes) in 2021 and we later ported errors to [this doc](https://www.elastic.co/guide/en/elasticsearch/reference/master/index-lifecycle-error-handling.html) via #75849, the remaining top-gotcha user's raise is "Common issue 3" that ILM's `min_age` calculates off rollover time fallback index creation time.
@jrodewig
Copy link
Contributor

@stefnestor This is live on 8.9 and current now: https://www.elastic.co/guide/en/elasticsearch/reference/8.9/index-lifecycle-error-handling.html#_common_ilm_setting_issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport-and-merge Automatically create backport pull requests and merge when ready :Data Management/ILM+SLM Index and Snapshot lifecycle management >docs General docs changes >enhancement external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v8.9.1 v8.10.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants