Adds replication state helper to framework.Backend #21743
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
github-actions
bot
added
the
hashicorp-contributed-pr
austingebauer
commented
Jul 11, 2023
| // WriteSafeReplicationState returns true if this backend instance is capable of writing | ||
| // to storage without receiving an ErrReadOnly error. The active instance in a primary | ||
| // cluster or a local mount on a performance secondary is capable of writing to storage. | ||
| func (b *Backend) WriteSafeReplicationState() bool { |
There was a problem hiding this comment.
We could also invert this to something like HasReadOnlyStorage(). This PKI conditional backend.go#L454 is an example of what that could look like.
I'm open either way. Lmk your thoughts!
There was a problem hiding this comment.
I prefer WriteSafeReplicationState.
fairclothjm
approved these changes
Jul 11, 2023
sebinjohn
pushed a commit
to sebinjohn/vault
that referenced
this pull request
Aug 11, 2023
* Adds replication state helper to framework.Backend * Fix test * adds changelog
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.
This PR adds a helper method to
framework.Backendto DRY up some commonly repeated and easy to mess up replication state checking logic. The logic is used to prevent backends from attempting to write on a Vault instance with read-only storage.There are at least a few more backends where we can begin using this helper method. I've included a couple of plugin backends to show what the usage looks like. Follow-up PRs can be made after this is merged.