Add documentation for AWS SSM Parameter Store secrets adapter#196
Add documentation for AWS SSM Parameter Store secrets adapter#196davafons wants to merge 1 commit intobasecamp:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds documentation for an upcoming aws_ssm_parameter_store secrets adapter to the kamal secrets command docs, including usage examples and a comparison table against other secret backends.
Changes:
- Document AWS SSM Parameter Store as a new secrets source, with
fetch/extractexamples. - Add a comparison table covering 1Password vs AWS Secrets Manager vs AWS SSM Parameter Store.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| # Extract the secret | ||
| kamal secrets extract REGISTRY_PASSWORD <SECRETS-FETCH-OUTPUT> | ||
| kamal secrets extract MyItem/REGISTRY_PASSWORD <SECRETS-FETCH-OUTPUT> |
There was a problem hiding this comment.
The extract example uses MyItem/REGISTRY_PASSWORD, but the rest of the SSM section uses /myapp/myapp paths and never introduces what MyItem represents for Parameter Store. Align the extract examples with the same naming convention used in the fetch examples to avoid confusion.
| kamal secrets extract MyItem/REGISTRY_PASSWORD <SECRETS-FETCH-OUTPUT> | |
| kamal secrets extract myapp/REGISTRY_PASSWORD <SECRETS-FETCH-OUTPUT> |
| # Fetch passwords | ||
| kamal secrets fetch --adapter aws_ssm_parameter_store --account default REGISTRY_PASSWORD DB_PASSWORD | ||
|
|
||
| # Fetch passwords from an item |
There was a problem hiding this comment.
This section labels --from /myapp as fetching "from an item", but the other examples imply --from is a path/prefix in Parameter Store. Consider renaming this heading/text to "from a path/prefix" (or similar) so readers don’t confuse it with an item-based vault model.
| # Fetch passwords from an item | |
| # Fetch passwords from a path/prefix |
Documentation for basecamp/kamal#1791