You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
flux2/docs/index.md

5.0 KiB

Flux v2

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

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

Flux v2 is constructed with the GitOps Toolkit, a set of composable APIs and specialized tools for building Continuous Delivery on top of Kubernetes.

overview

Target features:

  • Source management
  • Kustomize and Helm support
  • Event-based and on-a-schedule reconciliation
  • Role-based reconciliation (multi-tenancy)
  • Health assessment (clusters and workloads)
  • Dependency management (infra and workloads)
  • Alerting to external systems (webhook senders)
  • External events handling (webhook receivers)
  • Source write-back (automated patching)
  • Policy driven validation (OPA, admission controllers)
  • Seamless integration with Git providers (GitHub, GitLab, Bitbucket)
  • Interoperability with workflow providers (GitHub Actions, Tekton, Argo)
  • Interoperability with CAPI providers

GitOps Toolkit

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

You can use the toolkit to extend Flux, or to build your own systems for continuous delivery -- see the developer guides.

Components:

Get Started

!!!hint "Get started with Flux v2!" Following this guide will just take a couple of minutes to complete: After installing the flux CLI and running a couple of very simple commands, you will have a GitOps workflow setup which involves a staging and a production cluster.

Community

The Flux project is always looking for new contributors and there are a multitude of ways to get involved. Depending on what you want to do, some of the following bits might be your first steps:

Upcoming Events

We are looking forward to seeing you with us!