Upgrade ES | Full restart & update overrode config files#5848
Conversation
|
@stefnestor , in order for the preview of this PR to work, when working from a fork, we now need your profile to be public to verify elastic org membership and then enable automatic previews. You can do that simply by flipping to public here: https://github.com/orgs/elastic/people?query=stefnestor An alternative would be to push directly your local branch to the |
|
Thanks, @eedugon! I was wondering why it wasn't triggering for me to see 🙏 |
🔍 Preview links for changed docs |
Vale Linting ResultsSummary: 1 warning, 2 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/upgrade/deployment-or-cluster/elasticsearch.md | 86 | Elastic.Spelling | 'Becausee' is a possible misspelling. |
💡 Suggestions (2)
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/upgrade/deployment-or-cluster/elasticsearch.md | 85 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI. |
| deploy-manage/upgrade/deployment-or-cluster/elasticsearch.md | 119 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
|
Bump @elastic/admin-docs 🙏 |
There was a problem hiding this comment.
Pull request overview
Updates the self-managed Elasticsearch upgrade documentation to explicitly cover full cluster restart upgrades, reinforce no-downgrade guidance, and add a step reminding users to reconcile config overrides that may drift during upgrades.
Changes:
- Add guidance that cluster upgrades can be done via rolling upgrade (recommended) or full cluster restart, with associated implications.
- Convert the upgrade procedure into a stepper-based runbook and add a new step to merge config overrides (to avoid config drift).
- Add a cross-link from node roles documentation to the data tiers page for tiered data node roles.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| deploy-manage/upgrade/deployment-or-cluster/elasticsearch.md | Reworks the upgrade page into a stepper runbook, adds full-restart option and config-drift guidance, and updates surrounding upgrade caveats. |
| deploy-manage/distributed-architecture/clusters-nodes-shards/node-roles.md | Adds an explicit link from specialized data roles to the data tiers documentation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Stef Nestor <26751266+stefnestor@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
yetanothertw
left a comment
There was a problem hiding this comment.
Sorry for keeping you waiting for so long, Stef!
I've completed the first round of reviews. Please let me know what you think.
Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co> Co-authored-by: Stef Nestor <26751266+stefnestor@users.noreply.github.com>
|
Thanks, @yetanothertw ! 🙇♀️ I think there's just two baby wording/formatting issues remaining that I've induced if you'll kindly advise. 🙏 |
Co-authored-by: Stef Nestor <26751266+stefnestor@users.noreply.github.com> Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co>
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
|
Ready again, @yetanothertw. TIA! 🙏 |
yetanothertw
left a comment
There was a problem hiding this comment.
Left to minor suggestions for some lead-in sentences, but looks good otherwise!
Thank you so much for fixing up this page! 🎉 The stepper makes it look sleek and the additional context makes it so much more cohesive!
|
Re the suggestion to create a troubleshooting page for commonly encountered issues during an upgrade, it'd be a good way to test out the new troubleshooting template. There's also more guidance about writing troubleshooting type of content that complements the template. Btw, I'm not trying to pressure you into creating that content, just sharing these links (as I've found them helpful) in case you want to bookmark them for another time. |
Co-authored-by: Vlada Chirmicci <vlada.chirmicci@elastic.co>
## Summary 👋 Follow-up of #5848 to create separate upgrade troubleshooting page. This assumes but does not breaking rely on errors WIP documenting in - #6534 - #6535 - #6536 - #6537 - elastic/elasticsearch#149765 - elastic/elasticsearch#149768 It will hopefully be less necessary after elastic/kibana#266733 There's various page cross-links/cross-reference between troubleshooting "rolling upgrading Elasticsearch" and the "upgrade assistant" before it, so starting together <details><summary>Non-exhaustive related links</summary> --- - https://support.elastic.co/knowledge/1bbb4cc9 - https://discuss.elastic.co/t/issues-upgrading-elasticsearch-from-8-to-9-due-to-old-7-x-indices-and-restricted-kibana-indices/379133/11 - elastic/kibana#119652 (comment) - https://support.elastic.co/knowledge/3e27188b - https://support.elastic.co/knowledge/56149373 - https://support.elastic.co/knowledge/cb3db1e7 - https://support.elastic.co/knowledge/f3c6ea67 - elastic/elasticsearch#86801 - elastic/kibana#116209 - https://support.elastic.co/knowledge/295e812f - https://support.elastic.co/knowledge/794038f9 - https://support.elastic.co/knowledge/dd79602f - https://support.elastic.co/knowledge/e3d44d38 --- </details> ## Generative AI disclosure 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [ ] Yes - [X] No --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Marci W <333176+marciw@users.noreply.github.com>
Summary
👋 The Elasticsearch upgrade guide used to outline
::::{step} Upgrade the shutdown node's version.I also tried to shift doc to
:::::{stepper}as I saw elsewhere which looked shiny+helpful to be able to link to each step.Generative AI disclosure