Go to file
Hidde Beydals 6a7f1e7d48
Merge pull request from fluxcd/tag-filter
.github Add e2e tests for image repository and policy
action docs: 'like so' -> 'as in the following example'
cmd/flux Add image tags regex filter arg to policy command
docs Add image tags regex filter arg to policy command
install Configure `project_name` for GoReleaser
internal check for multiple files in KUBECONFIG variable
manifests Update toolkit components
mkdocs Add metadata to docs website
pkg Deprecate arch flags in favor of multi-arch images
.gitignore Publish manifests as release assets
.goreleaser.yml Configure `project_name` for GoReleaser
CODE_OF_CONDUCT.md Add coc, dco and maintainers docs
CONTRIBUTING.md Add DCO signoff ref to contributing doc
DCO Add coc, dco and maintainers docs
LICENSE Initial commit
MAINTAINERS Add Philip Laine to maintainer list
Makefile Delete generated docs before regenerating them
README.md Added Jan 25 Meetup to Upcoming Events section
go.mod Update toolkit components
go.sum Update toolkit components
mkdocs.yml Add create secret helm command

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)

Arch Linux (AUR) packages:

  • flux-bin: install the latest stable version using a pre-build binary (recommended)
  • flux-go: build the latest stable version from source code
  • flux-scm: build the latest (unstable) version from source code from our git main branch

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 look forward to seeing you with us!