mirror of
https://github.com/fluxcd/flux2.git
synced 2026-02-09 17:27:28 +00:00
Move gitops toolkit index under components/
Signed-off-by: Michael Bridgen <michael@weave.works>
This commit is contained in:
parent
107e7424d1
commit
932c91d022
4 changed files with 29 additions and 29 deletions
26
docs/components/index.md
Normal file
26
docs/components/index.md
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
# GitOps Toolkit components
|
||||
|
||||
The GitOps Toolkit is the set of APIs and controllers that make up the
|
||||
runtime for Flux v2. The APIs comprise Kubernetes custom resources,
|
||||
which can be created and updated by a cluster user, or by other
|
||||
automation tooling.
|
||||
|
||||
You can use the toolkit to extend Flux, and to build your own systems
|
||||
for continuous delivery. The [the source-watcher
|
||||
guide](../dev-guides/source-watcher/) is a good place to start.
|
||||
|
||||
A reference for each component and API type is linked below.
|
||||
|
||||
- [Source Controller](source/controller.md)
|
||||
- [GitRepository CRD](source/gitrepositories.md)
|
||||
- [HelmRepository CRD](source/helmrepositories.md)
|
||||
- [HelmChart CRD](source/helmcharts.md)
|
||||
- [Bucket CRD](source/buckets.md)
|
||||
- [Kustomize Controller](kustomize/controller.md)
|
||||
- [Kustomization CRD](kustomize/kustomization.md)
|
||||
- [Helm Controller](helm/controller.md)
|
||||
- [HelmRelease CRD](helm/helmreleases.md)
|
||||
- [Notification Controller](notification/controller.md)
|
||||
- [Provider CRD](notification/provider.md)
|
||||
- [Alert CRD](notification/alert.md)
|
||||
- [Receiver CRD](notification/receiver.md)
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
# GitOps Toolkit
|
||||
|
||||
The GitOps Toolkit is the set of APIs and controllers that make up the
|
||||
runtime for Flux v2. The APIs comprise Kubernetes custom resources,
|
||||
which can be created and updated by a cluster user, or by other
|
||||
automation tooling.
|
||||
|
||||
You can use the toolkit to extend Flux, and to build your own systems
|
||||
for continuous delivery. The [the source-watcher
|
||||
guide](https://toolkit.fluxcd.io/dev-guides/source-watcher/) is a good
|
||||
place to start.
|
||||
|
||||
A reference for each component is linked below.
|
||||
|
||||
- [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)
|
||||
|
|
@ -10,7 +10,7 @@ components of the Kubernetes ecosystem. In version 2, Flux supports
|
|||
multi-tenancy and support for syncing an arbitrary number of Git
|
||||
repositories, among other long-requested features.
|
||||
|
||||
Flux v2 is constructed with the [GitOps Toolkit](dev-guides/index.md),
|
||||
Flux v2 is constructed with the [GitOps Toolkit](components/index.md),
|
||||
a set of composable APIs and specialized tools for building Continuous
|
||||
Delivery on top of Kubernetes.
|
||||
|
||||
|
|
@ -22,7 +22,7 @@ Flux helps
|
|||
- **platform engineers** who build continuous delivery for developer teams;
|
||||
- **app developers** who rely on continuous delivery to get their code live.
|
||||
|
||||
The [GitOps Toolkit](dev-guides/index.md) is for **platform
|
||||
The [GitOps Toolkit](components/index.md) is for **platform
|
||||
engineers** who want to make their own continuous delivery system, and
|
||||
have requirements not covered by Flux.
|
||||
|
||||
|
|
|
|||
|
|
@ -56,6 +56,7 @@ nav:
|
|||
- From Flux v1: guides/flux-v1-migration.md
|
||||
- From the Helm Operator: guides/helm-operator-migration.md
|
||||
- Toolkit Components:
|
||||
- Overview: components/index.md
|
||||
- Source Controller:
|
||||
- Overview: components/source/controller.md
|
||||
- GitRepository CRD: components/source/gitrepositories.md
|
||||
|
|
|
|||
Loading…
Reference in a new issue