Skip to content

Conversation

kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Jun 24, 2025

This PR takes a chunk out of internal issue Requested fixes for data lifecycle docs that was initiated by a review of the ILM docs by our Support team.

It updates the "Configure a lifecycle policy" page to:

  • Add Kibana steps where we currently show only the API steps.
    • In particular, when creating an index template users aren't always sure what to specify on the "Index settings" tab, so this adds an example config.
  • Add a page overview
  • Add a section about viewing the ILM status for an index or datastream
  • Fix up smaller items, such as:
    • Explicitly call out the Kibana "Data retention" option.
    • Emphasize that lifecycle phase changes are based on time since rollover rather than index creation time
    • Warn about updating the logs@lifecycle and metrics@lifecycle policies since they affect a LOT of indices.
  • Provide links for things like the index lifecycle actions, mappings, etc., to help people understand these options.

Please see preview pages:

(For reference, here's the original version of the first page).

ES Data Management team, if any of you can please give this a technical review I'd be very grateful! 🙏 The API instructions aren't changed, with the exception that I added this section about calling the ILM explain API. The Kibana steps are all new.

@kilfoyle kilfoyle changed the title 1572/ilm create template Expand "Configure a lifecycle policy" docs Jun 24, 2025
@kilfoyle kilfoyle marked this pull request as ready for review June 24, 2025 17:38
@kilfoyle kilfoyle requested a review from a team as a code owner June 24, 2025 17:38
@kilfoyle kilfoyle requested a review from a team June 24, 2025 17:39
Copy link
Contributor

@samxbr samxbr left a comment

Choose a reason for hiding this comment

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

Thanks for making this documentation change, I love the new Kibana steps! I just left a few comments.

Copy link
Contributor

@gmarouli gmarouli left a comment

Choose a reason for hiding this comment

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

@kilfoyle thank you for doing this, how nice to see it getting some love ❤️ .

I found some spots that might be misleading or incorrect, let me know if you want to go over through some of them offline as well, if that helps.

@kilfoyle
Copy link
Contributor Author

@gmarouli and @samxbr Thanks so much for the careful review. 🙏

If you don't mind I'd love if you can take a second look. And do let me know if you don't think the new structure makes sense (I tried to explain the rationale in this comment).

kilfoyle and others added 21 commits July 21, 2025 11:24
@kilfoyle
Copy link
Contributor Author

Thanks a lot @yetanothertw for the excellent feedback!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants