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 e12e853b42 Remove the helm prefix from helm-op version 1 year ago
.circleci Remove the helm prefix from helm-op version 1 year ago
api Split off SortedImageInfos to enforce constraint 2 years ago
apis/helm.integrations.flux.weave.works Annotate resources caused by a FluxHelmRelease 2 years ago
bin Bump kubeyaml to 0.4.2 2 years ago
chart Make the helm-op CRD creation optional 2 years ago
checkpoint Factor checkpoint so it can be used by helm-op too 2 years ago
cluster Merge pull request #1298 from weaveworks/dont-require-list-ns 2 years ago
cmd Review feedback 1 year ago
daemon Allow multiple config paths within a git repo 2 years ago
deploy Update deploy manifests to api version apps/v1 1 year ago
deploy-helm Update deploy manifests to api version apps/v1 1 year ago
docker Remove the helm prefix from helm-op version 1 year ago
errors Downgrade non-specific errors to application-level 2 years ago
event Omit changes that aren't, in auto-releases 2 years ago
git Allow multiple config paths within a git repo 2 years ago
guid Make new subscriptions kick old subscriptions 3 years ago
http Update UpStream to register as V10 2 years ago
image Support semver in container filter tag 2 years ago
integrations Guard the shared git clone with a lock not channel 2 years ago
internal_docs Document the Helm chart release process 2 years ago
job Break dependencies among git, job, event packages 2 years ago
metrics Standardize http metrics, to flux_request_duration 3 years ago
policy Remove spurious ServicesWithPolicies 2 years ago
registry Merge pull request #1266 from weaveworks/issue/706-semver-filtering-ordering 2 years ago
release Review feedback 1 year ago
remote Remove spurious ServicesWithPolicies 2 years ago
resource Verify releases with a model comparison 2 years ago
site Corrected docs for the helm install example 1 year ago
ssh Generate keys in a separate tmpfs volume 2 years ago
sync Allow multiple config paths within a git repo 2 years ago
test Keep current-context 2 years ago
update Exclude locked workloads for container type release 1 year ago
.gitignore Basic integration tests 2 years ago
CHANGELOG-helmop.md Release notes for helm-op 0.2.0 2 years ago
CHANGELOG.md CHANGELOG entry for v1.5.0 2 years ago
CONTRIBUTING.md docs: steal CONTRIBUTING.md and DCO docs from scope, modify slightly 1 year ago
DCO docs: steal CONTRIBUTING.md and DCO docs from scope, modify slightly 1 year ago
Gopkg.lock Simplify sorting based on reviewer comments. 2 years ago
Gopkg.toml Update go-k8s-portforward to latest version to provide kubectl auth plugins for GKE, AWS, to support managed clusters. 2 years ago
LICENSE Initial commit 4 years ago
Makefile Simplify verify_known_hosts and make deterministic 2 years ago
README.md Mention FAQ issues in README 2 years ago
flux.go Allow colons in the name component of resource IDs 2 years ago
lint Basic circle.yml, respecting Glide etc. 4 years ago
resourceid_test.go Allow colons in the name component of resource IDs 2 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!