GitOps for k8s
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Hidde Beydals 9debcc7240
Merge pull request #3335 from mewzherder/patch-2
5 hours ago
.circleci Update Go to v1.15.2 3 weeks ago
.github Use fossa-contrib/fossa-action instead 4 days ago
bin Update location of kubeyaml image 4 months ago
chart Release Helm chart v1.5.0 2 months ago
cmd Adjust the expected string 6 months ago
deploy Bump version in fluxctl install and chart 2 months ago
docker Update kustomize to v3.8.4 3 weeks ago
docs Update git-gpg.md 1 week ago
internal fix some links 6 months ago
pkg Bump version in fluxctl install and chart 2 months ago
snap exclude chart releases 1 month ago
test/e2e ci: run e2e tests in GitHub Actions 6 months ago
.gitignore move to mkdocs 6 months ago
.readthedocs.yml move to mkdocs 6 months ago
CHANGELOG.md Revert changelog item 2 months ago
CODE_OF_CONDUCT.md Move code of conduct into its own file. 2 years ago
CONTRIBUTING.md document previous meetings, they're on pause for now 6 months ago
DCO docs: steal CONTRIBUTING.md and DCO docs from scope, modify slightly 2 years ago
LICENSE Initial commit 4 years ago
MAINTAINERS Move Fons to maintainer emeritus 2 weeks ago
Makefile Get shellcheck from new URL 2 months ago
README.md Update next GitOps Days Community Ed talk date and link 6 hours ago
go.mod Update Go to v1.15.2 3 weeks ago
go.sum Update sops to v3.6.0 2 months ago
mkdocs.yml add social links to the footer 4 months ago
tools.go Remove explicit dependency of vfsgen 8 months ago

README.md

Flux

On Flux v2 In an announcement in August 2019, the expectation was set that the Flux project would integrate the GitOps Engine, then being factored out of ArgoCD. Since the result would be backward-incompatible, it would require a major version bump: Flux v2.

After experimentation and considerable thought, we (the maintainers) have found a path to Flux v2 that we think better serves our vision of GitOps: the GitOps Toolkit. In consequence, we do not now plan to integrate GitOps Engine into Flux.

:warning: This also means that Flux v1 is in maintenance mode.

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|Apester APPUiO|ArangoDB Oasis|Avisi B3i|Babylon Health|Belvo bimspot|Bink|BlaBlaCar blackmirror media|Canva|Carrot Chattigo|Cloudlets|Cloudogu GmbH CLVR Cloud Ltd|College of William & Mary|Consorcio Chile| Control Plane|CrowdRiff|Cybrary Duedil|Enliven Systems|FELFEL FireHydrant|Frame.io|gastromatic Gini|Greenpass|happn 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 Quivr|Rakuten|RentPath Replicated|Resulta|Rungway Sage AI Labs|Sngular|Starbucks SupplyStack|Talend|Troii UK Hydrographic Office|Under Armour|VSHN Walmart Chile|Weave Cloud|Wildlife Studios Workable|Workarea|Working Group Two Yad2|Yusofleet|Zaaksysteem Zwift||

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

Reminder that Flux v1 is in maintenance mode. If you have any questions about Flux v2 and future migrations, these are the best ways to stay informed:

If you have further questions about Flux or continuous delivery:

Your feedback is always welcome!