luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

docs: Clarify version restriction for snapshot restore 

Clarify that Consul snapshots must be restored into clusters running
the same version as the cluster from where the snapshot was taken.
This commit is contained in:
Blake Covarrubias 2022-05-08 12:12:10 -07:00 committed by Blake Covarrubias
parent a24dd8d4d4
commit 45ff0ebc91
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
website/content/api-docs/snapshot.mdx
View File

@ -77,7 +77,8 @@ This endpoint restores a point-in-time snapshot of the Consul server state.
Restores involve a potentially dangerous low-level Raft operation that is not
designed to handle server failures during a restore. This operation is primarily
intended to be used when recovering from a disaster, restoring into a fresh
cluster of Consul servers.
cluster of Consul servers running the same version as the cluster from where the
snapshot was taken.
The body of the request should be a snapshot archive returned from a previous
call to the `GET` method.

3
website/content/commands/snapshot/restore.mdx
View File

@ -17,7 +17,8 @@ from the given file.
Restores involve a potentially dangerous low-level Raft operation that is not
designed to handle server failures during a restore. This command is primarily
intended to be used when recovering from a disaster, restoring into a fresh
cluster of Consul servers.
cluster of Consul servers running the same version as the cluster from where the
snapshot was taken.
The table below shows this command's [required ACLs](/api#authentication). Configuration of
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)