Skip to content

Commit

Permalink
docs(image-reflector-controller/docs/spec/v1beta1/imagerepositories.m…
Browse files Browse the repository at this point in the history
…d): elaborate on how to enable autologin for ECR

fluxcd/flux#1619
fluxcd/flux2#107
fluxcd#11
fluxcd#139
fluxcd#147
fluxcd#174
fluxcd#179
fluxcd#180
fluxcd/website#601
fluxcd#193
fluxcd/website#611
https://fluxcd.io/docs/guides/image-update/#aws-elastic-container-registry

Signed-off-by: lloydchang <lloydchang@gmail.com>
Signed-off-by: Kingdon Barrett <kingdon@weave.works>
  • Loading branch information
lloydchang authored and Kingdon Barrett committed Dec 16, 2021
1 parent 5c30c4b commit 9c125b5
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/spec/v1beta1/imagerepositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -98,7 +98,19 @@ patches:
value: --aws-autologin-for-ecr
```

Alternatively, the advice under "Other platforms" below will also work for ECR.
Alternatively, 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 Flux version 2 release [v0.19](https://github.com/fluxcd/flux2/releases/tag/v0.19.0) that contains the image-reflector-controller release [v0.13.0](https://github.com/fluxcd/image-reflector-controller/blob/main/CHANGELOG.md#0130).
> [**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 [Elastic Container Registry
(ECR)](https://docs.aws.amazon.com/AmazonECR/latest/userguide/what-is-ecr.html).
>
> Improvements:
> * Get credentials from AWS ECR when needed
> [#174](https://github.com/fluxcd/image-reflector-controller/pull/174)
#### Other platforms

Expand Down Expand Up @@ -209,7 +221,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
Expand Down

0 comments on commit 9c125b5

Please sign in to comment.