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
  • Loading branch information
lloydchang committed Oct 31, 2021
1 parent 2d05314 commit 44baa4c
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 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 All @@ -78,8 +78,21 @@ For a publicly accessible image repository, you will not need to provide a `secr
When running in [<abbr title="Elastic Kubernetes Service">EKS</abbr>][EKS] and using [<abbr
title="Elastic Container Registry">ECR</abbr>][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

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 44baa4c

Please sign in to comment.