Skip to content
The GitOps Kubernetes operator
Go Shell Other
Branch: master
Clone or download

Latest commit

squaremo Merge pull request #3079 from jaydeland/patch-1
Parameter name was incorrect
Latest commit aca9871 May 26, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci ci: disable unit tests in CircleCI Mar 27, 2020
.github exclude man7.org (self-signed cert) from being checked, point to https May 26, 2020
bin Upgrade `kubeyaml` to `0.7.0` Aug 15, 2019
chart Support annotations in secret May 13, 2020
cmd Adjust the expected string Apr 14, 2020
deploy Bump version in install template and chart Apr 2, 2020
docker Update kubectl to 1.17.4 Apr 7, 2020
docs Merge pull request #3079 from jaydeland/patch-1 May 26, 2020
internal fix some links Apr 1, 2020
pkg Fix comment of tests in sync_test.go May 25, 2020
snap snap: fix sorting of git tags Jan 21, 2020
test/e2e ci: run e2e tests in GitHub Actions Mar 27, 2020
.gitignore move to mkdocs Mar 27, 2020
.readthedocs.yml move to mkdocs Mar 27, 2020
CHANGELOG.md Update CHANGELOG for 1.19.0 Apr 2, 2020
CODE_OF_CONDUCT.md Move code of conduct into its own file. Sep 21, 2018
CONTRIBUTING.md document previous meetings, they're on pause for now Apr 15, 2020
DCO docs: steal CONTRIBUTING.md and DCO docs from scope, modify slightly Aug 28, 2018
LICENSE Initial commit Jul 7, 2016
MAINTAINERS Acknowledge ex-maintainers in MAINTAINERS Apr 2, 2020
Makefile ci: run e2e tests in GitHub Actions Mar 27, 2020
README.md Merge branch 'master' into master May 25, 2020
go.mod Support completion for fish Apr 14, 2020
go.sum Support completion for fish Apr 14, 2020
mkdocs.yml Amend wording in the guides section (Using/Use) for consistency May 12, 2020
tools.go Remove explicit dependency of vfsgen Jan 26, 2020

README.md

Flux

Announcement Flux has joined CNCF as a sandbox project

We believe in GitOps:

  • You declaratively describe the entire desired state of your system in git. This includes the apps, config, dashboards, monitoring and everything else.
  • What can be described can be automated. Use YAMLs to enforce conformance of the system. You don't need to run kubectl, all changes go through git. Use diff tools to detect divergence between observed and desired state and get notifications.
  • You push code not containers. Everything is controlled through pull requests. There is no learning curve for new devs, they just use your standard git PR process. The history in git allows you to recover from any snapshot as you have a sequence of transactions. It is much more transparent to make operational changes by pull request, e.g. fix a production issue via a pull request instead of making changes to the running system.

Flux is a tool that automatically ensures that the state of a cluster matches the config in git. It uses an operator in the cluster to trigger deployments inside Kubernetes, which means you don't need a separate CD tool. It monitors all relevant image repositories, detects new images, triggers deployments and updates the desired running configuration based on that (and a configurable policy).

The benefits are: you don't need to grant your CI access to the cluster, every change is atomic and transactional, git has your audit log. Each transaction either fails or succeeds cleanly. You're entirely code centric and don't need new infrastructure.

Deployment Pipeline

CircleCI GoDoc Documentation

What Flux does

Flux is most useful when used as a deployment tool at the end of a Continuous Delivery pipeline. Flux will make sure that your new container images and config changes are propagated to the cluster.

Who is using Flux in production

ABA English Alea Play Solutions APPUiO
Apester ArangoDB Oasis Avisi
B3i Babylon Health bimspot
BlaBlaCar blackmirror media Canva
Chattigo Cloudlets CLVR Cloud Ltd
College of William & Mary Control Plane Consorcio Chile
CrowdRiff Cybrary FireHydrant
gastromatic Gini Greenpass
HMCTS IBM Cloudant Improwised Technologies
Infabode iQmetrix karriere tutor GmbH
Limejump loveholidays LUNAR
MediaMarktSaturn Mettle Mintel
Multicaja S.A Okteto Cloud Omise
Payout Qordoba Rakuten
Replicated Resulta Rungway
Sage AI Labs Starbucks Troii
UK Hydrographic Office Under Armour VSHN
Weave Cloud Workable Workarea
Working Group Two Yusofleet Yad2
Zaaksysteem

If you too are using Flux in production; please submit a PR to add your organization to the list!

History

In the first years of its existence, the development of Flux was very closely coupled to that of Weave Cloud. Over the years the community around Flux grew, the numbers of integrations grew and the team started the process of generalising the code, so that more projects could easily integrate.

Get started with Flux

With the following tutorials:

or just browse through the documentation.

Do you want to release your Helm charts in a declarative way? Take a look at the fluxcd/helm-operator.

Integrations

As Flux is Open Source, integrations are very straight-forward. Here are a few popular ones you might want to check out:

Community & Developer information

We welcome all kinds of contributions to Flux, be it code, issues you found, documentation, external tools, help and support or anything else really.

The Flux project adheres to the CNCF Code of Conduct.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a Flux project maintainer, or the CNCF mediator, Mishi Choudhary mishi@linux.com.

To familiarise yourself with the project and how things work, you might be interested in the following:

Getting Help

If you have any questions about Flux and continuous delivery:

Your feedback is always welcome!

You can’t perform that action at this time.