flux
TLDR
Bootstrap Flux on a Kubernetes cluster with GitHub
SYNOPSIS
flux [COMMAND] [FLAGS]
DESCRIPTION
Flux is a GitOps continuous delivery tool for Kubernetes. It automatically synchronizes cluster state with configuration stored in Git repositories, ensuring that the live cluster matches the desired state defined in version control.
Flux monitors Git repositories, Helm repositories, and OCI registries for changes. When updates are detected, it applies them to the cluster automatically. This enables declarative, auditable infrastructure management following GitOps principles.
The flux CLI bootstraps Flux components into a cluster and provides management commands for sources, kustomizations, and Helm releases. Flux uses Kubernetes custom resources to define what to sync and how.
PARAMETERS
--kubeconfig FILE
Path to kubeconfig file.-n, --namespace NAMESPACE
Namespace for CLI operations (default: flux-system).--context CONTEXT
Kubernetes context to use.--timeout DURATION
Timeout for operations.-v, --verbose
Enable verbose output.-h, --help
Display help for command.
COMMANDS
bootstrap PROVIDER
Deploy Flux on a cluster the GitOps way (github, gitlab, bitbucket).check
Check prerequisites and component status.install
Install Flux components without GitOps bootstrap.uninstall
Uninstall Flux components from cluster.get RESOURCE
Get status of Flux resources (sources, kustomizations, helmreleases).reconcile RESOURCE NAME
Trigger reconciliation of a resource.suspend RESOURCE NAME
Suspend reconciliation of a resource.resume RESOURCE NAME
Resume reconciliation of a resource.export RESOURCE
Export resources to YAML manifests.create RESOURCE
Create Flux resources.delete RESOURCE
Delete Flux resources.logs
Display logs from Flux controllers.
CAVEATS
Requires kubectl configured with cluster access. Bootstrap creates resources in the flux-system namespace by default. Git repository access requires appropriate credentials or SSH keys. Flux components run as controllers in the cluster and require sufficient RBAC permissions.
HISTORY
Flux was originally created by Weaveworks in 2016 as one of the first GitOps tools for Kubernetes. Flux v2 was released in 2020 as a complete rewrite using the GitOps Toolkit, providing a more modular and extensible architecture. Flux became a CNCF Graduated project in 2022, reflecting its maturity and wide adoption in the cloud-native ecosystem.


