search

getsops / sops

Simple and flexible tool for managing secrets
https://getsops.io/
Mozilla Public License 2.0
16.17k stars 855 forks source link

Sops yaml reference documentation #998

Open isavl opened 2 years ago

isavl commented 2 years ago

Hello there.

Where I can find reference documentation for sops.yaml configuration file?

rjhenry commented 2 years ago

I don't think there is any authoritative documentation, as yet. The config.go file shows the structures expected (e.g. a creation rule is defined here).

It's not as convenient as a full documentation page, but it will probably help with structuring a .sops.yaml file!

austinbutler commented 2 years ago

Even just having an example YAML file with all the keys in it would help.

almereyda commented 2 years ago

Yes, this is very much needed. And if only in an explanatory manner in the README. It's used there a few times, but one cannot find a human-language description about how it works, and how it is supposed to be used, e.g. can I globally define age keys (in the double sense) for multiple path_regex entries, how do we use master keys, is it possible to use input-type and output-type, and how, a.s.f.

chriscarpenter12 commented 3 months ago

I was told to add the age keys to .sops.yaml and couldn't find an example how. I too was looking for an example or docs.