diff --git a/CHANGELOG.md b/CHANGELOG.md index 6d2ebb8bc..95c8c1d71 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ All notable changes to this project are documented in this file. +## 0.0.4 (2020-07-10) + +This prerelease comes with fixes to the testing framework. + ## 0.0.3 (2020-07-09) This prerelease adds support for diff --git a/README.md b/README.md index db738532a..a3840486e 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,23 @@ [![report](https://goreportcard.com/badge/github.com/fluxcd/source-controller)](https://goreportcard.com/report/github.com/fluxcd/source-controller) [![license](https://img.shields.io/github/license/fluxcd/source-controller.svg)](https://github.com/fluxcd/source-controller/blob/master/LICENSE) [![release](https://img.shields.io/github/release/fluxcd/source-controller/all.svg)](https://github.com/fluxcd/source-controller/releases) - -The source-controller is an implementation of the + +The source-controller is a Kubernetes operator, specialised in artifacts acquisition +from external sources such as Git and Helm repositories. +The source-controller implements the [source.fluxcd.io](https://github.com/fluxcd/source-controller/tree/master/docs/spec/v1alpha1) API -based on the specifications described in the -[Source Controller Proposal](https://github.com/fluxcd/source-controller/tree/master/docs/spec). +and is a core component of the [GitOps toolkit](https://toolkit.fluxcd.io). + +![overview](docs/diagrams/source-controller-overview.png) + +Features: -Integrations: -* [kustomize-controller](https://github.com/fluxcd/kustomize-controller) +* authenticates to sources (SSH, user/password, API token) +* validates source authenticity (PGP) +* detects source changes based on update policies (semver) +* fetches resources on-demand and on-a-schedule +* 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 available in-cluster to interested 3rd parties +* 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)) diff --git a/config/manager/kustomization.yaml b/config/manager/kustomization.yaml index 3008a23a0..79dd83132 100644 --- a/config/manager/kustomization.yaml +++ b/config/manager/kustomization.yaml @@ -6,4 +6,4 @@ resources: images: - name: fluxcd/source-controller newName: fluxcd/source-controller - newTag: v0.0.3 + newTag: v0.0.4 diff --git a/docs/diagrams/source-controller-overview.png b/docs/diagrams/source-controller-overview.png new file mode 100644 index 000000000..6d4f4c7ab Binary files /dev/null and b/docs/diagrams/source-controller-overview.png differ