Skip to content

[DOCS] Update snapshot vers compat table to use minor versions #81885

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 7 commits into from
Jan 13, 2022
Merged

[DOCS] Update snapshot vers compat table to use minor versions #81885

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
08c7c62
[DOCS] Update snapshot vers compat table to use minor versions
jrodewig Dec 17, 2021
77ff79b
Address review feedback
jrodewig Dec 17, 2021
aa65ee3
Remove data stream refs. For now, all versions with ds are compatible
jrodewig Dec 17, 2021
d309d13
Index version -> index creation version
jrodewig Dec 17, 2021
6c4ce00
Fix article
jrodewig Dec 18, 2021
30500e8
Update tables for restoring 6.8 snapshots on 7.0/7.1 clusters
jrodewig Jan 4, 2022
4684972
Note restored indices are not backward-compatible
jrodewig Jan 11, 2022
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
12 changes: 12 additions & 0 deletions docs/reference/snapshot-restore/cluster-index-compat.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

[cols="^,^,^,^,^"]
|====
| 4+^h| Cluster version
h| Index creation version | 6.8 | 7.0–7.1 | 7.2–{prev-major-last} | 8.0–{minor-version}
| 5.0–5.6 | {yes-icon} | {no-icon} | {no-icon} | {no-icon}
| 6.0–6.7 | {yes-icon} | {yes-icon} | {yes-icon} | {no-icon}
| 6.8 | {yes-icon} | {no-icon} | {yes-icon} | {no-icon}
| 7.0–7.1 | {no-icon} | {yes-icon} | {yes-icon} | {yes-icon}
| 7.2–{prev-major-last} | {no-icon} | {no-icon} | {yes-icon} | {yes-icon}
| 8.0–{minor-version} | {no-icon} | {no-icon} | {no-icon} | {yes-icon}
|====
41 changes: 16 additions & 25 deletions docs/reference/snapshot-restore/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,16 +112,7 @@ any restored indices must be compatible.
[[snapshot-cluster-compatibility]]
=== Snapshot version compatibility

[cols="6"]
|===
| 5+^h| Cluster version
^h| Snapshot version ^| 2.x ^| 5.x ^| 6.x ^| 7.x ^| 8.x
^| *1.x* -> ^|{yes-icon} ^|{no-icon} ^|{no-icon} ^|{no-icon} ^|{no-icon}
^| *2.x* -> ^|{yes-icon} ^|{yes-icon} ^|{no-icon} ^|{no-icon} ^|{no-icon}
^| *5.x* -> ^|{no-icon} ^|{yes-icon} ^|{yes-icon} ^|{no-icon} ^|{no-icon}
^| *6.x* -> ^|{no-icon} ^|{no-icon} ^|{yes-icon} ^|{yes-icon} ^|{no-icon}
^| *7.x* -> ^|{no-icon} ^|{no-icon} ^|{no-icon} ^|{yes-icon} ^|{yes-icon}
|===
include::snapshot-vers-compat.asciidoc[]

You can't restore a snapshot to an earlier version of {es}. For example, you
can't restore a snapshot taken in 7.6.0 to a cluster running 7.5.0.
Expand All @@ -147,30 +138,30 @@ endif::[]
[[snapshot-index-compatibility]]
=== Index compatibility

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

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

As a workaround, you can first restore the data stream or index to another
cluster running the latest version of {es} that's compatible with both the index
and your current cluster. You can then use
<<reindex-from-remote,reindex-from-remote>> to rebuild the data stream or index
on your current cluster. Reindex from remote is only possible if the index's
<<mapping-source-field,`_source`>> is enabled.
A compatible snapshot can contain indices created in an incompatible version.
For example, a snapshot of a 7.16 cluster can contain an index created in 6.8.
If you try to restore the 6.8 index to an 8.0 cluster, the restore attempt will
fail. Keep this in mind if you take a snapshot before upgrading a cluster.

As a workaround, you can first restore the index to another cluster running the
latest version of {es} that's compatible with both the index and your current
cluster. You can then use <<reindex-from-remote,reindex-from-remote>> to rebuild
the index on your current cluster. Reindex from remote is only possible if the
index's <<mapping-source-field,`_source`>> is enabled.

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

[discrete]
[[snapshot-restore-warnings]]
=== Warnings
== Warnings

[discrete]
[[other-backup-methods]]
Expand Down
12 changes: 12 additions & 0 deletions docs/reference/snapshot-restore/snapshot-vers-compat.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

[cols="^,^,^,^,^"]
|====
| 4+^h| Cluster version
h| Snapshot version | 6.8 | 7.0–7.1 | 7.2–{prev-major-last} | 8.0–{minor-version}
| 5.0–5.6 | {yes-icon} | {no-icon} | {no-icon} | {no-icon}
| 6.0–6.7 | {yes-icon} | {yes-icon} | {yes-icon} | {no-icon}
| 6.8 | {yes-icon} | {no-icon} | {yes-icon} | {no-icon}
| 7.0–7.1 | {no-icon} | {yes-icon} | {yes-icon} | {yes-icon}
| 7.2–{prev-major-last} | {no-icon} | {no-icon} | {yes-icon} | {yes-icon}
| 8.0–{minor-version} | {no-icon} | {no-icon} | {no-icon} | {yes-icon}
|====