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.
Alfonso Acosta 49d627926f
Merge pull request #1967 from 2opremio/fix-insure-hosts-with-ports
6 months ago
.circleci Give master builds their own prerelease homes 7 months ago
.github Ask for software versions 6 months ago
api Move images to Docker Hub 7 months ago
bin Fixup arm and arm64 builds; Refactor Makefile; 7 months ago
chart Include CRD changes in changelog 7 months ago
checkpoint Fixup arm and arm64 builds; Refactor Makefile; 7 months ago
cluster Exclude resources if we cannot find their scope 7 months ago
cmd Merge pull request #1943 from 2opremio/1941-fix-CRD-syncing 7 months ago
daemon Exclude resources if we cannot find their scope 7 months ago
deploy Move images to Docker Hub 7 months ago
deploy-helm Move images to Docker Hub 7 months ago
docker Fixup arm and arm64 builds; Refactor Makefile; 7 months ago
errors Downgrade non-specific errors to application-level 1 year ago
event Revert renaming of serialized struct fields 8 months ago
git Warn user about non-existing configured branch 7 months ago
gpg Report keyfiles that were found but failed import 8 months ago
guid Make new subscriptions kick old subscriptions 2 years ago
http Revert all the renamings breaking the API 8 months ago
image Move images to Docker Hub 7 months ago
integrations Merge pull request #1906 from weaveworks/helm/refactor-hr-sync 7 months ago
internal_docs Move images to Docker Hub 7 months ago
job Break dependencies among git, job, event packages 1 year ago
metrics Standardize http metrics, to flux_request_duration 2 years ago
policy Make `regex` an alias of `regexp` tag filter type 7 months ago
registry Handle SplitHostPort errors 6 months ago
release Exclude resources if we cannot find their scope 7 months ago
remote Be more tolertant towards missing image manifests 7 months ago
resource Rename resource method Policy() to Policies() 8 months ago
site Fixup arm and arm64 builds; Refactor Makefile; 7 months ago
ssh Generate keys in a separate tmpfs volume 1 year ago
sync Exclude resources if we cannot find their scope 7 months ago
test Move images to Docker Hub 7 months ago
update Fix typos 7 months ago
.gitignore Revert 8 months ago
CHANGELOG-helmop.md Add changelog entry for Helm operator v0.8.0 7 months ago
CHANGELOG.md Add changelog entry for flux 1.12.0 7 months ago
CODE_OF_CONDUCT.md Move code of conduct into its own file. 1 year ago
CONTRIBUTING.md update developing docs to remind to `make test` 8 months ago
DCO docs: steal CONTRIBUTING.md and DCO docs from scope, modify slightly 1 year ago
Gopkg.lock Run dep ensure -update 7 months ago
Gopkg.toml Bump mergo to 0.3.7 7 months ago
LICENSE Initial commit 3 years ago
MAINTAINERS Add Slack handles to MAINTAINERS 1 year ago
Makefile Fixup arm and arm64 builds; Refactor Makefile; 7 months ago
README.md Add Troii to README 7 months ago
flux.go Admit "<cluster>" when parsing ResourceIDs 8 months ago
resourceid_test.go Admit "<cluster>" when parsing ResourceIDs 8 months ago

README.md

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.

Deployment Pipeline

CircleCI GoDoc

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.

Features

Its major features are:

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!

Relation to Weave Cloud

Weave Cloud is a SaaS product by Weaveworks that includes Flux, as well as:

  • a UI and alerts for deployments: nicely integrated overview, all Flux operations just a click away.
  • full observability and insights into your cluster: Instantly start using monitoring dashboards for your cluster, hosted 13 months of history, use a realtime map of your cluster to debug and analyse its state.

If you want to learn more about Weave Cloud, you can see it in action on its homepage.

Get started with Flux

Get started by browsing through the documentation below:

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.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a Flux project maintainer, or Alexis Richardson <alexis@weave.works>. Please refer to our code of conduct as well.

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!