Skip to content

Add secret store configuration#216

Open
danielgerlag wants to merge 2 commits into
drasi-project:mainfrom
danielgerlag:secrets
Open

Add secret store configuration#216
danielgerlag wants to merge 2 commits into
drasi-project:mainfrom
danielgerlag:secrets

Conversation

@danielgerlag
Copy link
Copy Markdown
Contributor

The changes introduce a new feature for configuring secret stores, allowing sensitive values to be managed securely outside of configuration files. This includes support for various secret store providers and detailed instructions on how to implement them.

Signed-off-by: Daniel Gerlag <daniel@gerlag.ca>
Copilot AI review requested due to automatic review settings May 21, 2026 23:18
@danielgerlag danielgerlag requested a review from a team as a code owner May 21, 2026 23:18
Add words used in secret store documentation to the custom
spellcheck dictionary: ACI, Hardcoded, IntelliJ, KDE, Keychain,
Keyring, keyring, VMs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation for a new secretStore configuration feature in Drasi Server, describing how sources/reactions can resolve sensitive values from external providers rather than embedding secrets directly in config.

Changes:

  • Extended the configuration reference to document secretStore (single- and multi-instance) and provider-specific fields.
  • Added a new “Configure Secret Stores” how-to guide with provider setup, examples, and troubleshooting.
  • Linked the new guide from the main “Configure Drasi Server” guide and the configuration how-to landing page.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

File Description
docs/content/drasi-server/reference/configuration/_index.md Adds secretStore to the configuration reference and documents provider options.
docs/content/drasi-server/how-to-guides/configuration/configure-secret-stores/_index.md New how-to guide explaining secret envelopes and supported secret store providers.
docs/content/drasi-server/how-to-guides/configuration/configure-drasi-server/_index.md References the new secret store docs and adds example/config guidance.
docs/content/drasi-server/how-to-guides/configuration/_index.md Adds a navigation card for the new “Configure Secret Stores” guide.
Comments suppressed due to low confidence (1)

docs/content/drasi-server/how-to-guides/configuration/configure-drasi-server/_index.md:596

  • Same relref issue as above: "configure-secret-stores" is likely resolved relative to configure-drasi-server/ and may not match the actual page path. Use an explicit sibling/absolute path to avoid broken links.
For stronger secret management, consider using a [secret store]({{< relref "configure-secret-stores" >}}) instead of (or alongside) environment variables. Secret stores keep credentials in a dedicated vault and prevent them from appearing in environment variable dumps or process listings.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

| `tenantId` | string | Conditional | Required for `client_secret`. |
| `clientSecret` | string | Conditional | Required for `client_secret`. |

{{% alert title="Bootstrap constraint" color="warning" %}}
| OS Keyring | `keyring` | Local development — uses OS credential manager |
| Azure Key Vault | `azure-keyvault` | Production on Azure — resolves from Key Vault |

For full provider configuration details, see [Configure Secret Stores]({{< relref "configure-secret-stores" >}}).
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.

3 participants