Skip to content

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

Open
STARRY-S wants to merge 1 commit into
Kong:mainfrom
STARRY-S:docs/aws-vault-secret-formats
Open

feat(gateway): add AWS secret vault ref syntax#5594
STARRY-S wants to merge 1 commit into
Kong:mainfrom
STARRY-S:docs/aws-vault-secret-formats

Conversation

@STARRY-S

@STARRY-S STARRY-S commented Jun 16, 2026

Copy link
Copy Markdown

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

  • Tested how-to docs. If not, note why here.
  • All pages contain metadata.
  • Any new docs link to existing docs.
  • All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
  • Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.
  • Every page has a description entry in frontmatter.
  • Add new pages to the product documentation index (if applicable).

Add an info callout to the Gateway and KIC AWS Secrets Manager vault
guides explaining how the reference syntax differs by secret type.
@netlify

netlify Bot commented Jun 16, 2026

Copy link
Copy Markdown

👷 Deploy request for kongdeveloper pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 7a790a0

@CLAassistant

CLAassistant commented Jun 16, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

@STARRY-S STARRY-S marked this pull request as ready for review June 16, 2026 03:38
@STARRY-S STARRY-S requested a review from a team as a code owner June 16, 2026 03:38
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