Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add note about vault kv get to Proxy docs #28400

Merged
merged 2 commits into from
Sep 17, 2024

Conversation

VioletHynes
Copy link
Contributor

@VioletHynes VioletHynes commented Sep 16, 2024

Description

This has tripped up something like five people in as many months that I'm aware of. As a result, I feel like it's worth a call-out in the docs as it's such a common point of confusion. This also adds something to the docs to clarify that secrets can be accessible even when Vault is unavailable, which is something we didn't have explicitly before.

TODO only if you're a HashiCorp employee

  • Backport Labels: If this PR is in the ENT repo and needs to be backported, backport
    to N, N-1, and N-2, using the backport/ent/x.x.x+ent labels. If this PR is in the CE repo, you should only backport to N, using the backport/x.x.x label, not the enterprise labels.
    • If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    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.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

@VioletHynes VioletHynes requested a review from a team as a code owner September 16, 2024 14:42
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Sep 16, 2024
Copy link

CI Results:
All Go tests succeeded! ✅

Copy link

Build Results:
All builds succeeded! ✅

Copy link
Contributor

@ccapurso ccapurso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks for adding that! My only question is whether or not we should backport this so that it is live for existing doc versions?

@VioletHynes
Copy link
Contributor Author

Good call-out about the backport. I'll backport it too!

@VioletHynes VioletHynes merged commit e17fc06 into main Sep 17, 2024
35 checks passed
@VioletHynes VioletHynes deleted the violethynes/add-note-for-kv-get-2024-09-16 branch September 17, 2024 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/1.18.x hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog pr/no-milestone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants