feat(gateway): add AWS secret vault ref syntax#5594
Open
STARRY-S wants to merge 1 commit into
Open
Conversation
Add an info callout to the Gateway and KIC AWS Secrets Manager vault guides explaining how the reference syntax differs by secret type.
👷 Deploy request for kongdeveloper pending review.Visit the deploys page to approve it
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds clarifying guidance to the AWS Secrets Manager vault how-tos (Gateway + KIC) so readers understand the correct vault:// reference syntax for different AWS secret value formats (plaintext vs JSON key/value), reducing confusion when referencing secrets in Kong.
Changes:
- Added an info callout describing how
vault://reference syntax differs for plaintext vs key/value (JSON) secrets. - Documented the constraint that key/value secrets must be flat JSON with string values (no nesting / non-strings).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| app/_how-tos/kubernetes-ingress-controller/kic-vault-aws.md | Adds an info callout explaining plaintext vs JSON secret reference syntax for the KIC AWS vault how-to. |
| app/_how-tos/gateway/configure-aws-secrets-manager-as-a-vault-backend-with-vault-entity.md | Adds the same info callout for the Gateway AWS Secrets Manager vault how-to. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add an info callout to the Gateway and KIC AWS Secrets Manager vault guides explaining how the reference syntax differs by secret type.
Fixes FTI-7221
Preview Links
WIP
Checklist
descriptionentry in frontmatter.