Skip to content

Commit c66aedd

Browse files
committed
Documentation refinements and cleanup
- Update AWS authentication anti-patterns section wording - Clean up CLI documentation - Minor text improvements in guide pages
1 parent 59641a4 commit c66aedd

4 files changed

Lines changed: 9 additions & 52 deletions

File tree

docs/guide/aws-authentication.md

Lines changed: 6 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -174,14 +174,14 @@ deploy:
174174
175175
## Security Best Practices
176176
177-
### Never Do This
177+
### Anti-Patterns to Avoid
178178
179-
Store AWS credentials in your repository
180-
Put AWS credentials in `.env` files tracked by git
181-
Use long-lived AWS access keys in production
182-
Share AWS credentials between environments
179+
Storing AWS credentials in your repository
180+
Putting AWS credentials in `.env` files tracked by git
181+
Using long-lived AWS access keys in production
182+
Sharing AWS credentials between environments
183183

184-
### Always Do This
184+
### Recommended Practices
185185

186186
✅ Use temporary credentials when possible (aws-vault, SSO, instance roles)
187187
✅ Apply least-privilege IAM policies
@@ -211,32 +211,6 @@ After setting up authentication, you need to configure IAM permissions for the A
211211

212212
Each vault type requires specific IAM permissions based on your usage pattern (read-only, read-write, or admin access).
213213

214-
## PHP Application Considerations
215-
216-
When using Keep with PHP applications:
217-
218-
1. **Don't hardcode AWS credentials in config**
219-
```php
220-
// config/aws.php - DON'T DO THIS
221-
'credentials' => [
222-
'key' => env('AWS_ACCESS_KEY_ID'),
223-
'secret' => env('AWS_SECRET_ACCESS_KEY'),
224-
]
225-
```
226-
227-
2. **Let the SDK find credentials automatically**
228-
```php
229-
// config/aws.php - DO THIS
230-
'credentials' => null, // SDK will use IAM role, ~/.aws/credentials, etc.
231-
```
232-
233-
3. **Generate .env before caching configuration**
234-
```bash
235-
# deployment.sh
236-
keep export --stage=production --output=.env
237-
# Then cache your application configuration if needed
238-
```
239-
240214
## Troubleshooting
241215

242216
**"Keep can't find AWS credentials"**

docs/guide/cli/index.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,24 +33,6 @@ sh 'docker build --secret id=env,src=.env .'
3333
sh 'rm -f .env' # Clean up
3434
```
3535

36-
### Automated Secret Rotation
37-
38-
```bash
39-
#!/bin/bash
40-
# Rotate API keys across environments
41-
42-
# Generate new key
43-
NEW_KEY=$(openssl rand -hex 32)
44-
45-
# Update in all stages
46-
for stage in local staging production; do
47-
keep set API_KEY "$NEW_KEY" --stage=$stage --force
48-
done
49-
50-
# Restart services
51-
keep run --stage=production -- systemctl restart api-server
52-
```
53-
5436
### Bulk Operations
5537

5638
```bash

docs/guide/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ Managing secrets across local, staging, and production environments is challengi
88

99
- **Unified Interface**: One CLI for all your secret vaults
1010
- **Stage Organization**: Separate secrets by environment (local, staging, production)
11-
- **Template Generation**: Build configuration files from templates with automatic secret injection
11+
- **Template Generation**: Build configuration files from templates with automatic secret replacement
1212
- **Team Collaboration**: Share vault access without exposing secret values
1313
- **Security First**: Encrypted storage, masked output, and secure AWS integration
14+
- **Deployment Ready**: Designed for CI/CD pipelines and automated workflows, supporting .env file generation or direct environment variable injection
1415

1516
## Getting Started
1617

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ hero:
1515

1616
features:
1717
- title: Multi-Vault Support
18-
details: AWS SSM and Secrets Manager, with more providers coming soon.
18+
details: Supports AWS SSM and Secrets Manager currently, with more providers planned.
1919

2020
- title: Stage Management
2121
details: Organize secrets by environment with seamless promotion workflows.

0 commit comments

Comments
 (0)