See Installation for more information.
Run decrypted command on specific value files. This is method is preferred over the plugin command below. This mode is used in ArgoCD environments.
On Windows, the command helm secrets patch windows
needs to be run first.
helm upgrade name . -f secrets:https://secrets.yaml
See Usage for more information
Wraps the whole helm command. Slow on multiple value files.
helm secrets upgrade name . -f secrets.yaml
Use AWS Secrets Manager or Azure KeyVault for storing secrets securely and reference them inside values.yaml
helm secrets --backend vals template bitnami/mysql --name-template mysql \
--set auth.rootPassword=ref+awsssm:https://foo/bar?mode=singleparam#/BAR
See Cloud Integration for more information.
For running helm-secrets with ArgoCD, see ArgoCD Integration for more information.
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
name: app
spec:
source:
helm:
valueFiles:
- secrets+gpg-import:https:///helm-secrets-private-keys/key.asc?secrets.yaml
- secrets+gpg-import-kubernetes:https://argocd/helm-secrets-private-keys#key.asc?secrets.yaml
- secrets:https://secrets.yaml
# fileParameters (--set-file) are supported, too.
fileParameters:
- name: config
path: secrets:https://secrets.yaml
# directly reference values from Cloud Providers
- name: mysql.rootPassword
path: secrets+literal:https://ref+azurekeyvault:https://my-vault/secret-a
The Terraform helm provider does not support downloader plugins.
helm secrets can be used together with the terraform external data source provider.
data "external" "helm-secrets" {
program = ["helm", "secrets", "decrypt", "--terraform", "../../examples/sops/secrets.yaml"]
}
resource "helm_release" "example" {
values = [
file("../../examples/sops/values.yaml"),
base64decode(data.external.helm-secrets.result.content_base64),
]
}
An example of how to use helm-secrets with terraform could be found in examples/terraform.
helm-secrets support multiple secret backends. Currently, sops and vals are supported.
See Secret-Backends how to use them.
An additional documentation, resources and examples can be found here.
scripts/run.sh
- Main helm-secrets plugin code for all helm-secrets plugin actions available inhelm secrets help
after plugin installscripts/backends
- Location of the in-tree secrets backendsscripts/commands
- Sub Commands ofhelm secrets
are defined here.scripts/lib
- Common functions used byhelm secrets
.scripts/wrapper
- Wrapper scripts for Windows systems.tests
- Test scripts to check if all parts of the plugin work. Using test assets with PGP keys to make real tests on real data with real encryption/decryption. Seetests/README.md
for more informations.examples
- Some example secrets.yaml
© 2020-2022 Jan-Otto Kröpke (jkroepke)
© 2017-2020 Zendesk
Licensed under the Apache License, Version 2.0