Skip to content

feat(gateway): add AWS secret vault ref syntax #5594

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

Open
STARRY-S wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −0
Open

feat(gateway): add AWS secret vault ref syntax #5594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions ...s/gateway/configure-aws-secrets-manager-as-a-vault-backend-with-vault-entity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,14 @@ value: 'secret'

If the vault was configured correctly, this command should return the value of the secret. Then, you can use `{vault://aws-vault/my-aws-secret/token}` to reference the secret in any referenceable field.

{:.info}
> **Reference plaintext and key/value secrets**
>
> AWS secrets can be stored as **plaintext** and **key/value (JSON)**. How you reference a secret depends on its type:
>
> * If your secret is a **key/value (JSON)** secret, reference it by the secret name and the field key: `{vault://aws-vault/my-aws-secret/token}`
> * If your secret is a **plaintext** secret, reference it by the secret name only: `{vault://aws-vault/my-aws-secret}`
>
> For key/value secrets, the secret must be a flat JSON object whose values are strings. Nested objects and non-string values aren't supported.

For more information about supported secret types, see [What can be stored as a secret](/gateway/entities/vault/#what-can-be-stored-as-a-secret).
10 changes: 10 additions & 0 deletions app/_how-tos/kubernetes-ingress-controller/kic-vault-aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,14 @@ command: kubectl exec -n kong -it deployment/kong-gateway -c proxy --

If the vault was configured correctly, this command should return the value of the secret. You can use `{vault://aws-vault/my-aws-secret/token}` to reference the secret in any referenceable field.

{:.info}
> **Reference plaintext and key/value secrets**
>
> AWS secrets can be stored as **plaintext** and **key/value (JSON)**. How you reference a secret depends on its type:
>
> * If your secret is a **key/value (JSON)** secret, reference it by the secret name and the field key: `{vault://aws-vault/my-aws-secret/token}`
> * If your secret is a **plaintext** secret, reference it by the secret name only: `{vault://aws-vault/my-aws-secret}`
>
> For key/value secrets, the secret must be a flat JSON object whose values are strings. Nested objects and non-string values aren't supported.

For more information about supported secret types, see [What can be stored as a secret](/gateway/entities/vault/#what-can-be-stored-as-a-secret).
Loading