Skip to content

Commit 9db70cb

Browse files
authored
[DOCS] Update snapshot vers compat table to use minor versions (#81885) (#82577)
### Changes * Updates the snapshot version compatibility table to use minor versions rather than major versions. * Adds a index creation version and cluster compatibility table. Updates the index compatibility section to use minor versions. * Moves the tables to separate files. This'll help prevent merge conflicts. * Fixes the heading level for the "Warnings" section. (cherry picked from commit 93bd599)
1 parent fa6897f commit 9db70cb

File tree

3 files changed

+42
-25
lines changed

3 files changed

+42
-25
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
[cols="^,^,^,^"]
3+
|====
4+
| 3+^h| Cluster version
5+
h| Index creation version | 6.8 | 7.0–7.1 | 7.2–{minor-version}
6+
| 5.0–5.6 | {yes-icon} | {no-icon} | {no-icon}
7+
| 6.0–6.7 | {yes-icon} | {yes-icon} | {yes-icon}
8+
| 6.8 | {yes-icon} | {no-icon} | {yes-icon}
9+
| 7.0–7.1 | {no-icon} | {yes-icon} | {yes-icon}
10+
| 7.2–{minor-version} | {no-icon} | {no-icon} | {yes-icon}
11+
|====

docs/reference/snapshot-restore/index.asciidoc

+20-25
Original file line numberDiff line numberDiff line change
@@ -110,16 +110,7 @@ any restored indices must be compatible.
110110
[[snapshot-cluster-compatibility]]
111111
=== Snapshot version compatibility
112112

113-
[cols="6"]
114-
|===
115-
| 5+^h| Cluster version
116-
^h| Snapshot version ^| 2.x ^| 5.x ^| 6.x ^| 7.x ^| 8.x
117-
^| *1.x* -> ^|{yes-icon} ^|{no-icon} ^|{no-icon} ^|{no-icon} ^|{no-icon}
118-
^| *2.x* -> ^|{yes-icon} ^|{yes-icon} ^|{no-icon} ^|{no-icon} ^|{no-icon}
119-
^| *5.x* -> ^|{no-icon} ^|{yes-icon} ^|{yes-icon} ^|{no-icon} ^|{no-icon}
120-
^| *6.x* -> ^|{no-icon} ^|{no-icon} ^|{yes-icon} ^|{yes-icon} ^|{no-icon}
121-
^| *7.x* -> ^|{no-icon} ^|{no-icon} ^|{no-icon} ^|{yes-icon} ^|{yes-icon}
122-
|===
113+
include::snapshot-vers-compat.asciidoc[]
123114

124115
You can't restore a snapshot to an earlier version of {es}. For example, you
125116
can't restore a snapshot taken in 7.6.0 to a cluster running 7.5.0.
@@ -145,30 +136,34 @@ endif::[]
145136
[[snapshot-index-compatibility]]
146137
=== Index compatibility
147138

148-
A cluster is only compatible with indices created in the previous major version
149-
of {es}. Any data stream or index you restore from a snapshot must be compatible
150-
with the current cluster's version. If you try to restore an index created in an
151-
incompatible version, the restore attempt will fail.
139+
Any index you restore from a snapshot must also be compatible with the current
140+
cluster's version. If you try to restore an index created in an incompatible
141+
version, the restore attempt will fail.
152142

153-
A snapshot can contain indices created in a previous major version. For example,
154-
a snapshot of a 6.x cluster can contain an index created in 5.x. If you try to
155-
restore the 5.x index to a 7.x cluster, the restore attempt will fail. Keep this
156-
in mind if you take a snapshot before upgrading a cluster.
143+
include::cluster-index-compat.asciidoc[]
157144

158-
As a workaround, you can first restore the data stream or index to another
159-
cluster running the latest version of {es} that's compatible with both the index
160-
and your current cluster. You can then use
161-
<<reindex-from-remote,reindex-from-remote>> to rebuild the data stream or index
162-
on your current cluster. Reindex from remote is only possible if the index's
163-
<<mapping-source-field,`_source`>> is enabled.
145+
You can't restore an index to an earlier version of {es}. For example, you can't
146+
restore an index created in 7.6.0 to a cluster running 7.5.0.
147+
148+
A compatible snapshot can contain indices created in an incompatible version.
149+
For example, a snapshot of a 6.8 cluster can contain an index created in 5.6. If
150+
you try to restore the 5.6 index to a {minor-version} cluster, the restore
151+
attempt will fail. Keep this in mind if you take a snapshot before upgrading a
152+
cluster.
153+
154+
As a workaround, you can first restore the index to another cluster running the
155+
latest version of {es} that's compatible with both the index and your current
156+
cluster. You can then use <<reindex-from-remote,reindex-from-remote>> to rebuild
157+
the index on your current cluster. Reindex from remote is only possible if the
158+
index's <<mapping-source-field,`_source`>> is enabled.
164159

165160
Reindexing from remote can take significantly longer than restoring a snapshot.
166161
Before you start, test the reindex from remote process with a subset of the data
167162
to estimate your time requirements.
168163

169164
[discrete]
170165
[[snapshot-restore-warnings]]
171-
=== Warnings
166+
== Warnings
172167

173168
[discrete]
174169
[[other-backup-methods]]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
[cols="^,^,^,^"]
3+
|====
4+
| 3+^h| Cluster version
5+
h| Snapshot version | 6.8 | 7.0–7.1 | 7.2–{minor-version}
6+
| 5.0–5.6 | {yes-icon} | {no-icon} | {no-icon}
7+
| 6.0–6.7 | {yes-icon} | {yes-icon} | {yes-icon}
8+
| 6.8 | {yes-icon} | {no-icon} | {yes-icon}
9+
| 7.0–7.1 | {no-icon} | {yes-icon} | {yes-icon}
10+
| 7.2–{minor-version} | {no-icon} | {no-icon} | {yes-icon}
11+
|====

0 commit comments

Comments
 (0)