-
Notifications
You must be signed in to change notification settings - Fork 846
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Retrieves Keys from Vault. Supports Role auth currently.
- Loading branch information
1 parent
6a8353e
commit d04c5c3
Showing
7 changed files
with
555 additions
and
0 deletions.
There are no files selected for viewing
136 changes: 136 additions & 0 deletions
136
docs/modules/components/pages/processors/vault_key.adoc
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| = vault_key | ||
| :type: processor | ||
| :status: beta | ||
|
|
||
|
|
||
|
|
||
| //// | ||
| THIS FILE IS AUTOGENERATED! | ||
|
|
||
| To make changes, edit the corresponding source file under: | ||
|
|
||
| https://github.com/redpanda-data/connect/tree/main/internal/impl/<provider>. | ||
|
|
||
| And: | ||
|
|
||
| https://github.com/redpanda-data/connect/tree/main/cmd/tools/docs_gen/templates/plugin.adoc.tmpl | ||
| //// | ||
| // © 2024 Redpanda Data Inc. | ||
| component_type_dropdown::[] | ||
| Fetches a Value for a Key from Hashicorp Vault | ||
| ```yml | ||
| # Config fields, showing default values | ||
| label: "" | ||
| vault_key: | ||
| url: "" # No default (required) | ||
| auth: | ||
| mount_path: "" # No default (optional) | ||
| app_role: | ||
| role_id: "" # No default (required) | ||
| secret_id: "" # No default (required) | ||
| mount_path: "" # No default (optional) | ||
| path: "" # No default (required) | ||
| version: "" # No default (optional) | ||
| ``` | ||
| The fields `mount_path`, `path` and `version` support | ||
| xref:configuration:interpolation.adoc#bloblang-queries[interpolation functions], allowing | ||
| you to create a unique `mount_path`, `path` and/or `version` for each message. | ||
| == Fields | ||
| === `url` | ||
| The base URL of the Vault server. | ||
| *Type*: `string` | ||
| === `auth` | ||
| Sorry! This field is missing documentation. | ||
| *Type*: `object` | ||
| === `auth.mount_path` | ||
| Sorry! This field is missing documentation. | ||
| *Type*: `string` | ||
| === `auth.app_role` | ||
| Sorry! This field is missing documentation. | ||
| *Type*: `object` | ||
| === `auth.app_role.role_id` | ||
| Unique identifier of the Role | ||
| [CAUTION] | ||
| ==== | ||
| This field contains sensitive information that usually shouldn't be added to a config directly, read our xref:configuration:secrets.adoc[secrets page for more info]. | ||
| ==== | ||
| *Type*: `string` | ||
| === `auth.app_role.secret_id` | ||
| SecretID belong to the App role | ||
| [CAUTION] | ||
| ==== | ||
| This field contains sensitive information that usually shouldn't be added to a config directly, read our xref:configuration:secrets.adoc[secrets page for more info]. | ||
| ==== | ||
| *Type*: `string` | ||
| === `mount_path` | ||
| Supports xref:configuration:interpolation.adoc#bloblang-queries[interpolation functions]. | ||
| *Type*: `string` | ||
| === `path` | ||
| The key path to fetch from Vault. | ||
| Supports xref:configuration:interpolation.adoc#bloblang-queries[interpolation functions]. | ||
| If root gets deleted no message gets produced. | ||
| *Type*: `string` | ||
| === `version` | ||
| The specific key version to fetch from Vault. | ||
| Supports xref:configuration:interpolation.adoc#bloblang-queries[interpolation functions]. | ||
| This field supports xref:configuration:interpolation.adoc#bloblang-queries[interpolation functions]. | ||
| *Type*: `string` | ||
This file contains 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
This file contains 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
Oops, something went wrong.