Skip to content

docs: document pluggable secrets providers (1Password, HashiCorp Vault) - #58

Open
lbajsarowicz wants to merge 2 commits into
wardenenv:mainfrom
lbajsarowicz:docs/secrets-providers
Open

lbajsarowicz wants to merge 2 commits into
wardenenv:mainfrom
lbajsarowicz:docs/secrets-providers

Conversation

@lbajsarowicz

Copy link
Copy Markdown
Contributor

Summary

Documents pluggable secrets providers from wardenenv/warden#950.

  • New page Configuration → Secrets Providers: how WARDEN_SECRETS works, the 1Password provider (Environments and .env.op secret references), the HashiCorp Vault provider, reserved names, security notes, a troubleshooting table with the exact warning texts, and a short guide to writing a provider
  • Three Mermaid diagrams (sphinxcontrib.mermaid is already enabled): the warden env up sequence, 1Password mode selection, and the provider contract
  • One bullet in the feature list on the index page

Draft until wardenenv/warden#950 is merged, so the page never describes a feature that has not shipped.

Test plan

  • sphinx-build -W --keep-going -E -b html . _build/html passes with no warnings
  • Every WARDEN_* variable and every quoted warning was checked against the code in #950

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant