Document the SOPS secrets adapter - #201
Open
indiebrain wants to merge 4 commits into
Open
Conversation
Add a sops section to the secrets command docs, covering fetching keys from a sops-encrypted file via --from, nested key flattening, subtree and fetch-all behavior, and that --account is not used.
There was a problem hiding this comment.
Pull request overview
Documents the new sops secrets adapter on the kamal secrets command page, aligning it with the existing adapter documentation pattern and explaining how encrypted files/keys are addressed when fetching and extracting secrets.
Changes:
- Adds a new “sops” adapter section describing usage with
--from, positional key arguments, and flattenedparent/childpaths. - Provides examples for fetching specific keys, all keys, and entire nested subtrees, plus extraction examples.
- Notes adapter behavior around output normalization and
--accountbeing ignored.
Tip
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
indiebrain
changed the title
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documents the new
sopssecrets adapter on thekamal secretscommand page.Companion
This documents the adapter added in basecamp/kamal#1906.
The new section follows the structure of the existing adapter sections (install
link → behavior →
Use the adapter→ examples → notes) and covers:--fromnames the sops-encrypted file; positional arguments are keys within it.parent/childpaths; a parent key selects itswhole subtree; passing no keys fetches every key.
--output-type jsonto sops internally so it normalizes YAML / JSON / env sources to oneaddressable shape — there is no user-facing
--output-typeoption.--accountis unused.