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 d1b097ee51
Merge pull request #1751 from weaveworks/build/clarify-azure-key-provenance
2 days ago
.circleci Add makefile target for verifying generated code 3 months ago
.github Add tag filter for chart-* to GitGHub workflow 4 weeks ago
api Actually return the SyncError for controllers 3 months ago
bin Bump to kubeyaml 0.5.1 to fix (F)HR updating 3 months ago
chart Update chart change log for v0.6.3 1 week ago
checkpoint making compiling work on raspberry pi's 3 months ago
cluster Filter locked and ignore resources during release 2 days ago
cmd Merge pull request #1680 from captncraig/patch-1 1 week ago
daemon Take ignore policy into account while fetching 2 days ago
deploy Bump flux image in reference manifest 1 week ago
deploy-helm add "skipDepUpdate" config parameter to HelmRelease 2 weeks ago
docker Document source of Azure SSH host key 2 days ago
errors Downgrade non-specific errors to application-level 1 year ago
event Fix typo: should be ReleaseContainersSpec instead of ReleaseImageSpec 3 months ago
git Allow $HOME when invoking git 1 month ago
guid Make new subscriptions kick old subscriptions 2 years ago
http Add events for container release For ReleaseEventMetadata use spec with both types: ReleaseImageSpec and ReleaseContainersSpec 3 months ago
image Include parsed string in error for ParseRef() 4 months ago
integrations Use release name from HelmRelease in errors 6 days ago
internal_docs Update doc on release process 3 months ago
job Break dependencies among git, job, event packages 10 months ago
metrics Standardize http metrics, to flux_request_duration 2 years ago
policy Remove spurious ServicesWithPolicies 6 months ago
registry Make previously-Exported ACR-centric functions private to the package. 1 week ago
release Fix tests 3 months ago
remote Add HelmRelease to the kinds supported in RPC 3 months ago
resource Verify releases with a model comparison 9 months ago
site Inform about side-effects of repositories.yaml 6 days ago
ssh Generate keys in a separate tmpfs volume 11 months ago
sync Move sync error tracking to Cluster 3 months ago
test Keep current-context 1 year ago
update Filter locked and ignore resources during release 2 days ago
.gitignore Basic integration tests 1 year ago
CHANGELOG-helmop.md Add changelog entry for Helm operator v0.6.0 2 weeks ago
CHANGELOG.md Refine changelog entry for Flux v1.10.1 1 week ago
CODE_OF_CONDUCT.md Move code of conduct into its own file. 5 months ago
CONTRIBUTING.md Remote last traces of `linting` 1 month ago
DCO docs: steal CONTRIBUTING.md and DCO docs from scope, modify slightly 5 months ago
Gopkg.lock Make port forward label selector configurable 1 week ago
Gopkg.toml Bump go-k8s-portforward to version 1.0.2 1 month ago
LICENSE Initial commit 2 years ago
MAINTAINERS Add Slack handles to MAINTAINERS 4 months ago
Makefile Add PATH quoting in `make test` 1 month ago
README.md add tutorial which discusses automation, annotations, locks 1 month ago
flux.go Allow colons in the name component of resource IDs 6 months ago
resourceid_test.go Allow colons in the name component of resource IDs 6 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:

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!