Skip to content

Commit

Permalink
docs: Clarify version restriction for snapshot restore
Browse files Browse the repository at this point in the history
Clarify that Consul snapshots must be restored into clusters running
the same version as the cluster from where the snapshot was taken.
  • Loading branch information
blake committed May 10, 2022
1 parent b739ebc commit 4c0f840
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion website/content/api-docs/snapshot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion website/content/commands/snapshot/restore.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 4c0f840

Please sign in to comment.