mirror of https://github.com/fluxcd/flux2.git synced 2026-02-08 00:37:27 +00:00

Open and extensible continuous delivery solution for Kubernetes. Powered by GitOps Toolkit.

continuous-delivery gitops gitops-toolkit helm kubernetes kustomize

Find a file

circa10a 3619cb8bd1 Switch get commands to use tables for output Signed-off-by: circa10a <caleblemoine@gmail.com>		2020-10-04 16:34:04 -05:00
.github/workflows	Switch get commands to use tables for output	2020-10-04 16:34:04 -05:00
cmd/gotk	Switch get commands to use tables for output	2020-10-04 16:34:04 -05:00
docs	Switch get commands to use tables for output	2020-10-04 16:34:04 -05:00
install	Add ARM64 to install docs and script	2020-09-04 15:10:42 +03:00
manifests	Update toolkit components	2020-10-02 18:20:24 +00:00
mkdocs	Add metadata to docs website	2020-06-26 16:41:04 +03:00
pkg/log	Migrate to fluxcd/pkg	2020-06-30 17:11:04 +03:00
.gitignore	Publish manifests as release assets	2020-07-17 12:00:15 +03:00
.goreleaser.yml	Add support for ARMv7	2020-09-21 10:37:55 +03:00
CODE_OF_CONDUCT.md	Add coc, dco and maintainers docs	2020-04-30 17:25:22 +03:00
CONTRIBUTING.md	Add community section to `README.md`	2020-09-23 10:07:47 +02:00
DCO	Add coc, dco and maintainers docs	2020-04-30 17:25:22 +03:00
go.mod	Switch get commands to use tables for output	2020-10-04 16:34:04 -05:00
go.sum	Switch get commands to use tables for output	2020-10-04 16:34:04 -05:00
LICENSE	Initial commit	2020-04-24 12:38:22 +03:00
MAINTAINERS	Add coc, dco and maintainers docs	2020-04-30 17:25:22 +03:00
Makefile	Rename `tk` binary to `gotk`	2020-09-01 11:33:49 +02:00
mkdocs.yml	Update components to v0.1	2020-09-30 23:09:21 +03:00
README.md	Change default branch to main	2020-10-01 22:45:45 +03:00

README.md

GitOps Toolkit

The GitOps Toolkit is a set of composable APIs and specialized tools that can be used to build a Continuous Delivery platform on top of Kubernetes.

These tools are build with Kubernetes controller-runtime libraries, and they can be dynamically configured with Kubernetes custom resources either by cluster admins or by other automated tools. The GitOps Toolkit components interact with each other via Kubernetes events and are responsible for the reconciliation of their designated API objects.

`gotk` installation

With Homebrew:

brew tap fluxcd/tap
brew install gotk

With Bash:

curl -s https://toolkit.fluxcd.io/install.sh | sudo bash

# enable completions in ~/.bash_profile
. <(gotk completion)

Binaries for macOS and Linux AMD64/ARM64 are available to download on the release page.

Verify that your cluster satisfies the prerequisites with:

gotk check --pre

Get started

To get started with the GitOps Toolkit, start browsing the documentation or get started with one of the following guides:

Components

Community

The GitOps Toolkit is always looking for new contributors and there are a multitude of ways to get involved. Depending on what you want to do, some of the following bits might be your first steps:

Join our upcoming dev meetings (meeting access and agenda)
Talk to us in the #flux channel on CNCF Slack
Join the planning discussions
And if you are completely new to the GitOps Toolkit, take a look at our Get Started guide and give us feedback
To be part of the conversation about Flux's development, join the flux-dev mailing list.
Check out how to contribute to the project

We are looking forward to seeing you with us!