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.

Sign up for GitHub

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

Jump to bottom

docs/vso: hvs rotating and dynamic secrets #28656

Merged
merged 4 commits into from
Oct 12, 2024
Merged

docs/vso: hvs rotating and dynamic secrets #28656

merged 4 commits into from
Oct 12, 2024

Conversation

tvoran
Copy link
Member

@tvoran tvoran commented Oct 9, 2024 •
edited
Loading

Description

Documents usage of HVS rotating and dynamic secrets with VSO, part of VSO v0.9.0.

Preview links:

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.

@tvoran tvoran requested a review from a team as a code owner October 9, 2024 18:26
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Oct 9, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 9, 2024

CI Results:
All Go tests succeeded! ✅

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 9, 2024

Build Results:
All builds succeeded! ✅

@tvoran tvoran requested a review from a team October 9, 2024 18:36
thyton
thyton approved these changes Oct 10, 2024
View reviewed changes
Copy link
Contributor

@thyton thyton left a comment

Choose a reason for hiding this comment

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

LGTM

austingebauer
austingebauer approved these changes Oct 10, 2024
View reviewed changes
website/content/docs/platform/k8s/vso/sources/hvs.mdx
Comment on lines +111 to +113
secret_name: {"key_one": "value_one", "key_two": "value_two"}
secret_name_key_one: "value_one"
secret_name_key_two: "value_two"
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice!

@benashz benashz self-requested a review October 10, 2024 21:42
benashz
benashz approved these changes Oct 10, 2024
View reviewed changes
Copy link
Contributor

@benashz benashz left a comment

Choose a reason for hiding this comment

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

I added one minor nit for your consideration, otherwise +1

website/content/docs/platform/k8s/vso/sources/hvs.mdx Outdated

VSO syncs auto-rotating secrets along with static secrets on the
[refreshAfter][hvsa-spec] interval, and rotation is handled by HCP. VSO
syncs dynamic secrets when the [specified percentage](/vault/docs/platform/k8s/vso/api-reference#hvsdynamicsyncconfig)
Copy link
Contributor

Choose a reason for hiding this comment

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

nit could we add /vault/docs/platform/k8s/vso/api-reference to

vault/website/content/partials/vso/common-links.mdx

Line 1 in 137bba2

[va-spec]: /vault/docs/platform/k8s/vso/api-reference#vaultauthspec

Not sure if there are any other "candidate" paths that we should consider for inclusion as common links.

Copy link
Member Author

Choose a reason for hiding this comment

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

Do you have an example of how this would work? I'm not finding a way in markdown to define a link to the base url (/vault/docs/platform/k8s/vso/api-reference) and use that base link along with the anchor (#hvsdynamicsyncconfig) in the text.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe this one

vault/website/content/docs/platform/k8s/vso/sources/vault/index.mdx

Line 129 in f5963cf

the [VaultAuth spec][va-spec] for more details. The `VaultAuthGlobal` custom resource is optional and can be used to

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah, then I misunderstood. Is the idea to use common-links.mdx for all VSO links, and not just links that are used on multiple pages? (The links in this PR are only used in a single page, which is why I didn't add them to common-links.)

@tvoran
Copy link
Member Author

tvoran commented Oct 12, 2024

Thanks all! Getting this in now so it's up for next week.

@tvoran tvoran merged commit a94c8b8 into main Oct 12, 2024
32 checks passed
@tvoran tvoran deleted the docs/VAULT-30504/VAULT-30502/vso-hvs-rotating-dynamic branch October 12, 2024 00:50
Merged
2 tasks
benashz pushed a commit that referenced this pull request Jan 8, 2025
@tvoran @benashz
docs/vso: hvs rotating and dynamic secrets (#28656)
29c6053
benashz added a commit that referenced this pull request Jan 10, 2025
@benashz @tvoran
@pascal-hofmann @ZeroEcks
docs/vso: instant updates (#27668) (#29322)
e48de18 
* docs/vso: instant updates (#27668)

* Update VSO docs for auto CRD upgrade behaviour (#27763)

* VSO: update docs for VaultAuthGlobals (#27797)


---------

Co-authored-by: Theron Voran <[email protected]>

* Bump VSO versions to 0.8.0 (#27835)

* Update VSO docs for v0.8.1 (#27898)

* Including missing Helm documentation.
* Add version tip for instant updates

* Update VSO docs for v0.9.0 (#28639)

* Update VSO docs for v0.9.1 (#29151)

* vso/docs: restore upgrade instructions (#29159)

* docs: Fix path to allowedSprigFuncs (#29026)

* docs/vso: fix backwards v1 and v2 links (#28733)

Co-authored-by: Theron Voran <[email protected]>

* docs/vso: hvs rotating and dynamic secrets (#28656)

---------

Co-authored-by: Theron Voran <[email protected]>
Co-authored-by: Pascal Hofmann <[email protected]>
Co-authored-by: Melody <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benashz benashz benashz approved these changes

@thyton thyton thyton approved these changes

@austingebauer austingebauer austingebauer approved these changes

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@tvoran @thyton @benashz @austingebauer @tomcf-hcp