Merge pull request #1242 from fluxcd/docs-sops-secretRef

docs: Clarify `.spec.decryption.secretRef` usage
This commit is contained in:
Stefan Prodan 2024-09-13 12:49:39 +03:00 committed by GitHub
commit c00854e7d7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 4 deletions

View File

@ -739,12 +739,13 @@ Secret, encrypting the `metadata`, `kind` or `apiVersion` fields is not supporte
An easy way to do this is by appending `--encrypted-regex '^(data|stringData)$'`
to your `sops --encrypt` command.
It has two required fields:
It has two fields:
- `.provider`: The secrets decryption provider to be used. This field is required and
the only supported value is `sops`.
- `.secretRef.name`: The name of the secret that contains the keys to be used for
decryption.
- `.provider`: The secrets decryption provider to be used. The only supported
value at the moment is `sops`.
decryption. This field can be omitted when using the
[global decryption](#controller-global-decryption) option.
```yaml
---