Skip to content

Expand guidance on testing an upgrade #3009

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.

Sign up for GitHub

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 3 commits into from
Mar 28, 2025
Merged

Expand guidance on testing an upgrade #3009

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f1233e
Expand guidance on testing an upgrade
DaveCTurner Mar 28, 2025
9772ada
---- is special
DaveCTurner Mar 28, 2025
8531f12
Delimiter pedantry ;)
DaveCTurner Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 32 additions & 5 deletions docs/en/install-upgrade/upgrading-stack.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,42 @@ endif::[]
compatible with {es} version {version}.

. Test the upgrade in an isolated environment before upgrading your production
cluster.
cluster.
+
[IMPORTANT]
--
The upgraded version of {es} may interact with its environment in different
ways from the version you are currently running. It is possible that your
environment behaves incorrectly in a way that does not matter to the version of
{es} that you are currently running, but which does matter to the upgraded
version. In this case, the upgraded version will not work correctly until you
address the incorrect behaviour in your environment.

During your upgrade tests, pay particular attention to the following aspects:

Cluster stability:: Does the new version of {es} form a stable healthy cluster?

Indexing and search performance:: Does the new version of {es} perform the same
(or better) than the current one on your specific workload and data?

Snapshots:: Do all of your snapshot repositories work correctly and pass
{ref}/repo-analysis-api.html[repository analysis]?
Comment on lines +68 to +74
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Cluster stability:: Does the new version of {es} form a stable healthy cluster?
Indexing and search performance:: Does the new version of {es} perform the same
(or better) than the current one on your specific workload and data?
Snapshots:: Do all of your snapshot repositories work correctly and pass
{ref}/repo-analysis-api.html[repository analysis]?
* *Cluster stability*: Does the new version of {es} form a stable healthy cluster?
* *Indexing and search performance*: Does the new version of {es} perform the same
(or better) than the current one on your specific workload and data?
* *Snapshots*: Do all of your snapshot repositories work correctly and pass
{ref}/repo-analysis-api.html[repository analysis]?

Copy link
Contributor

Choose a reason for hiding this comment

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

this might be a workaround to the squishiness

Copy link
Contributor

Choose a reason for hiding this comment

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

alternatively, just add a + to the blank line before "Snapshots" and see if that breaks it up?????

--

. Make sure you have a current snapshot before you start the upgrade.
+
IMPORTANT: You cannot downgrade {es} nodes after upgrading.
If you cannot complete the upgrade process,
you will need to restore from the snapshot.
IMPORTANT: You cannot downgrade {es} nodes after starting to upgrade your
cluster. If you cannot complete the upgrade process, build a new cluster and
restore a snapshot taken before starting the upgrade.

. If you use a separate {ref}/monitoring-production.html[monitoring cluster], you should upgrade the monitoring cluster before the production cluster. In general, the monitoring cluster and the clusters being monitored should be running the same version of the stack. A monitoring cluster cannot monitor production clusters running newer versions of the stack. If necessary, the monitoring cluster can monitor production clusters running the latest release of the previous major version.
. If you use a separate {ref}/monitoring-production.html[monitoring cluster],
upgrade the monitoring cluster before the production cluster.
+
In general, the monitoring cluster and the clusters being monitored should be
running the same version of the stack. A monitoring cluster cannot monitor
production clusters running newer versions of the stack. If necessary, the
monitoring cluster can monitor production clusters running the latest release
of the previous major version.
// end::generic-upgrade-steps[]
////

Expand Down