Go to file
Hidde Beydals 56024de6cc Delete generated docs before regenerating them
This ensures no stray files are kept when for example a command name
changes.

Signed-off-by: Hidde Beydals <hello@hidde.co>
.github/workflows Rename `gotk` binary to `flux`
cmd/flux Change `fluxcd/toolkit` to `fluxcd/flux2`
docs Change `fluxcd/toolkit` to `fluxcd/flux2`
install Change `fluxcd/toolkit` to `fluxcd/flux2`
internal Change `fluxcd/toolkit` to `fluxcd/flux2`
manifests Incorporate name and metric changes in Grafana cfg
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 Change `fluxcd/toolkit` to `fluxcd/flux2`
DCO Add coc, dco and maintainers docs
LICENSE Initial commit
MAINTAINERS Add coc, dco and maintainers docs
Makefile Delete generated docs before regenerating them
README.md Remove Flux CLI from Toolkit component overview
go.mod Change `fluxcd/toolkit` to `fluxcd/flux2`
go.sum Update toolkit components
mkdocs.yml Remove Flux CLI from Toolkit component overview

README.md

Flux version 2

e2e report license release overview

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 tap fluxcd/tap
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.

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

Components

Community

The GitOps Toolkit 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 Meetups

We are looking forward to seeing you with us!