Repository files navigation

Flux is a tool for keeping Kubernetes clusters in sync with sources ofconfiguration (like Git repositories and OCI artifacts),and automating updates to configuration when there is new code to deploy.

Flux version 2 ("v2") is built from the ground up to use Kubernetes'API extension system, and to integrate with Prometheus and other corecomponents of the Kubernetes ecosystem. In version 2, Flux supportsmulti-tenancy and support for syncing an arbitrary number of Gitrepositories, among other long-requested features.

Flux v2 is constructed with theGitOps Toolkit, aset of composable APIs and specialized tools for building ContinuousDelivery on top of Kubernetes.

Flux is a Cloud Native Computing Foundation (CNCF) graduated project, used inproduction by variousorganisations andcloud providers.

To get started check out thisguideon how to bootstrap Flux on Kubernetes and deploy a sample application in a GitOps manner.

For more comprehensive documentation, see the following guides:

• Ways of structuring your repositories
• Manage Helm Releases
• Automate image updates to Git
• Manage Kubernetes secrets with Flux and SOPS

If you need help, please refer to ourSupport page.

The GitOps Toolkit is the set of APIs and controllers that make up theruntime for Flux v2. The APIs comprise Kubernetes custom resources,which can be created and updated by a cluster user, or by otherautomation tooling.

You can use the toolkit to extend Flux, or to build your own systemsfor continuous delivery -- seethe developerguides.

• Source Controller
  • GitRepository CRD
  • OCIRepository CRD
  • HelmRepository CRD
  • HelmChart CRD
  • Bucket CRD
• Kustomize Controller
  • Kustomization CRD
• Helm Controller
  • HelmRelease CRD
• Notification Controller
  • Provider CRD
  • Alert CRD
  • Receiver CRD
• Image Automation Controllers
  • ImageRepository CRD
  • ImagePolicy CRD
  • ImageUpdateAutomation CRD

Need help or want to contribute? Please see the links below. The Flux project is always looking fornew contributors and there are a multitude of ways to get involved.

• Getting Started?
  • Look at ourGet Started guide and give us feedback
• Need help?
  • First: Ask questions on ourGH Discussions page.
  • Second: Talk to us in the #flux channel onCNCF Slack.
  • Please follow ourSupport Guidelines(in short: be nice, be respectful of volunteers' time, understand that maintainers andcontributors cannot respond to all DMs, and keep discussions in the public #flux channel as much as possible).
• Have feature proposals or want to contribute?
  • Propose features on ourGitHub Discussions page.
  • Join our upcoming dev meetings (meeting access and agenda).
  • Join the flux-dev mailing list.
  • Check outhow to contribute to the project.
  • Check out theproject roadmap.

Check out ourevents calendar,both with upcoming talks, events and meetings you can attend.Or view theresources sectionwith past events videos you can watch.

We look forward to seeing you with us!