Flux CD

Bootstrap

Initialize Flux on cluster

Sources

Git, Helm, OCI sources

Kustomizations

Deploy with Kustomize

Helm Releases

Manage Helm deployments

Image Automation

Auto-update images

Notifications

Alerts & providers

Debugging

Troubleshoot Flux

Install Flux CLI (macOS)

$ brew install fluxcd/tap/flux

Install Flux CLI using Homebrew on macOS

Check prerequisites

$ flux check --pre

Verify cluster meets Flux requirements

Bootstrap Flux with GitHub

$ flux bootstrap github --owner=<user> --repository=<repo> --path=clusters/my-cluster

Bootstrap Flux on a cluster using a GitHub repository

Bootstrap GitHub

$ flux bootstrap github --owner=myorg --repository=fleet-infra --path=clusters/prod --personal

Bootstrap Flux on a cluster with a GitHub repository.

Bootstrap GitLab

$ flux bootstrap gitlab --owner=mygroup --repository=fleet-infra --path=clusters/prod

Bootstrap Flux on a cluster with a GitLab repository.

Check prerequisites

$ flux check --pre

Check cluster prerequisites before bootstrap.

Verify installation

$ flux check

Verify Flux components are running correctly.

Uninstall Flux

$ flux uninstall --namespace=flux-system

Remove Flux components from cluster.

Create Git source

$ flux create source git podinfo --url=https://github.com/stefanprodan/podinfo --branch=master --interval=1m

Create a GitRepository source.

Create Helm repository

$ flux create source helm bitnami --url=https://charts.bitnami.com/bitnami --interval=1h

Create a HelmRepository source.

List sources

$ flux get sources all

List all Flux sources.

Reconcile source

$ flux reconcile source git flux-system

Trigger immediate reconciliation of a source.

Create OCI source

$ flux create source oci podinfo --url=oci://ghcr.io/stefanprodan/manifests/podinfo --tag=latest

Create an OCI artifact source.

Create Kustomization

$ flux create kustomization podinfo --source=GitRepository/podinfo --path=./kustomize --prune=true --interval=10m

Create a Kustomization to deploy from source.

List Kustomizations

$ flux get kustomizations

List all Kustomizations.

Reconcile Kustomization

$ flux reconcile kustomization podinfo --with-source

Reconcile Kustomization and its source.

Suspend Kustomization

$ flux suspend kustomization podinfo

Pause reconciliation of a Kustomization.

Resume Kustomization

$ flux resume kustomization podinfo

Resume reconciliation of a Kustomization.

Create HelmRelease

$ flux create helmrelease nginx --source=HelmRepository/bitnami --chart=nginx --interval=1h

Create a HelmRelease from repository.

List HelmReleases

$ flux get helmreleases

List all HelmReleases.

Reconcile HelmRelease

$ flux reconcile helmrelease nginx --with-source

Reconcile HelmRelease and source.

Export HelmRelease

$ flux export helmrelease nginx > nginx-helmrelease.yaml

Export HelmRelease to YAML.

Create image repository

$ flux create image repository podinfo --image=ghcr.io/stefanprodan/podinfo --interval=5m

Create ImageRepository to scan registry.

Create image policy

$ flux create image policy podinfo --image-ref=podinfo --select-semver='>=1.0.0'

Create ImagePolicy for version selection.

Create image update

$ flux create image update flux-system --git-repo-ref=flux-system --git-repo-path=./clusters/prod

Create ImageUpdateAutomation.

Get image policies

$ flux get images all

List all image automation resources.

Create Slack provider

$ flux create alert-provider slack --type=slack --secret-ref=slack-webhook

Create notification provider for Slack.

Create alert

$ flux create alert slack-alert --provider-ref=slack --event-sources='Kustomization/*'

Create alert for Kustomization events.

List alerts

$ flux get alerts

List all configured alerts.

View Flux logs

$ flux logs --all-namespaces

View logs from all Flux controllers.

Trace Kustomization

$ flux trace kustomization podinfo

Trace resource reconciliation.

Get events

$ flux events

List recent Flux events.

Debug HelmRelease

$ flux logs --kind=HelmRelease --name=nginx

View logs for specific HelmRelease.

Get all resources

$ flux get all --all-namespaces

List all Flux resources cluster-wide.

Discussion

Loading comments...

Flux CD

GitOps continuous delivery for Kubernetes. Sync clusters with Git repositories and automate deployments.

34 commands

Browse by Topic

Getting Started

Quick setup and installation

Bootstrap

Initialize Flux on cluster

Sources

Git, Helm, OCI sources

Kustomizations

Deploy with Kustomize

Helm Releases

Manage Helm deployments

Image Automation

Auto-update images

Notifications

Alerts & providers

Debugging

Troubleshoot Flux