Skip to content

Commit 314c2a0

Browse files
committed
Docs: note about snapshot version compatibility (elastic#20896)
It is important that folks understand that snapshot/restore isn't for archiving. It is appropriate for backup and disaster recovery but not for archival over long periods of time because of version incompatibility. Closes elastic#20866
1 parent 7c5155a commit 314c2a0

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

docs/reference/modules/snapshots.asciidoc

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
11
[[modules-snapshots]]
22
== Snapshot And Restore
33

4-
The snapshot and restore module allows to create snapshots of individual indices or an entire cluster into a remote
5-
repository. At the time of the initial release only shared file system repository was supported, but now a range of
6-
backends are available via officially supported repository plugins.
4+
The snapshot and restore module allows to create snapshots of individual
5+
indices or an entire cluster into a remote repository like shared file system,
6+
S3, or HDFS. These snapshots are great for backups because they can be restored
7+
relatively quickly but they are not archival because they can only be restored
8+
to versions of Elasticsearch that can read the index. That means that:
9+
10+
* A snapshot of an index created in 2.x can be restored to 5.x.
11+
* A snapshot of an index created in 1.x can be restored to 2.x.
12+
* A snapshot of an index created in 1.x can **not** be restored to 5.x.
13+
14+
To restore a snapshot of an index created in 1.x to 5.x you can restore it to
15+
a 2.x cluster and use reindex-from-remote (only available in 5.0+) to rebuild
16+
the index in a 5.x cluster. This is as time consuming as restoring from
17+
archival copies of the original data.
718

819
[float]
920
=== Repositories
@@ -474,5 +485,3 @@ that snapshot before deleting the snapshot data from the repository.
474485
The restore operation uses the standard shard recovery mechanism. Therefore, any currently running restore operation can
475486
be canceled by deleting indices that are being restored. Please note that data for all deleted indices will be removed
476487
from the cluster as a result of this operation.
477-
478-

0 commit comments

Comments
 (0)