Skip to content

Commit b5b4bf4

Browse files
Copilotjkroepke
andauthored
docs: Remove references to removed clean command (#698)
Co-authored-by: jkroepke <[email protected]> Co-authored-by: copilot-swe-agent[bot] <[email protected]>
1 parent dc7dee0 commit b5b4bf4

File tree

1 file changed

+2
-11
lines changed

1 file changed

+2
-11
lines changed

docs/Usage.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -96,15 +96,6 @@ $ helm secrets edit examples/sops/secrets.yaml
9696

9797
There is new feature in SOPS master that allows using \$EDITOR to spcify editor used by sops but not released yet.
9898

99-
### Clean
100-
101-
The operation will delete all decrypted files in a directory, recursively:
102-
103-
```
104-
$ helm secrets clean examples/sops/
105-
removed examples/sops/secrets.yaml.dec
106-
```
107-
10899
If you use git there is commit hook that prevents commiting decrypted files and you can add all \*.yaml.dec files in you repository `.gitignore` file.
109100

110101
### Summary
@@ -136,7 +127,7 @@ charts/
136127
```
137128

138129
As you can see we can run different PGP or KMS keys per project, globally or per any tree level. Thanks to this we can isolate tree on different CI/CD instances using same GIT repository.
139-
As we use simple -f option when running the helm wrapper we can just use encrypted secrets.yaml and all these secrets will be decrypted and cleaned on the fly before and after helm run.
130+
As we use simple -f option when running the helm wrapper we can just use encrypted secrets.yaml and all these secrets will be decrypted on the fly before and after helm run.
140131

141132
`.sops.yaml` file example
142133

@@ -217,7 +208,7 @@ removed helm_vars/secrets.yaml.dec
217208
218209
You can see that we use a global secrets file and a specific secrets file for this app in this project/environment/region. We use some plain value files next to secrets. We use values from secrets in some secrets template in helloworld application chart template and some values are used in the configmap template in the same chart. Some values are added as env variables in deployment manifest templates in the chart. As you can see we can use secrets and values in helm in many ways. Everything depends on use case.
219210
220-
Even when helm failed then decrypted files are cleaned
211+
Even when helm fails, decrypted files are removed automatically
221212
222213
```
223214
AWS_PROFILE=sandbox helm-wrapper upgrade \

0 commit comments

Comments
 (0)