Go Shell Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci Give update_tests more time to run Jun 21, 2018
api Split off SortedImageInfos to enforce constraint Aug 3, 2018
apis/helm.integrations.flux.weave.works Annotate resources caused by a FluxHelmRelease Jun 19, 2018
bin Bump kubeyaml to 0.4.2 Aug 1, 2018
chart Document how to install flux/flux helm operator on private git host Aug 11, 2018
checkpoint Factor checkpoint so it can be used by helm-op too Aug 8, 2018
cluster Image filtering with regular expressions Aug 17, 2018
cmd Implement `force` for manual releases Aug 14, 2018
daemon Fix race in test expectations Aug 14, 2018
deploy-helm Add openAPIV3Schema validation to Helm CRD (#1253) Jul 26, 2018
deploy Update Helm chart and deployment yaml to Flux v1.5.0 Aug 9, 2018
docker Simplify verify_known_hosts and make deterministic Aug 14, 2018
errors Downgrade non-specific errors to application-level Feb 15, 2018
event Omit changes that aren't, in auto-releases Apr 4, 2018
git Fix git.Export(sha1) Jul 24, 2018
guid Make new subscriptions kick old subscriptions Dec 14, 2016
http Update UpStream to register as V10 Jun 15, 2018
image Support semver in container filter tag Aug 3, 2018
integrations Use structured logging. Aug 9, 2018
internal_docs Document the Helm chart release process Aug 9, 2018
job Break dependencies among git, job, event packages Apr 3, 2018
metrics Standardize http metrics, to flux_request_duration Feb 2, 2017
policy Image filtering with regular expressions Aug 17, 2018
registry Merge pull request #1266 from weaveworks/issue/706-semver-filtering-o… Aug 6, 2018
release Implement `force` for manual releases Aug 14, 2018
remote Split off SortedImageInfos to enforce constraint Aug 3, 2018
resource Verify releases with a model comparison May 24, 2018
site Finetune documentation Aug 17, 2018
ssh Generate keys in a separate tmpfs volume Mar 14, 2018
sync Check if boolean policies equal true Aug 1, 2018
test Keep current-context Oct 31, 2017
update Implement `force` for manual releases Aug 14, 2018
.gitignore Basic integration tests Oct 31, 2017
CHANGELOG-helmop.md Update helm-op changelog for release 0.1.1-alpha Jul 16, 2018
CHANGELOG.md CHANGELOG entry for v1.5.0 Aug 8, 2018
Gopkg.lock Simplify sorting based on reviewer comments. Aug 8, 2018
Gopkg.toml Update go-k8s-portforward to latest version to provide kubectl auth p… Aug 12, 2018
LICENSE Initial commit Jul 7, 2016
Makefile Simplify verify_known_hosts and make deterministic Aug 14, 2018
README.md rename Helm Get Started guide to site/helm/get-started.md Jul 5, 2018
flux.go Allow colons in the name component of resource IDs Aug 9, 2018
lint Basic circle.yml, respecting Glide etc. Jul 15, 2016
resourceid_test.go Allow colons in the name component of resource IDs Aug 9, 2018

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!