From 4c0f840c891ba1064f46853fc7eb961352736d63 Mon Sep 17 00:00:00 2001 From: Blake Covarrubias Date: Sun, 8 May 2022 12:12:10 -0700 Subject: [PATCH] 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. --- website/content/api-docs/snapshot.mdx | 3 ++- website/content/commands/snapshot/restore.mdx | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/website/content/api-docs/snapshot.mdx b/website/content/api-docs/snapshot.mdx index 2e3419279b..01d4936a2b 100644 --- a/website/content/api-docs/snapshot.mdx +++ b/website/content/api-docs/snapshot.mdx @@ -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. diff --git a/website/content/commands/snapshot/restore.mdx b/website/content/commands/snapshot/restore.mdx index 1657033d15..2d7ec902ea 100644 --- a/website/content/commands/snapshot/restore.mdx +++ b/website/content/commands/snapshot/restore.mdx @@ -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)