Skip to content

Add external secrets documentation#120

Open
Panthevm wants to merge 2 commits intomasterfrom
feature/external-secrets-docs
Open

Add external secrets documentation#120
Panthevm wants to merge 2 commits intomasterfrom
feature/external-secrets-docs

Conversation

@Panthevm
Copy link
Contributor

Summary

  • Add configuration/secret-files.md — documents the @secret:file: feature: supported resources (Client, IdentityProvider, TokenIntrospector, AidboxTopicDestination), configuration, security, rotation
  • Add external-secret-stores/ section under Run Aidbox on Kubernetes — guides for HashiCorp Vault and Azure Key Vault via Secrets Store CSI Driver
  • Update SUMMARY.md with new pages

Test plan

  • Verify pages render correctly on GitBook
  • Check all internal links between pages resolve
  • Verify mermaid diagrams render

- Add configuration/secret-files.md: @secret:file: feature, supported
  resources, security, rotation
- Add external-secret-stores/ guides for HashiCorp Vault and Azure Key Vault
  via Secrets Store CSI Driver
- Update SUMMARY.md with new pages
File["/run/secrets/client-secret"] -->|read at runtime| Aidbox
Aidbox -->|stores reference| DB["@secret:file:/run/secrets/client-secret"]

style File fill:#326CE5,stroke:#326CE5,color:#fff
Copy link
Collaborator

Choose a reason for hiding this comment

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


| Environment variable | Description | Default |
| --- | --- | --- |
| `AIDBOX_SECRET_FILES_ENABLED` | Enables `@secret:file:` resolution. When disabled, values with this prefix are rejected on save. | `false` |
Copy link
Collaborator

Choose a reason for hiding this comment

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

add link to settings reference here. if env name changes and no one will change it here, the link is useful. also link is good if reference has more additional details

| Environment variable | Description | Default |
| --- | --- | --- |
| `AIDBOX_SECRET_FILES_ENABLED` | Enables `@secret:file:` resolution. When disabled, values with this prefix are rejected on save. | `false` |
| `AIDBOX_SECRET_FILES_DIRS` | Comma-separated list of directories from which secret files can be loaded. File references outside these directories are rejected. | empty (no restriction) |
Copy link
Collaborator

Choose a reason for hiding this comment

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

here too


# Azure Key Vault

This guide covers mounting secrets from [Azure Key Vault](https://azure.microsoft.com/en-us/products/key-vault) into Aidbox using the Azure Key Vault CSI Provider. For the general concept and CSI Driver installation, see [External secret stores](./).
Copy link
Collaborator

Choose a reason for hiding this comment

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

[External secret stores](./)

wrong link?


# Azure Key Vault

This guide covers mounting secrets from [Azure Key Vault](https://azure.microsoft.com/en-us/products/key-vault) into Aidbox using the Azure Key Vault CSI Provider. For the general concept and CSI Driver installation, see [External secret stores](./).
Copy link
Collaborator

Choose a reason for hiding this comment

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

If this is a guide, it must be in /tutorial then?

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree


## Prerequisites

* Secrets Store CSI Driver installed ([instructions](./#install-the-secrets-store-csi-driver))
Copy link
Collaborator

Choose a reason for hiding this comment

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

wrong link?

CSI -->|mounts as file| Pod["/run/secrets/client-secret"]
Pod -->|reads at runtime| Aidbox["Aidbox (@secret:file:/run/secrets/client-secret)"]

style Vault fill:#0078D4,stroke:#0078D4,color:#fff
Copy link
Collaborator

Choose a reason for hiding this comment

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

same for chart here


This guide covers mounting secrets from [Azure Key Vault](https://azure.microsoft.com/en-us/products/key-vault) into Aidbox using the Azure Key Vault CSI Provider. For the general concept and CSI Driver installation, see [External secret stores](./).

## Prerequisites
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we need to mention K8s cluster in prerequisites

kubectl exec deploy/aidbox -- cat /run/azure-secrets/client-secret
```

Aidbox detects the file modification and uses the new value on the next request — no restart required.
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's add a See Also section with a link to secret-files.md

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

Comments