Skip to content

Commit 2c443cf

Browse files
authored
Document AWS Secrets Manager Secret Store (#190)
1 parent cfb92f4 commit 2c443cf

File tree

4 files changed

+56
-1
lines changed

4 files changed

+56
-1
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: 'AWS Secrets Manager Secret Store'
3+
sidebar_label: 'AWS Secrets Manager Secret Store'
4+
sidebar_position: 3
5+
description: 'AWS Secrets Manager Secret Store Documentation'
6+
---
7+
8+
The `aws_secrets_manager` store enables Spice to read secrets from [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/).
9+
10+
```yaml
11+
version: v1beta1
12+
kind: Spicepod
13+
name: taxi_trips
14+
secrets:
15+
store: aws_secrets_manager
16+
```
17+
The store reads secrets named as `spice_secret_<secret-name>`, for example `dremio` login and password must be defined as `spice_secret_dremio` secret in [AWS Secrets Manager](https://console.aws.amazon.com/secretsmanager/listsecrets)
18+
19+
<img src="/img/secrets-aws-secrets-manager-dremio-1.png" alt="" width="800" />
20+
21+
<img src="/img/secrets-aws-secrets-manager-dremio-2.png" alt="" width="800" />
22+
23+
A complete spicepod definition with a dataset that uses a secret from AWS Secrets Manager created above.
24+
25+
```yaml
26+
version: v1beta1
27+
kind: Spicepod
28+
name: taxi_trips
29+
secrets:
30+
store: aws_secrets_manager
31+
32+
datasets:
33+
- from: dremio:datasets.taxi_trips
34+
name: taxi_trips
35+
description: dremio taxi trips
36+
params:
37+
endpoint: grpc://20.163.171.81:32010
38+
```
39+
40+
## AWS Secrets Manager Access
41+
42+
To use AWS Secrets Manager, an AWS account and a user in IAM Identity Center with the `secretsmanager:GetSecretValue` permission are required. Read [Authentication and access control for AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html) for details.
43+
44+
Use the [AWS CLI](https://docs.aws.amazon.com/cli/v1/userguide/cli-chap-authentication.html) to configure AWS access:
45+
46+
```bash
47+
aws configure
48+
```
49+
50+
Check configuration with:
51+
52+
```bash
53+
aws sts get-caller-identity
54+
aws secretsmanager get-secret-value --secret-id MyTestSecret
55+
```

spiceaidocs/docs/secret-stores/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ pagination_next: null
99

1010
A Secret Store is a location where `secret` objects are stored, used to store sensitive data, like passwords, tokens, secret keys.
1111

12-
Spice supports multiple types of secret stores: `file`, `env`, `kubernetes` and `keyring`. The type of secret store is specified in the `store` field of the `secrets` section in the Spicepod manifest.
12+
Spice supports multiple types of secret stores: `file`, `env`, `kubernetes`, `keyring` and `aws_secrets_manager`. The type of secret store is specified in the `store` field of the `secrets` section in the Spicepod manifest.
1313

1414
## Example
1515

130 KB
Loading
68.8 KB
Loading

0 commit comments

Comments
 (0)