From 44baa4c3408556d259d40daa3cf079a6ac41e940 Mon Sep 17 00:00:00 2001 From: lloydchang Date: Sun, 31 Oct 2021 11:36:58 -0700 Subject: [PATCH] docs(image-reflector-controller/docs/spec/v1beta1/imagerepositories.md): elaborate on how to enable autologin for ECR https://github.com/fluxcd/flux/pull/1619 https://github.com/fluxcd/flux2/discussions/107 https://github.com/fluxcd/image-reflector-controller/issues/11 https://github.com/fluxcd/image-reflector-controller/issues/139 https://github.com/fluxcd/image-reflector-controller/pull/147 https://github.com/fluxcd/image-reflector-controller/pull/174 https://github.com/fluxcd/image-reflector-controller/issues/179 https://github.com/fluxcd/image-reflector-controller/issues/180 https://github.com/fluxcd/website/issues/601 https://github.com/fluxcd/image-reflector-controller/pull/193 https://github.com/fluxcd/website/pull/611 https://fluxcd.io/docs/guides/image-update/#aws-elastic-container-registry Signed-off-by: lloydchang --- docs/spec/v1beta1/imagerepositories.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/spec/v1beta1/imagerepositories.md b/docs/spec/v1beta1/imagerepositories.md index e38471ba..a71f4913 100644 --- a/docs/spec/v1beta1/imagerepositories.md +++ b/docs/spec/v1beta1/imagerepositories.md @@ -61,7 +61,7 @@ type ImageRepositorySpec struct { ``` The `Suspend` field can be set to `true` to stop the controller scanning the image repository -specified; remove the field value or set to `false` to resume scanning. +specified; remove the field value or set it to `false` to resume scanning. ### Authentication @@ -78,8 +78,21 @@ For a publicly accessible image repository, you will not need to provide a `secr When running in [EKS][EKS] and using [ECR][ECR] to store images, you should be able to rely on the controller retrieving credentials automatically. The controller must be run with the flag -`--aws-autologin-for-ecr` set for this to work. The advice under "Other platforms" below will also -work for ECR. +`--aws-autologin-for-ecr` set for this to work. The advice under ["Other platforms"](https://github.com/fluxcd/image-reflector-controller/blob/main/docs/spec/v1beta1/imagerepositories.md#other-platforms) below will also +work for [ECR]. + +> [You need to upgrade to](https://github.com/fluxcd/website/issues/601#issuecomment-952597583) [Flux version 2](https://github.com/fluxcd/flux2) [release](https://github.com/fluxcd/website/issues/601#issuecomment-952597583) [v0.19](https://github.com/fluxcd/flux2/releases/tag/v0.19.0) [that contains the image-reflector-controller release](https://github.com/fluxcd/website/issues/601#issuecomment-952597583) [v0.13.0](https://github.com/fluxcd/image-reflector-controller/blob/main/CHANGELOG.md#0130)[.](https://github.com/fluxcd/website/issues/601#issuecomment-952597583) + +> [**Release date**: 2021-10-19](https://github.com/fluxcd/image-reflector-controller/blob/main/CHANGELOG.md#0130) +> +> [This prerelease adds experimental support for automatically getting +credentials from AWS when scanning an image in](https://github.com/fluxcd/image-reflector-controller/blob/main/CHANGELOG.md#0130) [Elastic Container +Registry +(ECR)](https://docs.aws.amazon.com/AmazonECR/latest/userguide/what-is-ecr.html)[.](https://github.com/fluxcd/image-reflector-controller/blob/main/CHANGELOG.md#0130) +> +> [Improvements:](https://github.com/fluxcd/image-reflector-controller/blob/main/CHANGELOG.md#0130) +> * [Get credentials from AWS ECR when needed](https://github.com/fluxcd/image-reflector-controller/blob/main/CHANGELOG.md#0130) +> [#174](https://github.com/fluxcd/image-reflector-controller/pull/174) #### Other platforms @@ -190,7 +203,7 @@ type ImageRepositoryStatus struct { // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` - // CannonicalName is the name of the image repository with all the + // CanonicalName is the name of the image repository with all the // implied bits made explicit; e.g., `docker.io/library/alpine` // rather than `alpine`. // +optional