1
0
mirror of synced 2026-02-06 10:55:56 +00:00

docs: add more content to the README.md

This commit is contained in:
Hidde Beydals
2020-09-15 17:52:31 +02:00
parent 67e0acd044
commit 346d8f7583
3 changed files with 66 additions and 7 deletions

View File

@@ -3,17 +3,17 @@
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 built with Kubernetes controller-runtime libraries and they
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.
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 and GitHub.
If you wish to take part in this quest please reach out to us on Slack or GitHub.
![overview](diagrams/gotk-feature.png)

View File

@@ -91,6 +91,6 @@ Tasks
- [x] <span style="color:grey">Implement support for values from `Secret` and `ConfigMap` resources</span>
- [x] <span style="color:grey">Implement conditional remediation on (failed) Helm actions</span>
- [x] <span style="color:grey">Implement support for Helm charts from Git</span>
- [x] <span style="color:grey">Implement support for referring to an alternative chart values file</span>\
- [x] <span style="color:grey">Implement support for referring to an alternative chart values file</span>
- [ ] Stabilize API
- [ ] Create a migration guide for Helm Operator users