Skip to content

Commit c46c34c

Browse files
authored
feat: add aws secret manager docs (#245)
## Summary by Sourcery New Features: - Adds documentation for AWS Secret Manager, including setup instructions, IAM user creation, access key generation, and Helm chart values configuration.
1 parent 0817311 commit c46c34c

File tree

1 file changed

+95
-7
lines changed

1 file changed

+95
-7
lines changed

content/docs/launching-the-platform/self-hosted-onprem/prerequisites/secret-management.mdx

Lines changed: 95 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import { Tab, Tabs } from "fumadocs-ui/components/tabs";
1515
### Platform Options
1616
- HashiCorp Vault
1717
- Google Secret Manager
18+
- AWS Secret Manager
1819
</Card>
1920

2021
<Card>
@@ -28,7 +29,7 @@ import { Tab, Tabs } from "fumadocs-ui/components/tabs";
2829

2930
## Deployment Options
3031

31-
<Tabs items={['Google Secret Manager', 'HCP Vault', 'Self-Hosted Vault']}>
32+
<Tabs items={['Google Secret Manager', 'HCP Vault', 'Self-Hosted Vault', 'AWS Secret Manager']}>
3233
<Tab value="Google Secret Manager">
3334
### Google Secret Manager Setup
3435

@@ -193,6 +194,52 @@ import { Tab, Tabs } from "fumadocs-ui/components/tabs";
193194
</Callout>
194195
195196
</Tab>
197+
198+
<Tab value="AWS Secret Manager">
199+
### AWS Secret Manager Setup
200+
201+
<Steps>
202+
### Create IAM User
203+
- Go to AWS IAM Console
204+
- Create a new IAM user
205+
- Grant the following permissions:
206+
- `secretsmanager:CreateSecret`
207+
- `secretsmanager:GetSecretValue`
208+
- `secretsmanager:PutSecretValue`
209+
- `secretsmanager:DeleteSecret`
210+
- `secretsmanager:ListSecrets`
211+
212+
### Generate Access Keys
213+
- In the IAM console, select your user
214+
- Go to "Security credentials" tab
215+
- Create new access key
216+
- Save both the Access Key ID and Secret Access Key
217+
</Steps>
218+
219+
<Callout type="info">
220+
**AWS Secret Manager provides:**
221+
- Regional availability
222+
- Automatic encryption
223+
- Fine-grained IAM controls
224+
- AWS CloudTrail integration
225+
</Callout>
226+
227+
<Callout>
228+
**Helm Chart Values:**
229+
```yaml
230+
# values.yaml for Helm installation
231+
awsSecretManager:
232+
# -- Enable AWS Secret Manager integration
233+
enabled: true
234+
# -- The AWS region
235+
region: 'us-east-1'
236+
# -- The AWS access key ID
237+
accessKeyId: 'your-access-key-id'
238+
# -- The AWS secret access key
239+
secretAccessKey: 'your-secret-access-key'
240+
```
241+
</Callout>
242+
</Tab>
196243
</Tabs>
197244
198245
## Information Collection
@@ -211,7 +258,8 @@ Choose one of the following configurations for your Helm values:
211258
# values.yaml
212259
vault:
213260
enabled: false
214-
261+
awsSecretManager:
262+
enabled: false
215263
googleSecretManager:
216264
enabled: true
217265
projectId: "your-project-id"
@@ -232,7 +280,8 @@ googleSecretManager:
232280
# values.yaml
233281
googleSecretManager:
234282
enabled: false
235-
283+
awsSecretManager:
284+
enabled: false
236285
vault:
237286
enabled: true
238287
address: "https://vault-cluster.hashicorp.cloud:8200"
@@ -241,17 +290,36 @@ vault:
241290
secretId: "your-secret-id"
242291
```
243292
293+
**For AWS Secret Manager:**
294+
295+
- [ ] AWS Region
296+
- [ ] AWS Access Key ID
297+
- [ ] AWS Secret Access Key
298+
299+
```yaml
300+
# values.yaml
301+
vault:
302+
enabled: false
303+
googleSecretManager:
304+
enabled: false
305+
awsSecretManager:
306+
enabled: true
307+
region: "your-aws-region"
308+
accessKeyId: "your-access-key-id"
309+
secretAccessKey: "your-secret-access-key"
310+
```
311+
244312
<Callout type="warning">
245313
Make sure to:
246-
1. Enable only one secret management solution (`vault` or `googleSecretManager`)
247-
2. Disable the other option by setting `enabled: false`
314+
1. Enable only one secret management solution
315+
2. Explicitly disable all other secret management options by setting `enabled: false`
248316
3. Provide all required values for your chosen solution
249317
</Callout>
250318
</Callout>
251319
252320
## Validation
253321
254-
<Tabs items={['Google Secret Manager', 'HashiCorp Vault']}>
322+
<Tabs items={['Google Secret Manager', 'HashiCorp Vault', 'AWS Secret Manager']}>
255323
<Tab value="Google Secret Manager">
256324
```bash
257325
# Set environment variables
@@ -279,11 +347,23 @@ Make sure to:
279347
```
280348
281349
</Tab>
350+
351+
<Tab value="AWS Secret Manager">
352+
```bash
353+
# Set environment variables
354+
export AWS_ACCESS_KEY_ID="your-access-key-id"
355+
export AWS_SECRET_ACCESS_KEY="your-secret-access-key"
356+
export AWS_REGION="your-aws-region"
357+
358+
# Verify access (requires AWS CLI)
359+
aws secretsmanager list-secrets
360+
```
361+
</Tab>
282362
</Tabs>
283363
284364
## Troubleshooting
285365
286-
<div className="grid grid-cols-1 md:grid-cols-2 gap-6 mb-8">
366+
<div className="grid grid-cols-1 md:grid-cols-3 gap-6 mb-8">
287367
<Card>
288368
### Google Secret Manager Issues
289369
- Verify service account permissions
@@ -299,6 +379,14 @@ Make sure to:
299379
- Confirm TLS settings
300380
- Validate namespace (HCP)
301381
</Card>
382+
383+
<Card>
384+
### AWS Secret Manager Issues
385+
- Verify IAM permissions
386+
- Check access key validity
387+
- Confirm region setting
388+
- Validate network access
389+
</Card>
302390
</div>
303391
304392
<Callout type="info">

0 commit comments

Comments
 (0)