Custom vaults docs#5701
Open
mheap wants to merge 3 commits into
Open
Conversation
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds Gateway documentation for creating and using a custom Vault backend, and links it from existing secrets management surfaces to improve discoverability.
Changes:
- Adds a new Gateway how-to describing how to implement a custom vault backend in Lua and use Vault references in plugin configuration.
- Updates the Secrets management landing page to include a new “Custom vault backend” card linking to the how-to.
- Updates the Vault entity page to link to the new how-to and list “Custom vault backend” in the supported backends feature table.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| app/_landing_pages/gateway/secrets-management.yaml | Adds a new card CTA pointing users to the custom vault how-to from the secrets management landing page. |
| app/_how-tos/gateway/create-custom-vault.md | Introduces a new end-to-end how-to for implementing and testing a custom vault backend. |
| app/_gateway_entities/vault.md | Adds cross-links to the new how-to and includes it in the supported backends feature table. |
Comment on lines
+95
to
+98
| | Function | Description | | ||
| |----------|-------------| | ||
| | `init(conf)` | Called once at startup. Use it to validate config or open persistent connections. | | ||
| | `get(conf, resource, version)` | Called to resolve a secret reference. Returns the secret value as a string, or `nil` if not found. `resource` is the key portion of the `{vault://prefix/key}` reference. | |
|
|
||
| Create `kong/vaults/http.lua`: | ||
|
|
||
| ```lua |
|
|
||
| The schema declares the configuration fields exposed on the Vault entity. Create `kong/vaults/http/schema.lua`: | ||
|
|
||
| ```lua |
|
|
||
| 2. Create `docker-compose.yml`: | ||
|
|
||
| ```yaml |
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
Adds a Gateway how-to for custom vaults
Preview Links
/how-to/create-custom-vault/
Checklist
descriptionentry in frontmatter.