From 7568f301b89e81ae4ba66e2cd5dd75260ea2f320 Mon Sep 17 00:00:00 2001 From: Michael Bridgen Date: Tue, 19 Jan 2021 13:40:35 +0000 Subject: [PATCH 1/2] Make home for image-* component docs This has a description of the controllers, and is where the API specs and refs will get copied to. Signed-off-by: Michael Bridgen --- docs/components/image/controller.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/components/image/controller.md diff --git a/docs/components/image/controller.md b/docs/components/image/controller.md new file mode 100644 index 00000000..2b972027 --- /dev/null +++ b/docs/components/image/controller.md @@ -0,0 +1,16 @@ +# Image reflector and automation controllers + +The image-reflector-controller and image-automation-controller work together to update a Git +repository when new container images are available. + +- The image-reflector-controller scans image repositories and reflects the image metadata in + Kubernetes resources. +- The image-automation-controller updates YAML files based on the latest images scanned, and commits + the changes to a given Git repository. + +Links: + +- Source code [fluxcd/image-reflector-controller](https://github.com/fluxcd/image-reflector-controller) +- Reflector [specification docs](https://github.com/fluxcd/image-reflector-controller/tree/main/docs/spec) +- Source code [fluxcd/image-automation-controller](https://github.com/fluxcd/image-automation-controller) +- Automation [specification docs](https://github.com/fluxcd/image-automation-controller/tree/main/docs/spec) From 6a2b53fbf5432a1caf8635cbc61dbfc54547844c Mon Sep 17 00:00:00 2001 From: Michael Bridgen Date: Tue, 19 Jan 2021 13:43:54 +0000 Subject: [PATCH 2/2] Put image specs and refs in place This adds the image controller specs and refs to the workflow that prepares the docs, and links to them in the index. Signed-off-by: Michael Bridgen --- .github/workflows/docs.yaml | 12 ++++++++++++ docs/components/index.md | 4 ++++ 2 files changed, 16 insertions(+) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index feefd56d..310d7dc0 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -54,6 +54,18 @@ jobs: curl -# -Lf "https://raw.githubusercontent.com/fluxcd/notification-controller/$NOTIFICATION_VER/docs/spec/v1beta1/receiver.md" > docs/components/notification/receiver.md } + { + # image-*-controller CRDs; these use the same API group + IMG_REFL_VER=$(controller_version image-reflector-controller) + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/image-reflector-controller/$IMG_REFL_VER/docs/api/image-reflector.md" > docs/components/image/reflector-api.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/image-reflector-controller/$IMG_REFL_VER/docs/spec/v1alpha1/imagerepositories.md" > docs/components/image/imagerepositories.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/image-reflector-controller/$IMG_REFL_VER/docs/spec/v1alpha1/imagepolicies.md" > docs/components/image/imagepolicies.md + + IMG_AUTO_VER=$(controller_version image-automation-controller) + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/image-automation-controller/$IMG_AUTO_VER/docs/api/image-automation.md" > docs/components/image/automation-api.md + curl -# -Lf "https://raw.githubusercontent.com/fluxcd/image-automation-controller/$IMG_AUTO_VER/docs/spec/v1alpha1/imageupdateautomations.md" > docs/components/image/imageupdateautomations.md + } + { # install script cp install/flux.sh docs/install.sh diff --git a/docs/components/index.md b/docs/components/index.md index b32efa28..09d08d66 100644 --- a/docs/components/index.md +++ b/docs/components/index.md @@ -24,3 +24,7 @@ A reference for each component and API type is linked below. - [Provider CRD](notification/provider.md) - [Alert CRD](notification/alert.md) - [Receiver CRD](notification/receiver.md) +- [Image automation controllers](image/controller.md) + - [ImageRepository CRD](image/imagerepositories.md) + - [ImagePolicy CRD](image/imagepolicies.md) + - [ImageUpdateAutomation CRD](image/imageupdateautomation.md)