docs: add notes about keyring to snapshot restore #16663
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When cluster administrators restore from Raft snapshot, they also need to ensure the keyring is in place. For on-prem users doing in-place upgrades this is less of a concern but for typical cloud workflows where the whole host is replaced, it's an important warning (at least until #14852 has been implemented).
tgross
added
backport/1.4.x
lgfa29
approved these changes
Mar 27, 2023
Comment on lines
+18
to
+19
| This command only restores the Raft snapshot. If you are recovering a cluster, | ||
| you will also need to [restore the keyring][] onto at least one server. |
There was a problem hiding this comment.
Suggested change
| This command only restores the Raft snapshot. If you are recovering a cluster, | |
| you will also need to [restore the keyring][] onto at least one server. | |
| ~> **Warning:** This command only restores the Raft snapshot. If you are recovering a cluster, | |
| you will also need to [restore the keyring][] onto at least one server. |
but for typical cloud workflows where the whole host is replaced, it's an important warning
This is a good point, and I haven't thought of this before. So maybe it's worth highlighting these more?
There was a problem hiding this comment.
Sure. We can probably reword all of this once #14852 lands, but for now let's make it loud.
This was referenced Mar 28, 2023
tgross
added a commit
that referenced
this pull request
Mar 28, 2023
When cluster administrators restore from Raft snapshot, they also need to ensure the keyring is in place. For on-prem users doing in-place upgrades this is less of a concern but for typical cloud workflows where the whole host is replaced, it's an important warning (at least until #14852 has been implemented).
tgross
added a commit
that referenced
this pull request
Mar 28, 2023
When cluster administrators restore from Raft snapshot, they also need to ensure the keyring is in place. For on-prem users doing in-place upgrades this is less of a concern but for typical cloud workflows where the whole host is replaced, it's an important warning (at least until #14852 has been implemented). Co-authored-by: Tim Gross <[email protected]>
tgross
added a commit
that referenced
this pull request
Apr 28, 2023
When cluster administrators restore from Raft snapshot, they also need to ensure the keyring is in place. For on-prem users doing in-place upgrades this is less of a concern but for typical cloud workflows where the whole host is replaced, it's an important warning (at least until #14852 has been implemented).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When cluster administrators restore from Raft snapshot, they also need to ensure the keyring is in place. For on-prem users doing in-place upgrades this is less of a concern but for typical cloud workflows where the whole host is replaced, it's an important warning (at least until #14852 has been implemented).
Ref #16640 and https://github.com/hashicorp/tutorials/pull/1252