Skip to content

Commit f8517a5

Browse files
committed
Clarify that you cannot abort an upgrade (#47342)
We do mention that rolling back an upgrade requires a restore from a snapshot, but it's hidden at the bottom of the "preparing to upgrade" instructions on a different page from the actual upgrade instructions. This commit duplicates the preparatory instructions onto the pages containing the actual upgrade instructions and rewords the point about rollbacks a bit.
1 parent a67ffd2 commit f8517a5

File tree

4 files changed

+45
-21
lines changed

4 files changed

+45
-21
lines changed

docs/reference/upgrade.asciidoc

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -66,21 +66,6 @@ To upgrade directly to {version} from 6.6 or earlier, you must shut down the
6666
cluster, install {version}, and restart. For more information, see
6767
<<restart-upgrade, Full cluster restart upgrade>>.
6868

69-
[float]
70-
== Preparing to upgrade
71-
72-
Before upgrading {es}:
73-
74-
. Check the <<deprecation-logging, deprecation log>> to see if you are using
75-
any deprecated features and update your code accordingly. By default,
76-
deprecation warnings are logged when the log level is set to `WARN`.
77-
. Review the <<breaking-changes,breaking changes>> and make any necessary changes
78-
to your code and configuration for {version}.
79-
. If you use custom plugins, make sure compatible versions are available.
80-
. Test upgrades in a dev environment before upgrading your production cluster.
81-
. <<modules-snapshots,Back up your data!>> You must have a snapshot of your
82-
data to roll back to an earlier version.
83-
8469
--
8570

8671
include::upgrade/rolling_upgrade.asciidoc[]

docs/reference/upgrade/cluster_restart.asciidoc

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@ https://www.elastic.co/guide/en/elastic-stack/6.7/upgrading-elastic-stack.html[u
99
and reindex your old indices or bring up a new {version} cluster and
1010
<<reindex-upgrade-remote, reindex from remote>>.
1111

12-
To perform a full cluster restart upgrade to {version}:
12+
include::preparing_to_upgrade.asciidoc[]
13+
14+
[float]
15+
=== Upgrading your cluster
16+
17+
To perform a full cluster restart upgrade to {version}:
1318

1419
. *Disable shard allocation.*
1520
+
@@ -52,6 +57,11 @@ include::upgrade-node.asciidoc[]
5257
include::set-paths-tip.asciidoc[]
5358
--
5459

60+
If upgrading from a 6.x cluster, you must also
61+
<<modules-discovery-bootstrap-cluster,configure cluster bootstrapping>> by
62+
setting the <<initial_master_nodes,`cluster.initial_master_nodes` setting>> on
63+
the master-eligible nodes.
64+
5565
. *Upgrade any plugins.*
5666
+
5767
Use the `elasticsearch-plugin` script to install the upgraded version of each
@@ -70,10 +80,6 @@ If you have dedicated master nodes, start them first and wait for them to
7080
form a cluster and elect a master before proceeding with your data nodes.
7181
You can check progress by looking at the logs.
7282

73-
If upgrading from a 6.x cluster, you must
74-
<<modules-discovery-bootstrap-cluster,configure cluster bootstrapping>> by
75-
setting the `cluster.initial_master_nodes` setting.
76-
7783
As soon as enough master-eligible nodes have discovered each other, they form a
7884
cluster and elect a master. At that point, you can use
7985
<<cat-health,`_cat/health`>> and <<cat-nodes,`_cat/nodes`>> to monitor nodes
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[float]
2+
=== Preparing to upgrade
3+
4+
It is important to prepare carefully before starting an upgrade. Once you have
5+
started to upgrade your cluster to version {version} you must complete the
6+
upgrade. As soon as the cluster contains nodes of version {version} it may make
7+
changes to its internal state that cannot be reverted. If you cannot complete
8+
the upgrade then you should discard the partially-upgraded cluster, deploy an
9+
empty cluster of the version before the upgrade, and restore its contents from
10+
a snapshot.
11+
12+
Before you start to upgrade your cluster to version {version} you should do the
13+
following.
14+
15+
. Check the <<deprecation-logging, deprecation log>> to see if you are using any
16+
deprecated features and update your code accordingly.
17+
18+
. Review the <<breaking-changes,breaking changes>> and make any necessary
19+
changes to your code and configuration for version {version}.
20+
21+
. If you use any plugins, make sure there is a version of each plugin that is
22+
compatible with {es} version {version}.
23+
24+
. Test the upgrade in an isolated environment before upgrading your production
25+
cluster.
26+
27+
. <<modules-snapshots,Back up your data by taking a snapshot!>>
28+

docs/reference/upgrade/rolling_upgrade.asciidoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,12 @@ Rolling upgrades are supported:
2222
Upgrading directly to {version} from 6.6 or earlier requires a
2323
<<restart-upgrade, full cluster restart>>.
2424

25-
To perform a rolling upgrade from 6.7 to {version}:
25+
include::preparing_to_upgrade.asciidoc[]
26+
27+
[float]
28+
=== Upgrading your cluster
29+
30+
To perform a rolling upgrade to {version}:
2631

2732
. *Disable shard allocation*.
2833
+

0 commit comments

Comments
 (0)