README
¶
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.
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.
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:
- Manage a multi-tenant cluster with Flux and Kustomize
- Managing Helm releases the GitOps way
- OpenFaaS GitOps workflow with Flux
- GitOps for Istio Canary deployments
- Fluxcloud to receive events from Flux
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:
- Read the Flux docs.
- Invite yourself to the CNCF community slack and ask a question on the #flux channel.
- To be part of the conversation about Flux's development, join the flux-dev mailing list.
- File an issue.
Your feedback is always welcome!
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
pkg
|
|
|
api/v10
This package defines the types for Flux API version 10.
|
This package defines the types for Flux API version 10. |
|
api/v11
This package defines the types for Flux API version 11.
|
This package defines the types for Flux API version 11. |
|
api/v9
This package defines the types for Flux API version 9.
|
This package defines the types for Flux API version 9. |
|
cluster/kubernetes
Package kubernetes provides implementations of `Cluster` and `manifests` that interact with the Kubernetes API (using kubectl or the k8s API client).
|
Package kubernetes provides implementations of `Cluster` and `manifests` that interact with the Kubernetes API (using kubectl or the k8s API client). |
|
gpg
Package gpg has procedures for dealing with GNU Privacy Guard (gpg), in service of signing commits.
|
Package gpg has procedures for dealing with GNU Privacy Guard (gpg), in service of signing commits. |
|
registry
This package has types for dealing with image registries (e.g., quay.io, DockerHub, Google Container Registry, ..).
|
This package has types for dealing with image registries (e.g., quay.io, DockerHub, Google Container Registry, ..). |
|
registry/cache
This package implements an image metadata cache given a backing k-v store.
|
This package implements an image metadata cache given a backing k-v store. |
|
registry/cache/memcached
This package implements an image DB cache using memcached.
|
This package implements an image DB cache using memcached. |
|
remote/rpc
This is a `net/rpc`-compatible implementation of a client and server for `flux/api.Server`.
|
This is a `net/rpc`-compatible implementation of a client and server for `flux/api.Server`. |
|
install
Module
|