Skip to content

Update SPIFFE secrets engine docs - #3086

Draft
jonathanfrappier wants to merge 10 commits into
mainfrom
SPE-1588/update-spiffe-secrets
Draft

Update SPIFFE secrets engine docs#3086
jonathanfrappier wants to merge 10 commits into
mainfrom
SPE-1588/update-spiffe-secrets

Conversation

@jonathanfrappier

@jonathanfrappier jonathanfrappier commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Description

🎫 SPE-1588

  • Update spiffe secrets engine docs with new overview page, cookbook style guide to set up and auth to external service from Vault

Requested review scope:

  • Content touched by the PR only (typos, clarifications, tips)
  • Code test (command and code block changes)
  • Flow and language near changes (new/rearranged steps)
  • Review everything (rewrites, major changes)

Review urgency:

  • ASAP (bug fixes, broken content, imminent releases)
  • 3 days (small changes, easy reviews)
  • 1 week (default)
  • Best effort (very non-urgent)

All updates:

I have:

  • Verified that all status checks have passed
  • Verified that preview environment has successfully deployed
  • Verified appropriate label applied (hcp + product name)
  • Added all required reviewers (code owners and external)

@jonathanfrappier jonathanfrappier self-assigned this Aug 11, 2026
@github-actions github-actions Bot added the Vault Content update for Vault product docs label Aug 11, 2026
@github-actions

github-actions Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Fri Aug 14 15:25:49 UTC 2026
Unified Docs API ✅ Ready (Inspect) Visit Preview Fri Aug 14 15:20:48 UTC 2026

@github-actions

github-actions Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Broken Link Checker

This PR contains broken links, but won't be blocked. Use this report to improve content quality:

Quick Actions

  • Internal links (HashiCorp sites): Please fix these - they impact user experience
  • External links: Consider if these are essential or can be updated/removed
  • Temporary issues: External sites may recover - check again before merging

Need Help?


Internal Links

Full Github Actions output

External Links

Full Github Actions output

Comment thread content/vault/v2.x/content/docs/secrets/spiffe/index.mdx Outdated
Comment thread content/vault/v2.x/content/docs/secrets/spiffe/mint-svid.mdx Outdated

Grafana requires HTTPS for `jwk_set_url`. This step allows you to start
Grafana by providing the file directly. In a production environment, you would
do this over a TLS connection directly to Vault.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

You could use vault server's -dev-tls option to make this more realistic.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I considered it, but its an example, not meant to mimic production deployments (otherwise the consumer/grafana approach is also severely limited). Was enough extra steps to set the get/set the cert from the container (which then lead me to thinking of dropping the container but it works as written). The outcome is to show Vault mints a SVID, and the SVID is usable. IMO this flow does this.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sure, I thought it would make the example simpler, if it doesn't that's fine.

Comment thread content/vault/v2.x/content/docs/secrets/spiffe/mint-svid.mdx
Comment thread content/vault/v2.x/content/docs/secrets/spiffe/spiffe.mdx
Comment thread content/vault/v2.x/content/docs/secrets/spiffe/spiffe.mdx Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Vault Content update for Vault product docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants