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.
Stefan Prodan fabc2385ab
Merge pull request #2395 from fluxcd/docs-1.14.1
4 hours ago
.circleci Remove release of Helm op images from CI config 1 week ago
.github weaveworks -> fluxcd 1 month ago
api Catch readonly-prohibited operations early 3 days ago
bin Upgrade `kubeyaml` to `0.7.0` 6 days ago
chart Set fluxctl namespace in docs 4 hours ago
checkpoint Fixup arm and arm64 builds; Refactor Makefile; 4 months ago
cluster Cleanup: fix some typos in code comment 11 hours ago
cmd Fix portforward error check 5 hours ago
daemon Let syncing work without a writable clone 3 days ago
deploy Bump version in deployment and chart to 1.14.0 1 day ago
docker Upgrade `kubeyaml` to `0.7.0` 6 days ago
docs Set fluxctl namespace in docs 4 hours ago
errors Downgrade non-specific errors to application-level 1 year ago
event Move ResourceID from root to resource package 1 month ago
git Let syncing work without a writable clone 3 days ago
gpg tests Flux → Weave Flux 1 month ago
guid Make new subscriptions kick old subscriptions 2 years ago
http Move Upstream methods into public API 1 month ago
image Change org in image definition tests to 'fluxcd' 1 month ago
install Bump version in deployment and chart to 1.14.0 1 day ago
integrations Add support for HelmRelease v1 resources 1 week ago
internal_docs Fixed broken URLs and mentions of old organization 1 week ago
job Break dependencies among git, job, event packages 1 year ago
manifests Cleanup: fix some typos in code comment 11 hours ago
metrics Standardize http metrics, to flux_request_duration 2 years ago
policy Only require image TS when it is used for sorting 1 month ago
registry Run credentials tests in parallel 1 month ago
release Use git.Export as the base of git.Checkout 3 days ago
remote Fixed broken URLs and mentions of old organization 1 week ago
resource Move ResourceID from root to resource package 1 month ago
snap install fluxctl in the right place 22 hours ago
ssh Add the option to run fluxd outside a Kubernetes cluster 2 months ago
sync Use git.Export as the base of git.Checkout 3 days ago
test Remove Helm operator bits from end to end tests 1 week ago
update Move ResourceID from root to resource package 1 month ago
.gitignore rename site/ to docs/ 3 weeks ago
.readthedocs.yml rename site/ to docs/ 3 weeks ago
CHANGELOG.md Update changelog for v1.14.0 1 day ago
CODE_OF_CONDUCT.md Move code of conduct into its own file. 11 months ago
CONTRIBUTING.md Restructure and split Flux and Helm op docs 3 weeks ago
DCO docs: steal CONTRIBUTING.md and DCO docs from scope, modify slightly 11 months ago
LICENSE Initial commit 3 years ago
MAINTAINERS Update Slack information in MAINTAINERS file 2 weeks ago
Makefile Remove `helm-operator` targets from `Makefile` 1 week ago
README.md Add Starbucks to companies using Flux in prod 21 hours ago
go.mod Support defining image paths for HelmReleases 6 days ago
go.sum Support defining image paths for HelmReleases 6 days ago
tools.go Remove `k8s.io/code-generator` from go.mod 1 week 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!