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.
Michael Bridgen 7ed5de43c4
Merge pull request #2527 from beautytiger/dev-191017-trimfix
1 month ago
.circleci Republish release tag with v prefix 2 months ago
.github Add short quality checklist to pull request templ 2 months ago
bin Upgrade `kubeyaml` to `0.7.0` 3 months ago
chart Add Helm Operator v0.10 deprecation notice 2 months ago
cmd De-experimental-ise manifest generation 2 months ago
deploy Bump version in chart and deployment to `1.15.0` 2 months ago
docker Update kubectl to 1.14.7 and kustomize to 3.2.0 2 months ago
docs Docs: fix namespace in `kubectl logs` example 1 month ago
integrations Move Flux packages to pkg dir 2 months ago
internal_docs Fixed broken URLs and mentions of old organization 3 months ago
pkg fix string trim func in findErrorMessage func 1 month ago
snap Build: upgrade Go to `1.13.1` 2 months ago
test Update e2e Kind to 0.5.1 (Kubernetes v1.15.3) 2 months ago
.gitignore rename site/ to docs/ 4 months ago
.readthedocs.yml rename site/ to docs/ 4 months ago
CHANGELOG.md Update changelog for v1.15.0 2 months ago
CODE_OF_CONDUCT.md Move code of conduct into its own file. 1 year ago
CONTRIBUTING.md Update org name in error help, other docs 2 months ago
DCO docs: steal CONTRIBUTING.md and DCO docs from scope, modify slightly 1 year ago
LICENSE Initial commit 3 years ago
MAINTAINERS Update Slack information in MAINTAINERS file 4 months ago
Makefile Move Flux packages to pkg dir 2 months ago
README.md Added bimspot.io to as a Flux user. 2 months ago
go.mod Update Helm operator dependency to `v1.0.0-rc2` 2 months ago
go.sum Update Helm operator dependency to `v1.0.0-rc2` 2 months ago
tools.go Remove `k8s.io/code-generator` from go.mod 3 months ago

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

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!