Merge pull request #3635 from petrutlucian94/clarify_imageset

Update ImageSet docstring
tigera · Dec 17, 2024 · 43f434b · 43f434b
2 parents a6d7b05 + de4409c
commit 43f434b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/api/v1/imageset_types.go b/api/v1/imageset_types.go
@@ -30,8 +30,11 @@ type ImageSetSpec struct {
 type Image struct {
 	// Image is an image that the operator deploys and instead of using the built in tag
 	// the operator will use the Digest for the image identifier.
-	// The value should be the image name without registry or tag or digest.
+	// The value should be the *original* image name without registry or tag or digest.
 	// For the image `docker.io/calico/node:v3.17.1` it should be represented as `calico/node`
+	// The "Installation" spec allows defining custom image registries, paths or prefixes.
+	// Even for custom images such as example.com/custompath/customprefix-calico-node:v3.17.1,
+	// this value should still be `calico/node`.
 	Image string `json:"image"`
 
 	// Digest is the image identifier that will be used for the Image.

diff --git a/pkg/crds/operator/operator.tigera.io_imagesets.yaml b/pkg/crds/operator/operator.tigera.io_imagesets.yaml
@@ -59,8 +59,11 @@ spec:
                       description: |-
                         Image is an image that the operator deploys and instead of using the built in tag
                         the operator will use the Digest for the image identifier.
-                        The value should be the image name without registry or tag or digest.
+                        The value should be the *original* image name without registry or tag or digest.
                         For the image `docker.io/calico/node:v3.17.1` it should be represented as `calico/node`
+                        The "Installation" spec allows defining custom image registries, paths or prefixes.
+                        Even for custom images such as example.com/custompath/customprefix-calico-node:v3.17.1,
+                        this value should still be `calico/node`.
                       type: string
                   required:
                   - digest