mirror of https://github.com/fluxcd/flux2.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
79 lines
4.2 KiB
Markdown
79 lines
4.2 KiB
Markdown
# 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.
|
|
|
|
!!! hint "Work in Progress"
|
|
We envision a future where **Flux v2** and **Helm Operator v2** will be assembled from
|
|
the GitOps Toolkit components. The Flux CD team is looking for feedback and help as
|
|
the toolkit is in an active experimentation phase.
|
|
If you wish to take part in this quest please reach out to us on Slack or GitHub.
|
|
|
|
|
|
|
|
Target features:
|
|
|
|
- Source management
|
|
- Kustomize and Helm support
|
|
- Event-based and on-a-schedule reconciliation
|
|
- Role-based reconciliation (multi-tenancy)
|
|
- Health assessment (clusters and workloads)
|
|
- Dependency management (infra and workloads)
|
|
- Alerting to external systems (webhook senders)
|
|
- External events handling (webhook receivers)
|
|
- Source write-back (automated patching)
|
|
- Policy driven validation (OPA, admission controllers)
|
|
- Seamless integration with Git providers (GitHub, GitLab, Bitbucket)
|
|
- Interoperability with workflow providers (GitHub Actions, Tekton, Argo)
|
|
- Interoperability with CAPI providers
|
|
|
|
Components:
|
|
|
|
- [Toolkit CLI](https://github.com/fluxcd/flux2)
|
|
- [Source Controller](components/source/controller.md)
|
|
- [GitRepository CRD](components/source/gitrepositories.md)
|
|
- [HelmRepository CRD](components/source/helmrepositories.md)
|
|
- [HelmChart CRD](components/source/helmcharts.md)
|
|
- [Bucket CRD](components/source/buckets.md)
|
|
- [Kustomize Controller](components/kustomize/controller.md)
|
|
- [Kustomization CRD](components/kustomize/kustomization.md)
|
|
- [Helm Controller](components/helm/controller.md)
|
|
- [HelmRelease CRD](components/helm/helmreleases.md)
|
|
- [Notification Controller](components/notification/controller.md)
|
|
- [Provider CRD](components/notification/provider.md)
|
|
- [Alert CRD](components/notification/alert.md)
|
|
- [Receiver CRD](components/notification/receiver.md)
|
|
|
|
## Get Started
|
|
|
|
!!!hint "Get started with the GitOps Toolkit!"
|
|
Following this [guide](get-started/index.md) will just take a couple of minutes to complete: After installing the `flux` binary and running a couple of very simple commands, you will have a GitOps workflow setup which involves a staging and a production cluster.
|
|
|
|
## 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](https://docs.google.com/document/d/1l_M0om0qUEN_NNiGgpqJ2tvsF2iioHkaARDeh6b70B0/view))
|
|
- Talk to us in the #flux channel on [CNCF Slack](https://slack.cncf.io/)
|
|
- Join the [planning discussions](https://github.com/fluxcd/flux2/discussions)
|
|
- And if you are completely new to the GitOps Toolkit, take a look at our [Get Started guide](get-started/index.md) and give us feedback
|
|
- Check out [how to contribute](contributing/index.md) to the project
|
|
|
|
## Featured Talks
|
|
- 12 Oct 2020 - [Rawkode Live: Introduction to GitOps Toolkit with Stefan Prodan](https://youtu.be/HqTzuOBP0eY)
|
|
- 4 Sep 2020 - [KubeCon/CloudNativeCon Europe: The road to Flux v2 and Progressive Delivery with Stefan Prodan & Hidde Beydals](https://youtu.be/8v94nUkXsxU)
|
|
- 25 June 2020 - [Cloud Native Nordics: Introduction to GitOps & GitOps Toolkit with Alexis Richardson & Stefan Prodan](https://youtu.be/qQBtSkgl7tI)
|
|
- 7 May 2020 - [GitOps Days - Community Special: GitOps Toolkit Experimentation with Stefan Prodan](https://youtu.be/WHzxunv4DKk?t=6521)
|
|
|
|
### Upcoming Meetups
|
|
- 19 Oct 2020 - [The Power of GitOps with Flux & GitOps Toolkit - Part 1](https://www.meetup.com/GitOps-Community/events/273640196/)
|
|
- 2 Nov 2020 - [The Power of GitOps with Flux & GitOps Toolkit - Part 2](https://www.meetup.com/GitOps-Community/events/273934676/)
|
|
|
|
We are looking forward to seeing you with us!
|