fluxcd
/
source-controller
mirror of https://github.com/fluxcd/source-controller.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1063 from fluxcd/add-docs-links 

Add API docs links to readme
This commit is contained in:
Stefan Prodan 2023-03-30 13:22:06 +03:00 committed by GitHub
parent 288d079cfc b7a7711d01
commit ae55569a62
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 35 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -7,23 +7,47 @@
[![release](https://img.shields.io/github/release/fluxcd/source-controller/all.svg)](https://github.com/fluxcd/source-controller/releases) [![release](https://img.shields.io/github/release/fluxcd/source-controller/all.svg)](https://github.com/fluxcd/source-controller/releases)
The source-controller is a Kubernetes operator, specialised in artifacts acquisition The source-controller is a Kubernetes operator, specialised in artifacts acquisition
from external sources such as Git, Helm repositories and S3 buckets. from external sources such as Git, OCI, Helm repositories and S3-compatible buckets.
The source-controller implements the The source-controller implements the
[source.toolkit.fluxcd.io](https://github.com/fluxcd/source-controller/tree/main/docs/spec/v1beta2) API [source.toolkit.fluxcd.io](docs/spec/README.md) API
and is a core component of the [GitOps toolkit](https://fluxcd.io/flux/components/). and is a core component of the [GitOps toolkit](https://fluxcd.io/flux/components/).
![overview](docs/diagrams/source-controller-overview.png) ![overview](docs/diagrams/source-controller-overview.png)
Features: ## APIs
* authenticates to sources (SSH, user/password, API token) | Kind | API Version |
* validates source authenticity (PGP) |---------------------------------------------------------|------------------------------------|
| [GitRepository](docs/spec/v1/gitrepositories.md) | `source.toolkit.fluxcd.io/v1` |
| [OCIRepository](docs/spec/v1beta2/ocirepositories.md) | `source.toolkit.fluxcd.io/v1beta2` |
| [HelmRepository](docs/spec/v1beta2/helmrepositories.md) | `source.toolkit.fluxcd.io/v1beta2` |
| [HelmChart](docs/spec/v1beta2/helmcharts.md) | `source.toolkit.fluxcd.io/v1beta2` |
| [Bucket](docs/spec/v1beta2/buckets.md) | `source.toolkit.fluxcd.io/v1beta2` |
## Features
* authenticates to sources (SSH, user/password, API token, Workload Identity)
* validates source authenticity (PGP, Cosign)
* detects source changes based on update policies (semver) * detects source changes based on update policies (semver)
* fetches resources on-demand and on-a-schedule * fetches resources on-demand and on-a-schedule
* packages the fetched resources into a well-known format (tar.gz, yaml) * packages the fetched resources into a well-known format (tar.gz, yaml)
* makes the artifacts addressable by their source identifier (sha, version, ts) * makes the artifacts addressable by their source identifier (sha, version, ts)
* makes the artifacts available in-cluster to interested 3rd parties * makes the artifacts available in-cluster to interested 3rd parties
* notifies interested 3rd parties of source changes and availability (status conditions, events, hooks) * notifies interested 3rd parties of source changes and availability (status conditions, events, hooks)
* reacts to Git push and Helm chart upload events (via [notification-controller](https://github.com/fluxcd/notification-controller)) * reacts to Git, Helm and OCI artifacts push events (via [notification-controller](https://github.com/fluxcd/notification-controller))
See [the docs folder](docs/spec/README.md) for more information. ## Guides
* [Get started with Flux](https://fluxcd.io/flux/get-started/)
* [Setup Webhook Receivers](https://fluxcd.io/flux/guides/webhook-receivers/)
* [Setup Notifications](https://fluxcd.io/flux/guides/notifications/)
* [How to build, publish and consume OCI Artifacts with Flux](https://fluxcd.io/flux/cheatsheets/oci-artifacts/)
## Roadmap
The roadmap for the Flux family of projects can be found at <https://fluxcd.io/roadmap/>.
## Contributing
This project is Apache 2.0 licensed and accepts contributions via GitHub pull requests.
To start contributing please see the [development guide](DEVELOPMENT.md).

2
docs/spec/v1/README.md
View File

@ -1,4 +1,4 @@
# source.toolkit.fluxcd.io/v1beta2 # source.toolkit.fluxcd.io/v1
This is the v1 API specification for defining the desired state sources of Kubernetes clusters. This is the v1 API specification for defining the desired state sources of Kubernetes clusters.

2
docs/spec/v1/gitrepositories.md
View File

@ -354,7 +354,7 @@ signatures. The field offers two subfields:
```yaml ```yaml
--- ---
apiVersion: source.toolkit.fluxcd.io/v1beta1 apiVersion: source.toolkit.fluxcd.io/v1
kind: GitRepository kind: GitRepository
metadata: metadata:
name: podinfo name: podinfo

4
docs/spec/v1beta2/helmrepositories.md
View File

@ -312,12 +312,12 @@ if you want to use AKS pod-managed identities add-on that is in preview.
The `gcp` provider can be used to authenticate automatically using OAuth scopes or The `gcp` provider can be used to authenticate automatically using OAuth scopes or
Workload Identity, and by extension gain access to GCR or Artifact Registry. Workload Identity, and by extension gain access to GCR or Artifact Registry.
#### Access Scopes ##### Access Scopes
When the GKE nodes have the appropriate OAuth scope for accessing GCR and Artifact Registry, When the GKE nodes have the appropriate OAuth scope for accessing GCR and Artifact Registry,
source-controller running on it will also have access to them. source-controller running on it will also have access to them.
#### GKE Workload Identity ##### GKE Workload Identity
When using Workload Identity to enable access to GCR or Artifact Registry, add the When using Workload Identity to enable access to GCR or Artifact Registry, add the
following patch to your bootstrap repository, in the `flux-system/kustomization.yaml` following patch to your bootstrap repository, in the `flux-system/kustomization.yaml`