Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(image-reflector-controller/docs/spec/v1beta1/imagerepositories.md): elaborate on how to enable autologin for ECR #1

Merged
merged 1 commit into from
Oct 31, 2021
Merged

docs(image-reflector-controller/docs/spec/v1beta1/imagerepositories.md): elaborate on how to enable autologin for ECR #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions docs/spec/v1beta1/imagerepositories.md
View file
Open in desktop
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