CheatPress

Flux CLI GitOps for Kubernetes

Version 2.9 · source

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

Start here

flux check --pre
Check cluster prerequisites
flux bootstrap github --owner=<org> --repository=<repo> --path=<dir>
Install Flux, wire to Git
flux get all -A
Status of everything
flux reconcile kustomization <name> --with-source
Sync now
flux diff kustomization <name> --path <dir>
Preview local changes
flux logs -A --level=error
Controller errors
flux events --for Kustomization/<name>
Why it is not ready
flux suspend kustomization <name>
Pause reconciling

Concepts

  1. Source GitRepository, OCI, HelmRepository
  2. Kustomization / HelmRelease what to apply, how often
  3. Cluster live objects, drift corrected

Install & Bootstrap

flux check --pre
Check cluster meets prerequisites
flux bootstrap github --owner=<org> --repository=<repo> --path=<dir>
Install Flux and sync from GitHub
Needs GITHUB_TOKEN exported. Re-running is safe and upgrades the controllers.
flux check
Verify controllers are healthy

Inspect

flux get all
Everything in one namespace
flux get all -A
Everything in all namespaces
flux get kustomizations
List Kustomizations and readiness
flux get helmreleases -A
List Helm releases
flux get all -A --status-selector ready=false
Only the broken ones

Reconcile & Suspend

flux reconcile kustomization <name>
Apply now, skip the interval
flux reconcile kustomization <name> --with-source
Refetch source, then apply
flux reconcile helmrelease <name>
Re-run a Helm release
flux suspend kustomization <name>
Pause one Kustomization
Suspended objects keep their resources but stop being corrected.
flux resume kustomization <name>
Resume and reconcile
flux suspend helmrelease <name>
Pause a Helm release
flux resume helmrelease <name>
Resume a Helm release

Create Resources

flux create source git <name> --url=<url> --branch=<b>
Define a Git source
flux create kustomization <name> --source=<src> --path=<dir> --prune
Apply a path from a source
flux create helmrelease <name> --source=HelmRepository/<repo> --chart=<chart>
Install a chart
flux create helmrelease <name> ... --values=<file>
Pass local values files
flux create helmrelease <name> ... --create-target-namespace
Install into a new namespace
flux create secret git <name> --url=ssh://git@<host>/<repo>
Generate an SSH deploy key secret
Prints the public key; add it to the repository as a deploy key.
flux create source git <name> ... --export > <file>.yaml
Write YAML instead of applying
--export works on every create command and is the way to put the result into Git.
flux export kustomization --all
Dump all Kustomizations as YAML

Debug

flux logs -A
Controller logs, all namespaces
flux logs -A --level=error
Only errors
flux logs --kind=Kustomization --name=<name>
Logs for one object
flux events
Events for Flux objects
flux events --for Kustomization/<name>
Events for one object
flux trace <kind> <name> -n <ns>
Which source manages an object
flux debug kustomization <name> --show-vars
Post-build substitution variables
Output can contain secret values.

Build & Diff

flux diff kustomization <name> --path <dir>
Local changes vs the cluster
Exit code 1 means differences, above 1 means error; usable in CI.
flux diff kustomization <name> --path <dir> --recursive
Diff nested Kustomizations

Global Flags

--context <name> / --kubeconfig <file>
Choose cluster or kubeconfig
-n <ns> / -A
Namespace or all namespaces
--timeout <dur>
Operation timeout (default 5m)
--export
Print YAML instead of applying

Recipes

Bootstrap a cluster
export GITHUB_TOKEN=<token>flux check --preflux bootstrap github --owner=<org> --repository=<repo> \  --path=clusters/prod --personal=falseflux get all -A
Deploy an app from Git
flux create source git podinfo --url=https://github.com/<org>/podinfo \  --branch=main --export > clusters/prod/podinfo-source.yamlflux create kustomization podinfo --source=GitRepository/podinfo \  --path=./kustomize --prune=true --interval=5m \  --export > clusters/prod/podinfo-ks.yamlgit add . && git commit -m 'Add podinfo' && git push
Why is it not ready
flux get all -A --status-selector ready=falseflux events --for Kustomization/<name>flux logs --kind=Kustomization --name=<name> --level=errorflux reconcile kustomization <name> --with-source