public_git
/
helmfile
mirror of https://github.com/helmfile/helmfile.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update helmfile.yaml example in README (#1189) 

- Adds default comments into helmfile.yaml example

- Fixes some typos

Signed-off-by: Vadim Bauer <vb@8gears.com>
This commit is contained in:
Vadim Bauer 2020-04-10 01:27:09 +02:00 committed by GitHub
parent 7d11f5dedc
commit e0811dffa2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -37,7 +37,7 @@ To avoid upgrades for each iteration of `helm`, the `helmfile` executable delega
**CAUTION**: This documentation is for the development version of Helmfile. If you are looking for the documentation for any of releases, please switch to the corresponding release tag like [v0.92.1](https://github.com/roboll/helmfile/tree/v0.92.1). **CAUTION**: This documentation is for the development version of Helmfile. If you are looking for the documentation for any of releases, please switch to the corresponding release tag like [v0.92.1](https://github.com/roboll/helmfile/tree/v0.92.1).
The default helmfile is `helmfile.yaml`: The default name for a helmfile is `helmfile.yaml`:
```yaml ```yaml
# Chart repositories used from within this state file # Chart repositories used from within this state file
@ -69,22 +69,28 @@ repositories:
# context: kube-context # this directive is deprecated, please consider using helmDefaults.kubeContext # context: kube-context # this directive is deprecated, please consider using helmDefaults.kubeContext
#default values to set for args along with dedicated keys that can be set by contributers, cli args take precedence over these # Default values to set for args along with dedicated keys that can be set by contributors, cli args take precedence over these.
# In other words, unset values results in no flags passed to helm.
# See the helm usage (helm SUBCOMMAND -h) for more info on default values when those flags aren't provided.
helmDefaults: helmDefaults:
tillerNamespace: tiller-namespace #dedicated default key for tiller-namespace tillerNamespace: tiller-namespace #dedicated default key for tiller-namespace
tillerless: false #dedicated default key for tillerless tillerless: false #dedicated default key for tillerless
kubeContext: kube-context #dedicated default key for kube-context (--kube-context) kubeContext: kube-context #dedicated default key for kube-context (--kube-context)
cleanupOnFail: false #dedicated default key for helm flag --cleanup-on-fail cleanupOnFail: false #dedicated default key for helm flag --cleanup-on-fail
# additional and global args passed to helm # additional and global args passed to helm (default "")
args: args:
- "--set k=v" - "--set k=v"
# defaults for verify, wait, force, timeout and recreatePods under releases[] # verify the chart before upgrading (only works with packaged charts not directories) (default false)
verify: true verify: true
# wait for k8s resources via --wait. (default false)
wait: true wait: true
# time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks, and waits on pod/pvc/svc/deployment readiness) (default 300)
timeout: 600 timeout: 600
# performs pods restart for the resource if applicable (default false)
recreatePods: true recreatePods: true
force: true # forces resource update through delete/recreate if needed (default false)
# enable TLS for request to Tiller force: false
# enable TLS for request to Tiller (default false)
tls: true tls: true
# path to TLS CA certificate file (default "$HELM_HOME/ca.pem") # path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
tlsCACert: "path/to/ca.pem" tlsCACert: "path/to/ca.pem"
@ -92,7 +98,7 @@ helmDefaults:
tlsCert: "path/to/cert.pem" tlsCert: "path/to/cert.pem"
# path to TLS key file (default "$HELM_HOME/key.pem") # path to TLS key file (default "$HELM_HOME/key.pem")
tlsKey: "path/to/key.pem" tlsKey: "path/to/key.pem"
# limit the maximum number of revisions saved per release. Use 0 for no limit (default 10) # limit the maximum number of revisions saved per release. Use 0 for no limit. (default 10)
historyMax: 10 historyMax: 10
# The desired states of Helm releases. # The desired states of Helm releases.
@ -102,7 +108,7 @@ releases:
# Published chart example # Published chart example
- name: vault # name of this release - name: vault # name of this release
namespace: vault # target namespace namespace: vault # target namespace
labels: # Arbitrary key value pairs for filtering releases labels: # Arbitrary key value pairs for filtering releases
foo: bar foo: bar
chart: roboll/vault-secret-manager # the chart being installed to create this release, referenced by `repository/chart` syntax chart: roboll/vault-secret-manager # the chart being installed to create this release, referenced by `repository/chart` syntax
version: ~1.24.1 # the semver of the chart. range constraint is supported version: ~1.24.1 # the semver of the chart. range constraint is supported
@ -146,27 +152,23 @@ releases:
# will attempt to decrypt it using helm-secrets plugin # will attempt to decrypt it using helm-secrets plugin
secrets: secrets:
- vault_secret.yaml - vault_secret.yaml
# verify the chart before upgrading (only works with packaged charts not directories) # Override helmDefaults options for verify, wait, timeout, recreatePods and force.
verify: true verify: true
# wait for k8s resources via --wait. Defaults to `false`
wait: true wait: true
# time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks, and waits on pod/pvc/svc/deployment readiness) (default 300)
timeout: 60 timeout: 60
# performs pods restart for the resource if applicable
recreatePods: true recreatePods: true
# forces resource update through delete/recreate if needed force: false
force: true # set `false` to uninstall this release on sync. (default true)
# set `false` to uninstall on sync
installed: true installed: true
# restores previous state in case of failed release # restores previous state in case of failed release (default false)
atomic: true atomic: true
# when true, cleans up any new resources created during a failed release # when true, cleans up any new resources created during a failed release (default false)
cleanupOnFail: false cleanupOnFail: false
# name of the tiller namespace # name of the tiller namespace (default "")
tillerNamespace: vault tillerNamespace: vault
# if true, will use the helm-tiller plugin # if true, will use the helm-tiller plugin (default false)
tillerless: false tillerless: false
# enable TLS for request to Tiller # enable TLS for request to Tiller (default false)
tls: true tls: true
# path to TLS CA certificate file (default "$HELM_HOME/ca.pem") # path to TLS CA certificate file (default "$HELM_HOME/ca.pem")
tlsCACert: "path/to/ca.pem" tlsCACert: "path/to/ca.pem"
@ -177,6 +179,7 @@ releases:
# --kube-context to be passed to helm commands # --kube-context to be passed to helm commands
# CAUTION: this doesn't work as expected for `tilerless: true`. # CAUTION: this doesn't work as expected for `tilerless: true`.
# See https://github.com/roboll/helmfile/issues/642 # See https://github.com/roboll/helmfile/issues/642
# (default "", which means the standard kubeconfig, either ~/kubeconfig or the file pointed by $KUBECONFIG environment variable)
kubeContext: kube-context kubeContext: kube-context
# limit the maximum number of revisions saved per release. Use 0 for no limit (default 10) # limit the maximum number of revisions saved per release. Use 0 for no limit (default 10)
historyMax: 10 historyMax: 10