VAULT-29784: Skip connection verification on DB config read #28139
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
|
CI Results: |
|
Build Results: |
fairclothjm
reviewed
Aug 21, 2024
| @@ -392,6 +393,7 @@ func (b *databaseBackend) connectionReadHandler() framework.OperationFunc { | |||
| } | |||
|
|
|||
| resp.Data = structs.New(config).Map() | |||
| delete(resp.Data, "verify_connection") | |||
There was a problem hiding this comment.
This seems like something we could keep in the response.
There was a problem hiding this comment.
I was on the fence on this as well. I agree we can probably keep it so I'll remove that line!
fairclothjm
approved these changes
Aug 21, 2024
Merged
2 tasks
davidadeleon
added
the
backport/ent/1.16.x+ent
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.
Description
This PR solves a potential delay in reading existing DB connection configurations. When adding a computed
running_plugin_versionfield to the response when reading a database configuration, we introduced the possibility of adding additional latency to this read request while attempting to verify the connection regardless of whether or notverify_connectionwas set to false in the config. In the event that there was additional latency introduced, this had the potential of causing Terraform runs, or any other workflow that depended upon reading numerous DB connections, to take longer than expected. In the Terraform case this could lead to timeouts causing failures. This PR forces the skipping of the connection verification on DB configuration read. A side effect of this implementation is that we also respect theverify_connectionparameter further in the DB connection process during initialization which will result in slightly different error messaging in the event of a failed connection during a DB operation where the connection is not set to verify. If the configuration is set to skip verification, the connection is attempted and the error bubbles up, but will no longer be wrapped in aerror verifying connectionerror message. This is not only clearer, but more in-line with what is expected based on configuration.TODO only if you're a HashiCorp employee
to N, N-1, and N-2, using the
backport/ent/x.x.x+entlabels. If this PR is in the CE repo, you should only backport to N, using thebackport/x.x.xlabel, not the enterprise labels.of a public function, even if that change is in a CE file, double check that
applying the patch for this PR to the ENT repo and running tests doesn't
break any tests. Sometimes ENT only tests rely on public functions in CE
files.
in the PR description, commit message, or branch name.
description. Also, make sure the changelog is in this PR, not in your ENT PR.