Document SOPS "recipes"
Open
Nobody has claimed this yet.
priority/medium
- Dominant language
- Go
- Stars
- 23.1k
- Forks
- 1.1k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 9
Description
SOPS can be very useful when combined with additional tools. Creating a list of "recipes" that use SOPS would be interesting and inspire creative usages of SOPS. A few examples:
- Use an SSH key encrypted in a SOPS file to log in to a remote server (#280)
- Operate on stdin (#330)
- Use SOPS to encrypt Kubernetes secrets on-disk (https://frederic-hemberger.de/articles/manage-kubernetes-secrets-with-sops/)
- Use SOPS as a secret backend for Ansible (#303)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the referenced issues #280, #330, and #303 and the linked Kubernetes article before deciding which SOPS integrations to document. Done means adding a useful, coherent list of SOPS recipes covering the proposed examples and explaining how each combination is used.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ansible, kubernetes
- Domain
- devops, documentation, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100