Elaborate how to enable autologin for registries

Squashed commits: follow the convention of using footer-style links I noticed that some links might not be good, and all of the new links added in this PR were not following the convention of link targets in the footer. Correct those issues. Signed-off-by: Kingdon Barrett <[email protected]> Update docs/spec/v1beta1/imagerepositories.md Signed-off-by: Kingdon Barrett <[email protected]> update docs Signed-off-by: Kingdon Barrett <[email protected]> Link to the Image Update guide When fluxcd/website#702 merges, this patch will have been incorporated into the Image Update Guide. Add a link to the more directly relevant Image Update Guide here instead, since it has the example, and it doesn't belong in the API docs nor need to be repeated here, per the discussion from the earlier PR number fluxcd#193. Signed-off-by: Kingdon Barrett <[email protected]> remove orphaned link URLs Signed-off-by: Kingdon Barrett <[email protected]>
kingdonb · Jan 27, 2022 · d79b2b8 · d79b2b8
1 parent cfbe030
commit d79b2b8
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/docs/spec/v1alpha2/imagerepositories.md b/docs/spec/v1alpha2/imagerepositories.md
@@ -122,7 +122,7 @@ type ImageRepositoryStatus struct {
 	// +optional
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
-	// CannonicalName is the name of the image repository with all the
+	// CanonicalImageName is the name of the image repository with all the
 	// implied bits made explicit; e.g., `docker.io/library/alpine`
 	// rather than `alpine`.
 	// +optional

diff --git a/docs/spec/v1beta1/imagerepositories.md b/docs/spec/v1beta1/imagerepositories.md
@@ -86,6 +86,14 @@ the flag is `--gcp-autologin-for-gcr`.
 For [<abbr title="Azure Kubernetes Service">AKS</abbr>][AKS] and [<abbr title="Azure Container Registry">ACR</abbr>][ACR],
 the flag is  `--azure-autologin-for-acr`.
 
+This flag can be added by including a patch in the `kustomization.yaml` overlay file in your `flux-system`,
+as described in [Using Native AWS ECR Auto-Login][]. If there is no need for a security boundary on your
+cluster around container registries and you are not using Flux with so-called "soft multi-tenancy", then
+you will likely prefer to use the Auto-Login feature for the convenience and improved ease of use.
+
+Alternatively, the advice to use a cron job to refresh a secret token under [Other platforms][other platforms]
+below will also work with ECR, GCR, and ACR environments that require security boundaries and soft multi-tenancy.
+
 #### Other platforms
 
 If you are running on another platform that links service permissions to service accounts, you will
@@ -195,7 +203,7 @@ type ImageRepositoryStatus struct {
 	// +optional
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
-	// CannonicalName is the name of the image repository with all the
+	// CanonicalImageName is the name of the image repository with all the
 	// implied bits made explicit; e.g., `docker.io/library/alpine`
 	// rather than `alpine`.
 	// +optional
@@ -209,7 +217,7 @@ type ImageRepositoryStatus struct {
 }
 ```
 
-The `CanonicalName` field gives the fully expanded image name, filling in any parts left implicit in
+The `CanonicalImageName` field gives the fully expanded image name, filling in any parts left implicit in
 the spec. For instance, `alpine` expands to `docker.io/library/alpine`.
 
 The `LastScanResult` field gives a summary of the most recent scan:
@@ -270,3 +278,5 @@ and reference it under `secretRef`.
 [GCR]: https://cloud.google.com/container-registry/docs/overview
 [AKS]: https://docs.microsoft.com/en-us/azure/aks/intro-kubernetes
 [ACR]: https://docs.microsoft.com/en-us/azure/container-registry/container-registry-intro
+[Using Native AWS ECR Auto-Login]: https://fluxcd.io/docs/guides/image-update/#using-native-aws-ecr-auto-login
+[other platforms]: https://fluxcd.io/docs/components/image/imagerepositories/#other-platforms