Go to file
Stefan Prodan c2967240bb
Merge pull request from mewzherder/patch-6
Update Upcoming events w/ Nov 30 talk
.github/workflows Update engineerd/setup-kind to v0.5.0
action Add GitHub Action for Flux CLI
cmd/flux Add values-from arg to create helmrelease cmd
docs Update docs/guides/flux-v1-migration.md
install Fix install script
internal Add values-from arg to create helmrelease cmd
manifests Update toolkit components
mkdocs Add metadata to docs website
pkg Change `fluxcd/toolkit` to `fluxcd/flux2`
.gitignore Publish manifests as release assets
.goreleaser.yml Rename `gotk` binary to `flux`
CODE_OF_CONDUCT.md Add coc, dco and maintainers docs
CONTRIBUTING.md Replace GitOps Toolkit in docs
DCO Add coc, dco and maintainers docs
LICENSE Initial commit
MAINTAINERS Add @relu to maintainers list
Makefile Delete generated docs before regenerating them
README.md Update Upcoming events w/ Nov 30 talk
go.mod Refactor to adopt k8s standardized Condition type
go.sum Refactor to adopt k8s standardized Condition type
mkdocs.yml Rename migration menu items

README.md

Flux version 2

e2e report license release

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 ("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.

Flux installation

With Homebrew:

brew install fluxcd/tap/flux

With Bash:

curl -s https://toolkit.fluxcd.io/install.sh | sudo bash

# enable completions in ~/.bash_profile
. <(flux completion bash)

Binaries for macOS, Windows and Linux AMD64/ARM are available to download on the release page.

Verify that your cluster satisfies the prerequisites with:

flux check --pre

Get started

To get started with Flux, start browsing the documentation or get started with one of the following guides:

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.

overview

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

Components

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!