Skip to content

Commit a78630c

Browse files
authored
Update the index compatibility information (elastic#1617)
Fixes elastic#1200 Updates the [Index compatibility](https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore#index-compatibility) table in the **Snapshot and restore** section of the deployment docs. [Preview available here](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1617/deploy-manage/tools/snapshot-and-restore#index-compatibility) These changes are [confirmed by eng](elastic#1200 (comment)) and also [PR#118941](elastic/elasticsearch#118941) provides additional context on the compatibility.
1 parent 47acfae commit a78630c

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

deploy-manage/tools/snapshot-and-restore.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -143,22 +143,26 @@ You can’t restore a snapshot to an earlier version of {{es}}. For example, you
143143

144144
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.
145145

146-
| Index creation version | 6.8 | 7.0–7.1 | 7.2–7.17 | 8.0–8.2 | 8.3–8.17 |
147-
|------------------------|-----|---------|---------|---------|---------|
148-
| 5.0–5.6 |||||[^1^](#footnote-1) |
149-
| 6.0–6.7 |||||[^1^](#footnote-1) |
150-
| 6.8 |||||[^1^](#footnote-1) |
151-
| 7.0–7.1 ||||||
152-
| 7.2–7.17 ||||||
153-
| 8.0–8.17 ||||||
146+
| Index creation version | 6.8 | 7.0–7.1 | 7.2–7.17 | 8.0–8.2 | 8.3–8.18 | 9.0 |
147+
|------------------------|-----|---------|---------|---------|---------|-----|
148+
| 5.0–5.6 ||||| ✅ ^1^ | ✅ ^1^ |
149+
| 6.0–6.7 ||||| ✅ ^1^ | ✅ ^1^ |
150+
| 6.8 ||||| ✅ ^1^ | ✅ ^1^ |
151+
| 7.0–7.1 |||||| ✅ ^1, 2^ |
152+
| 7.2–7.17 |||||| ✅ ^1, 2^ |
153+
| 8.0–8.18 ||||| | |
154154

155155
^1^ $$$footnote-1$$$ Supported with [archive indices](/deploy-manage/upgrade/deployment-or-cluster/reading-indices-from-older-elasticsearch-versions.md).
156156

157-
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.
157+
^2^ $$$footnote-2$$$ Supported with [searchable snapshots](/deploy-manage/tools/snapshot-and-restore/searchable-snapshots.md).
158158

159-
A compatible snapshot can contain indices created in an older incompatible version. For example, a snapshot of a 7.17 cluster can contain an index created in 6.8. Restoring the 6.8 index to an 8.17 cluster fails unless you can use the [archive functionality](/deploy-manage/upgrade/deployment-or-cluster/reading-indices-from-older-elasticsearch-versions.md). Keep this in mind if you take a snapshot before upgrading a cluster.
159+
You can’t restore an index to an earlier version of {{es}}. For example, you can’t restore an index created in 8.18.0 to a cluster running 8.15.0.
160160

161-
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](https://www.elastic.co/guide/en/elasticsearch/reference/8.18/docs-reindex.html#reindex-from-remote) to rebuild the index on your current cluster. Reindex from remote is only possible if the index’s [`_source`](elasticsearch://reference/elasticsearch/mapping-reference/mapping-source-field.md) is enabled.
161+
#### Restoring incompatible indices
162+
163+
A compatible snapshot can contain indices created in an older incompatible version. To restore these incompatible indices, you must take additional steps. For example, a snapshot of a 7.17 cluster might contain an index created in 6.8. Restoring the 6.8 index to an 8.18 cluster fails unless you use the [archive functionality](/deploy-manage/upgrade/deployment-or-cluster/reading-indices-from-older-elasticsearch-versions.md). To restore a 7.17 index to a 9.0 cluster, you can use the [archive functionality](/deploy-manage/upgrade/deployment-or-cluster/reading-indices-from-older-elasticsearch-versions.md) or [searchable snapshots](/deploy-manage/tools/snapshot-and-restore/searchable-snapshots.md). Keep this in mind if you take a snapshot before upgrading a cluster.
164+
165+
To ensure index compatibility, 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](https://www.elastic.co/guide/en/elasticsearch/reference/8.18/docs-reindex.html#reindex-from-remote) to rebuild the index on your current cluster. Reindex from remote is only possible if the index’s [`_source`](elasticsearch://reference/elasticsearch/mapping-reference/mapping-source-field.md) is enabled.
162166

163167
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.
164168

0 commit comments

Comments
 (0)