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 a211ea3d1e Use ~/.kube/config to set default namespace 1 year ago
.circleci Retag released helm-operator tags without the prefix (#1063) 1 year ago
api Add containerFields query parameter to ListImages 1 year ago
apis/helm.integrations.flux.weave.works Bumps the FluxHelmRelease API version to v1alpha2 1 year ago
bin Use kubeyaml to do image updates 1 year ago
chart/flux Fix typo in service type description 1 year ago
cluster Sort resources to apply into dependency order 1 year ago
cmd Trim spaces when logging the public SSH hey 1 year ago
daemon Merge pull request #1084 from weaveworks/913-images-summary 1 year ago
deploy Update changelog and example deploy for v1.3.1 1 year ago
deploy-helm Bumps the FluxHelmRelease API version to v1alpha2 1 year ago
docker Use ~/.kube/config to set default namespace 1 year ago
errors Downgrade non-specific errors to application-level 1 year ago
event Omit changes that aren't, in auto-releases 1 year ago
git Make sync run immediately once git is ready 1 year ago
guid Make new subscriptions kick old subscriptions 2 years ago
http Use kubeyaml to do image updates 1 year ago
image Add containerFields query parameter to ListImages 1 year ago
integrations Purge release on FHR delete 1 year ago
internal_docs Add PR step to release instructions 1 year ago
job Break dependencies among git, job, event packages 1 year ago
metrics Standardize http metrics, to flux_request_duration 2 years ago
policy Simplify policy and image updates internals 1 year ago
registry Refactor imagesMap functions to make clear we are handling maps of image repos 1 year ago
release Mark verification failures as such 1 year ago
remote Add containerFields query parameter to ListImages 1 year ago
resource Verify releases with a model comparison 1 year ago
site address review comments, update heading in introduction.md 1 year ago
ssh Generate keys in a separate tmpfs volume 1 year ago
sync Add ability to append [ci skip] to commit messages 1 year ago
test Keep current-context 2 years ago
update Merge pull request #1084 from weaveworks/913-images-summary 1 year ago
.gitignore Basic integration tests 2 years ago
CHANGELOG.md Update changelog and example deploy for v1.3.1 1 year ago
Gopkg.lock Add tests for the "gathering data" phase of releasesync. 1 year ago
Gopkg.toml Add tests for the "gathering data" phase of releasesync. 1 year ago
LICENSE Initial commit 3 years ago
Makefile Use ~/.kube/config to set default namespace 1 year ago
README.md docs: more feature details, compare against WC 1 year ago
flux.go Detangle service token from top-level package 1 year ago
lint Basic circle.yml, respecting Glide etc. 3 years 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 an 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:

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:

Developer information

Build documentation

Release documentation

Contribution

Flux follows a typical PR workflow. All contributions should be made as PRs that satisfy the guidelines below.

Guidelines

  • All code must abide Go Code Review Comments
  • Names should abide What’s in a name
  • Code must build on both Linux and Darwin, via plain go build
  • Code should have appropriate test coverage, invoked via plain go test

In addition, several mechanical checks are enforced. See the lint script for details.

Getting Help

If you have any questions about Flux and continuous delivery:

Your feedback is always welcome!