CheatPress

Helmfile Declarative Helm releases

Version 1.1 · source

Helmfile, Postcard, light preview Light · Postcard 102 × 152 mm · PDF Helmfile, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF Helmfile, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
Helmfile, A5, light preview Light · A5 148 × 210 mm · PDF Helmfile, A5, dark preview Dark · A5 148 × 210 mm · PDF Helmfile, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
Helmfile, A4, light preview Light · A4 210 × 297 mm · PDF Helmfile, A4, dark preview Dark · A4 210 × 297 mm · PDF Helmfile, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
Helmfile, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF Helmfile, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF Helmfile, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
Helmfile, A3, light preview Light · A3 297 × 420 mm · PDF Helmfile, A3, dark preview Dark · A3 297 × 420 mm · PDF Helmfile, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
Helmfile, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF Helmfile, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF Helmfile, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
Helmfile, Letter, light preview Light · Letter 8.5 × 11 in · PDF Helmfile, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF Helmfile, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
Helmfile, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF Helmfile, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF Helmfile, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

helmfile init
Check helm and plugins
helmfile repos
Add chart repositories
helmfile diff
Preview changes
helmfile apply
Deploy what changed
helmfile sync
Sync all releases
helmfile -e <env> apply
Pick an environment
helmfile -l <key>=<val> apply
Only matching releases
helmfile destroy
Remove all releases

Concepts

  1. helmfile.yaml desired state
  2. Helm releases charts + values
  3. Cluster kube-context

Project

helmfile init
Check helm and install plugins
helmfile create <name>
Scaffold a project layout
helmfile version
Print the Helmfile version
helmfile repos
Add the repositories from the file
helmfile deps
Update chart deps and lock files
helmfile list
List releases in the state file
helmfile list --output json
List releases as JSON
helmfile show-dag
Show deployment order
helmfile lint
Run helm lint on the charts
helmfile completion <shell>
Generate shell completion

Deploy

helmfile diff
Show pending changes
helmfile apply
Diff, then sync only if changed
helmfile apply -i
Confirm before changing the cluster
helmfile sync
Upgrade --install every release
helmfile sync --wait --timeout <sec>
Wait until resources are ready
helmfile diff --skip-diff-on-install
Skip the diff for new releases
helmfile template
Render manifests locally
helmfile destroy
Uninstall and purge releases
helmfile status
Run helm status per release
helmfile test
Run helm test on releases
helmfile write-values
Write values files per release
helmfile fetch --output-dir <dir>
Download charts for inspection
helmfile apply --skip-deps
Skip repo update and dep build

Targeting

helmfile -f <file or dir> <cmd>
Use another helmfile or directory
helmfile -e <env> <cmd>
Choose environment (default: default)
helmfile -l name=<release> <cmd>
Select one release
helmfile -l <key>=<val>,<key2>=<val2> <cmd>
Labels must all match (AND)
helmfile -l <k>=<a> -l <k>=<b> <cmd>
Repeated selectors match any (OR)
helmfile -l <key>!=<val> <cmd>
Exclude by label
helmfile -l namespace=<ns> <cmd>
Select by namespace
helmfile -l chart=<chart> <cmd>
Select by chart name
helmfile -l dir=<path> <cmd>
Select by defining directory
helmfile --allow-no-matching-release <cmd>
No error if nothing matches
helmfile -n <ns> <cmd>
Set the namespace
helmfile --kube-context <ctx> <cmd>
Use a kubectl context
helmfile --kubeconfig <file> <cmd>
Use a kubeconfig file

State values & output

helmfile --state-values-set <key>=<val> <cmd>
Override a state value
helmfile --state-values-file <file> <cmd>
Load state values from a file
helmfile print-env
Show parsed environment and values
helmfile build
Print the fully rendered state
helmfile --debug <cmd>
Verbose helm output
helmfile -q <cmd>
Only warnings and errors
helmfile --no-color <cmd>
Plain output for CI
helmfile -f - <cmd>
Read the helmfile from stdin
helmfile -b <path> <cmd>
Use a specific helm binary
helmfile cache cleanup
Remove cached files

helmfile.yaml

Minimal file
repositories:  - name: bitnami    url: https://charts.bitnami.com/bitnami---releases:  - name: cache    namespace: data    chart: bitnami/redis    version: <x.y.z>    values:      - values/redis.yaml
Environments
environments:  default:    values: [env/default.yaml]  production:    values: [env/production.yaml]---# in releases:  installed: {{ eq .Environment.Name "production" | toYaml }}
Defaults for all releases
helmDefaults:  wait: true  timeout: 600  createNamespace: true  historyMax: 10
Dependencies and toggles
releases:  - name: app    chart: ./charts/app    needs: [data/cache]    condition: app.enabled    labels: {tier: web}
Hooks
hooks:  - events: ["presync"]    showlogs: true    command: ./check.sh  - events: ["postsync"]    kubectlApply: {filename: extra.yaml}
Split across files
bases:  - environments.yamlhelmfiles:  - path: apps/*/helmfile.yaml    missingFileHandler: Warn
Hook events
Event Runs
prepare after a release is loaded
presync before install or upgrade
postsync after install or upgrade
preuninstall before uninstall
postuninstall after uninstall
cleanup after each release

Recipes

Review then ship
helmfile -e staging diffhelmfile -e staging apply -i
Target one release
helmfile -e production -l name=<release> diffhelmfile -e production -l name=<release> apply
Debug the rendered output
helmfile -e <env> template > out.yamlhelmfile -e <env> buildhelmfile show-dag
Bootstrap a project
helmfile create <name>cd <name> && helmfile inithelmfile repos && helmfile diff