Skip to content
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.

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

feat(remote/aws): support AWS Secrets Manager as remote component #718

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Apply suggestions from Clayton's code review
Co-authored-by: Clayton Cornell <[email protected]>
  • Loading branch information
hainenber and clayton-cornell committed May 16, 2024
commit 21f1b2e1f367a3db4d647aeac230dc35c5832c51
19 changes: 12 additions & 7 deletions docs/sources/reference/components/remote.aws.secrets_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,18 @@ title: remote.aws.secrets_manager

# remote.aws.secret_manager

`remote.aws.secrets_manager` securely exposes value of secrets located in [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/) to other components.
By default, the secret would be fetched one time only at startup. If configured, the secret will be polled for changes so that the most recent value is always available.
`remote.aws.secrets_manager` securely exposes the secrets located in [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/) to other components.
By default, the secret is fetched once only at startup. If configured, the secret is polled for changes so that the most recent value is always available.

Beware that this could incur cost due to frequent API calls.
{{< admonition type="note" >}}
The polling for changes could incur costs due to frequent API calls.
{{< /admonition >}}

Multiple `remote.aws.secrets_manager` components can be specified using different name
labels. By default, [AWS environment variables](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html) are used to authenticate against AWS. The `key` and `secret` arguments inside `client` blocks can be used to provide custom authentication.
You can specify multiple `remote.aws.secrets_manager` components by giving them different labels.
By default, [AWS environment variables][] are used to authenticate against AWS.
For custom authentication, you can use the `key` and `secret` arguments inside `client` blocks.

[AWS environment variables]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html

## Usage

Expand All @@ -35,7 +40,7 @@ Name | Type | Description

Hierarchy | Name | Description | Required
----------|------------|----------------------------------------------------|---------
client | [client][] | Additional options for configuring the AWS client. | no
client | [client][] | Additional AWS client configuration options. | no

[client]: #client-block

Expand Down Expand Up @@ -64,7 +69,7 @@ The `data` field contains a mapping from data field names to values.

## Component health

Instances of `remote.aws.secrets_manager` report as healthy if most recent fetch of stored secrets was successful.
Instances of `remote.aws.secrets_manager` report as healthy if the most recent fetch of stored secrets was successful.

## Debug information

Expand Down