Browse Source

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

### 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.
James Rodewig 3 years ago
parent
commit
93bd599f6d

+ 12 - 0
docs/reference/snapshot-restore/cluster-index-compat.asciidoc

@@ -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}
+|====

+ 19 - 25
docs/reference/snapshot-restore/index.asciidoc

@@ -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.
@@ -147,22 +138,25 @@ 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.
+You can't restore an index to an earlier version of {es}. For example, you can't
+restore an index created in 7.6.0 to a cluster running 7.5.0.
+
+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
@@ -170,7 +164,7 @@ to estimate your time requirements.
 
 [discrete]
 [[snapshot-restore-warnings]]
-=== Warnings
+== Warnings
 
 [discrete]
 [[other-backup-methods]]

+ 12 - 0
docs/reference/snapshot-restore/snapshot-vers-compat.asciidoc

@@ -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}
+|====