Skip to content
This repository has been archived by the owner on Nov 7, 2024. It is now read-only.

G-Research/flux

 
 

Repository files navigation

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 Bink
bimspot BlaBlaCar blackmirror media
Canva Chattigo Cloudlets
Cloudogu GmbH CLVR Cloud Ltd College of William & Mary
Control Plane Consorcio Chile CrowdRiff
Cybrary FireHydrant Frame.io
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 Plex Systems Qordoba
Rakuten RentPath Replicated
Resulta Rungway Sage AI Labs
Starbucks Troii UK Hydrographic Office
Under Armour VSHN Walmart Chile
Weave Cloud Workable Workarea
Working Group Two Yad2 Yusofleet
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 [email protected].

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!

Packages

 
 
 

Languages

  • Go 93.5%
  • Shell 5.1%
  • Other 1.4%