Skip to content

Adds instructions for installing other 9.x versions #2426

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 11 commits into from
Aug 12, 2025

Conversation

yetanothertw
Copy link
Contributor

@yetanothertw yetanothertw commented Aug 5, 2025

In case someone needs to install an older version of the Elasticsearch 9.x series, I'm adding tabs to every installation-related command to add instructions for earlier versions.

I've added two tabs for each command (where applicable):

  • Latest
  • Specific version

The Specific version tab explains that users can replace the <specific.version> placeholder with the version that they want when they use the code samples.

I've also grouped the tabs on pages where more than one tab was added in order to keep them in sync. That includes the tabs that are added as snippets, such as .../deploy-manage/deploy/self-managed/_snippets/wolfi.md, these get synced as well.

Fixes #2234


image image

In case someone needs to install an older version of the Elasticsearch 9.x series, I'm adding a tip admonition to explain that they can replace the versions in the code examples with the version that they want. I'm using variables so that this guidance isn't hardcoded and doesn't require version bumps in the future.
Fixes #2234
@yetanothertw yetanothertw requested a review from a team as a code owner August 5, 2025 14:36
Copy link
Collaborator

@shainaraskas shainaraskas left a comment

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.

accidentally approved so requesting changes for clarity

shainaraskas

This comment was marked as duplicate.

@yetanothertw yetanothertw marked this pull request as draft August 5, 2025 14:58
@yetanothertw yetanothertw self-assigned this Aug 5, 2025
@eedugon
Copy link
Contributor

eedugon commented Aug 5, 2025

thanks @yetanothertw for moving this forward! I think we need to align all admin-related documents and provide a common approach on this, as it's a very important topic that the older documents didn't consider (because we had 1 doc per version).

About this PR:

The Debian doc we need to include also the specific command to install a different version with apt-get install elasticsearch, not just when downloading the .deb file.

For the RPM doc we need to review if we also suggest 2 methods (download .rpm and using a package manager), and in such case ensure we offer instructions to install older versions also there.

@yetanothertw
Copy link
Contributor Author

@shainaraskas and @eedugon -- I agree with all your comments/suggestions.

Just to give everyone an idea of what the tabs approach can look like, check out Start a single-node cluster in Docker.

Another option is to only add a tip admonition (as a snippet), like on the Install Elasticsearch from archive on Linux or MacOS page.

Which option do you think works better/is more clear (and potentially more future-proof)?

Should we choose only one of the two options: adding a tip or adding tabs, or should we use a hybrid approach, depending on the situation (if so, we should probably define the situation)?

For example, we can add the tip in instructions with only one step, and add the tabs when there's more than one step to install Elasticsearch. We can also revisit this in the future and add tabs everywhere, if we decide adding tips is a quicker win.

After we figure which way we want to go, I'll book some time for Edu and myself to look at the Debian and RPM topics Edu mentioned in this comment.

@shainaraskas
Copy link
Collaborator

@yetanothertw I like the tabs because there are sometimes many steps that need the notice, and in those cases it is cleaner. I'd just go with one approach because for cases where only one step is affected, either way looks fine, and using tabs everywhere is more consistent.

@eedugon
Copy link
Contributor

eedugon commented Aug 6, 2025

++ to tabs: tabs are also better when the actual instructions to install specific version are significantly different than the "latest" instructions

when the instructions are almost exactly the tabs don't add much benefit but they feel clean and consistent.

@yetanothertw
Copy link
Contributor Author

yetanothertw commented Aug 7, 2025

Hi @eedugon and @shainaraskas, I'm adding you both as reviewers, in case I missed something somewhere. This PR has grown a bit 😅

Edu, re your comment about the Debian doc and the RPM doc, I agree that the instructions around apt-get install elasticsearch and the RPM methods (downloading and RPM + using a package manager) need to be improved from the way they currently are -> to use the {{version.stack}} variable and then offer the older versions as well. My suggestion is to open a separate issue for that, as it requires a bit more investigation and information gathering before an improvement can be made -- the scope of the change is different as well.

Many thanks in advance!

@yetanothertw yetanothertw marked this pull request as ready for review August 7, 2025 14:07
@yetanothertw yetanothertw requested a review from eedugon August 7, 2025 14:08
@yetanothertw yetanothertw changed the title Adds a tip that explains how to install other 9.x versions Adds instructions for installing other 9.x versions Aug 7, 2025
@eedugon
Copy link
Contributor

eedugon commented Aug 7, 2025

My suggestion is to open a separate issue for that

@yetanothertw : sounds perfect, feel free to ping me in the new issue, I could handle the YUM and APT pages when I'm back from PTO.

For the latest release installation it's a common practice to not specify the version in the command, just run apt-get install elasticsearch (the current instructions). I'd only add the version in the install specific version tab.

But as mentioned we can do it at a later stage, as we probably want to research a bit and offer to the user the command that shows all available versions from the package repository.

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.

es page comments. this looks really good, but I highlighted a couple of ways we could refine it and make each segment a little more suited to its context

@@ -177,9 +205,23 @@ The `ES_JAVA_OPTS` variable overrides all other JVM options. We do not recommend

Pin your deployments to a specific version of the {{es}} Docker image. For example:
Copy link
Collaborator

Choose a reason for hiding this comment

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

wonder if this step still makes sense

cc: @eedugon

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.

all done! thanks for doing the hard work of future proofing these docs.

general trends (stop me if I already typed this):

  • kibana/elasticsearch version matching
  • customizing downstream steps to reference choices already established higher up in the tutorial

those are more nice to have than critical but would really make this shiny. approving but happy to do another round

shainaraskas

This comment was marked as duplicate.

@shainaraskas
Copy link
Collaborator

shainaraskas commented Aug 8, 2025

not ideal timing, but looks like subs are supported inline as of today (pending a docs-builder release)
https://elastic.slack.com/archives/C07APH4RCDT/p1754646433490329

requires a syntax tweak

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.

nice improvements!

I see a little inconsistency on how you addressed elasticsearch/kib compatibility. I like the version where you state "the versions should be the same" really clearly.

provided a little additional feedback on "same version" decision points and some light copy stuff. :)

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.

🎉 !

@yetanothertw yetanothertw merged commit 84f884a into main Aug 12, 2025
7 checks passed
@yetanothertw yetanothertw deleted the installing-other-stack-versions branch August 12, 2025 09:18
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.

guidance for installing 9.0 stack versions
3 participants