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

[ATO-1230] Add docs for Vault namespaces #12703

Merged
merged 3 commits into from
Aug 8, 2023
Merged

[ATO-1230] Add docs for Vault namespaces #12703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
63950df
Add docs for Vault namespaces
radovanZRasa Aug 1, 2023
18d14bc
Add changelog for Vault namespace docs
radovanZRasa Aug 1, 2023
6abd765
Address grammar in secret-manager.mdx
radovanZRasa Aug 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog/12703.doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document support for Vault namespaces.
12 changes: 12 additions & 0 deletions docs/docs/secrets-managers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,15 @@ and through `endpoints.yml` configuration file.
Environment variables and `endpoints.yml` configuration file are merged together
and **the values from the environment variables take precedence**.

:::info New in 3.7
Vault namespaces can be used to isolate secrets. You can
configure a namespace with the `VAULT_NAMESPACE` environment variable or the `namespace` key in secrets_manager
section of the `endpoints.yml` file.
To learn more about namespaces,
check out the [Vault namespaces docs](https://developer.hashicorp.com/vault/docs/enterprise/namespaces).
:::


The following environment variables are available:

| Environment Variable | Description | Default |
Expand All @@ -75,6 +84,7 @@ The following environment variables are available:
| `VAULT_TOKEN` | **Required**. token to authenticate to the vault server | |
| `VAULT_RASA_SECRETS_PATH` | Path to the secrets in the vault server | `rasa-secrets` |
| `VAULT_TRANSIT_MOUNT_POINT` | If transit secrets engine is enabled, set this to mount point of the transit engine | |
| `VAULT_NAMESPACE` | If namespaces are used, set this to the path of the namespace | |

To configure the Vault secrets manager, you can fill the following section in `endpoints.yml` file:
```yaml-rasa title="endpoints.yml
Expand All @@ -84,6 +94,7 @@ secrets_manager:
url: "http://localhost:1234" # required - the address of the vault server
secrets_path: rasa-secrets # path to the secrets in the vault server if not set it defaults to `rasa-secrets`
transit_mount_point: transit # if transit secrets engine is enabled, set this to mount point of the transit engine
namespace: my-namespace # if namespaces are used, set this to the path of the namespace
```

#### Store access credentials in environment variables
Expand All @@ -103,6 +114,7 @@ secrets_manager:
url: "http://localhost:1234"
secrets_path: rasa-secrets # if not set it defaults to `rasa-secrets`
transit_mount_point: transit # if you have enabled transit secrets engine, and you want to use it
namespace: my-namespace # if namespaces are used, set this to the path of the namespace
```

### How to configure Tracker Store with Vault Secrets Manager
Expand Down