Open and extensible continuous delivery solution for Kubernetes. Powered by GitOps Toolkit.
Find a file
Stefan Prodan edf2f51aa1
Merge pull request #385 from fluxcd/readme-flux2
Minimal rewrite of README to explain Flux v2
2020-10-29 16:45:26 +02:00
.github/workflows Remove documentation version hotfix 2020-10-16 22:19:58 +02:00
cmd/gotk Refactor manifests generation 2020-10-29 10:15:53 +02:00
docs Refactor manifest generation 2020-10-28 16:01:43 +01:00
install Add ARM64 to install docs and script 2020-09-04 15:10:42 +03:00
internal Change copyright to Flux authors 2020-10-27 18:59:01 +02:00
manifests Update toolkit components 2020-10-29 13:14:48 +00:00
mkdocs Add metadata to docs website 2020-06-26 16:41:04 +03:00
pkg Refactor manifests generation 2020-10-29 10:15:53 +02:00
.gitignore Publish manifests as release assets 2020-07-17 12:00:15 +03:00
.goreleaser.yml change the windows binary release format to .zip 2020-10-27 23:24:28 +07:00
CODE_OF_CONDUCT.md Add coc, dco and maintainers docs 2020-04-30 17:25:22 +03:00
CONTRIBUTING.md Add community section to README.md 2020-09-23 10:07:47 +02:00
DCO Add coc, dco and maintainers docs 2020-04-30 17:25:22 +03:00
go.mod Update toolkit components 2020-10-29 13:14:48 +00:00
go.sum Update toolkit components 2020-10-29 13:14:48 +00:00
LICENSE Initial commit 2020-04-24 12:38:22 +03:00
MAINTAINERS Add coc, dco and maintainers docs 2020-04-30 17:25:22 +03:00
Makefile Rename tk binary to gotk 2020-09-01 11:33:49 +02:00
mkdocs.yml Add monitoring guide 2020-10-21 10:09:28 +03:00
README.md Minimal rewrite of README to explain Flux v2 2020-10-29 16:38:05 +02:00

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.

gotk installation

With Homebrew:

brew tap fluxcd/tap
brew install gotk

With Bash:

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

# enable completions in ~/.bash_profile
. <(gotk 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:

gotk 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!