Skip to content

Remove the Serverless label from ILM docs #1531

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

Merged
merged 8 commits into from
May 30, 2025
Merged

Conversation

yetanothertw
Copy link
Contributor

@yetanothertw yetanothertw commented May 29, 2025

Fixes #1196

Removes the serverless applies_to tag from the ILM section of the Data lifecycle docs.

Preview available here

Fixes #1196

Removes the serverless applies_to tag from the ILM section of the Data lifecycle docs.
@yetanothertw yetanothertw requested a review from a team as a code owner May 29, 2025 10:12
@yetanothertw yetanothertw self-assigned this May 29, 2025
@yetanothertw yetanothertw added the Team:Admin Issues owned by the Admin Docs Team label May 29, 2025
Copy link
Contributor

@eedugon eedugon left a comment

Choose a reason for hiding this comment

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

LGTM!

One small comment, not really related with the scope of this PR.

In the Data Tiers page of Data lifecycle we have the "Serverless" tag, and I'm not sure if we should remove it from there too. Just for your consideration and analysis.

@yetanothertw
Copy link
Contributor Author

Thanks for the review, @eedugon!

To address your comment, I think the Data tiers page applies to both (so both Serverless and Elastic Stack labels apply) judging by this snippet:

You can automate these lifecycle transitions using the data stream lifecycle, or custom index lifecycle management.

Just to doublecheck, @shainaraskas or @kilfoyle , could either of you confirm, please?

Many thanks,
Vlada

@shainaraskas
Copy link
Collaborator

shainaraskas commented May 29, 2025

@yetanothertw @eedugon is correct that data tiers are generally a stack concept only.

data tiers specifically are meant to allow you to configure different hardware for different categories of data (very simplified definition).

as a rule, anything that talks about hardware/sizing centric concepts (nodes, shards, hot spotting all fall into this category) does not apply to serverless. this is because the value prop of serverless is that you don't have to think about hardware or sizing at all.

in stack, technically data stream lifecycle might interact with tiers just by virtue of running on hardware that is set up to use tiers, but it doesn't do a great job of interacting with tiers, especially granular ones. the callout on the tiers page might be a little misleading. but data stream lifecycle doesn't rely on manual configuration of tiers, making DSL serverless-compatible.

this page is probably our most accurate in terms of "what applies to serverless" - when in doubt, you can check there as well. it touches on tiers.

ALL THAT BEING SAID: serverlessshould be removed from the data tiers page. if you want to go the extra mile, the page also deserves a note explaining why you don't have to care about tiers for serverless, similar to this one on the stack settings page. helps people to understand that it's not REMOVED functionality, but instead AUTOMATED in a way that makes cluster management easy.

will take a look at the rest of the pr shortly - sorry for wall of text :)

@shainaraskas
Copy link
Collaborator

similarly, I don't think serverless supports curator. not sure about that one.

Copy link
Collaborator

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

ah I thought I submitted a review but I didn't - these tag removals look good. see my other comments re: data tiers and curator

Adding an admonition to specify that data tiers is automated in Serverless.
Fixes #1196

Removes the serverless applies_to tag from the ILM section of the Data lifecycle docs.
Adding an admonition to specify that data tiers is automated in Serverless.
The admonition change hasn't saved properly in the prev commit so adding it now.
@yetanothertw
Copy link
Contributor Author

Thank you for detailed response @shainaraskas -- I've removed the labels from curator and data tiers.

I want to add the admonition you suggested to make it clear that Serverless manages data tier concepts for you. Does this look right to you: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1531/manage-data/lifecycle/data-tiers

I wasn't sure if I should keep the link to project settings, like in the admonition you referenced, as it doesn't seem relevant.

Removed the admonition and opened issue #1200 to address this concern separately.
@yetanothertw yetanothertw merged commit a842883 into main May 30, 2025
6 checks passed
@yetanothertw yetanothertw deleted the update-labels-ilm branch May 30, 2025 14:47
@yetanothertw
Copy link
Contributor Author

Opened issue #1547 to address the admonition suggestion separately. Thanks all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Admin Issues owned by the Admin Docs Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Issue]: ILM is mistakenly labeled as a serverless feature
3 participants