feat: new field for image suffix in installation

api/v1/installation_types.go

@@ -40,7 +40,7 @@ type InstallationSpec struct {
 	// supported to explicitly specify the default registries will be used.
 	//
 	// Image format:
-	//    `<registry><imagePath>/<imagePrefix><imageName>:<image-tag>`
+	//    `<registry><imagePath>/<imagePrefix><imageName><imageSuffix>:<image-tag>`
 	//
 	// This option allows configuring the `<registry>` portion of the above format.
 	// +optional
@@ -53,7 +53,7 @@ type InstallationSpec struct {
 	// image path will be used for each image.
 	//
 	// Image format:
-	//    `<registry><imagePath>/<imagePrefix><imageName>:<image-tag>`
+	//    `<registry><imagePath>/<imagePrefix><imageName><imageSuffix>:<image-tag>`
 	//
 	// This option allows configuring the `<imagePath>` portion of the above format.
 	// +optional
@@ -66,12 +66,25 @@ type InstallationSpec struct {
 	// image prefix will be used for each image.
 	//
 	// Image format:
-	//    `<registry><imagePath>/<imagePrefix><imageName>:<image-tag>`
+	//    `<registry><imagePath>/<imagePrefix><imageName><imageSuffix>:<image-tag>`
 	//
 	// This option allows configuring the `<imagePrefix>` portion of the above format.
 	// +optional
 	ImagePrefix string `json:"imagePrefix,omitempty"`
 
+	// ImageSuffix allows for the suffix part of an image to be specified. If specified
+	// then the given value will be appended to each image name. If not specified, or if
+	// specified value is empty, no suffix will be appended.
+	// A special case value, UseDefault, is supported to explicitly specify the default
+	// image suffix will be used for each image.
+	//
+	// Image format:
+	// 		`<registry><imagePath>/<imagePrefix><imageName><imageSuffix>:<image-tag>`
+	//
+	// This option allows configuring the `<imageSuffix>` portion of the above format.
+	// +optional
+	ImageSuffix string `json:"imageSuffix,omitempty"`
+
 	// ImagePullSecrets is an array of references to container registry pull secrets to use. These are
 	// applied to all images to be pulled.
 	// +optional

main.go

@@ -138,7 +138,7 @@ func main() {
 			cmpnts = append(cmpnts, components.CommonImages...)
 
 			for _, x := range cmpnts {
-				ref, _ := components.GetReference(x, "", "", "", nil)
+				ref, _ := components.GetReference(x, "", "", "", "", nil)
 				fmt.Println(ref)
 			}
 			os.Exit(0)

pkg/components/images_test.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2019 Tigera, Inc. All rights reserved.
+// Copyright (c) 2019,2023 Tigera, Inc. All rights reserved.
 
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -28,7 +28,7 @@ var _ = Describe("test GetReference", func() {
 	Context("No registry override", func() {
 		DescribeTable("should render",
 			func(c component, registry, image string) {
-				Expect(GetReference(c, "", "", "", nil)).To(Equal(fmt.Sprintf("%s%s:%s", registry, image, c.Version)))
+				Expect(GetReference(c, "", "", "", "", nil)).To(Equal(fmt.Sprintf("%s%s:%s", registry, image, c.Version)))
 			},
 			Entry("a calico image correctly", ComponentCalicoNode, CalicoRegistry, "calico/node"),
 			Entry("a tigera image correctly", ComponentTigeraNode, TigeraRegistry, "tigera/cnx-node"),
@@ -42,7 +42,7 @@ var _ = Describe("test GetReference", func() {
 		DescribeTable("should render",
 			func(c component, registry, image string) {
 				ud := "UseDefault"
-				Expect(GetReference(c, ud, ud, "", nil)).To(Equal(fmt.Sprintf("%s%s:%s", registry, image, c.Version)))
+				Expect(GetReference(c, ud, ud, "", "", nil)).To(Equal(fmt.Sprintf("%s%s:%s", registry, image, c.Version)))
 			},
 			Entry("a calico image correctly", ComponentCalicoNode, CalicoRegistry, "calico/node"),
 			Entry("a tigera image correctly", ComponentTigeraNode, TigeraRegistry, "tigera/cnx-node"),
@@ -55,7 +55,7 @@ var _ = Describe("test GetReference", func() {
 	Context("registry override", func() {
 		DescribeTable("should render",
 			func(c component, image string) {
-				Expect(GetReference(c, "quay.io/", "", "", nil)).To(Equal(fmt.Sprintf("%s%s:%s", "quay.io/", image, c.Version)))
+				Expect(GetReference(c, "quay.io/", "", "", "", nil)).To(Equal(fmt.Sprintf("%s%s:%s", "quay.io/", image, c.Version)))
 			},
 			Entry("a calico image correctly", ComponentCalicoNode, "calico/node"),
 			Entry("a tigera image correctly", ComponentTigeraNode, "tigera/cnx-node"),
@@ -68,7 +68,7 @@ var _ = Describe("test GetReference", func() {
 	Context("image prefix override", func() {
 		DescribeTable("should render",
 			func(c component, image string) {
-				Expect(GetReference(c, "quay.io/", "", "pref", nil)).To(Equal(fmt.Sprintf("quay.io/%s:%s", image, c.Version)))
+				Expect(GetReference(c, "quay.io/", "", "pref", "", nil)).To(Equal(fmt.Sprintf("quay.io/%s:%s", image, c.Version)))
 			},
 			Entry("a calico image correctly", ComponentCalicoNode, "calico/prefnode"),
 			Entry("a tigera image correctly", ComponentTigeraNode, "tigera/prefcnx-node"),
@@ -81,7 +81,7 @@ var _ = Describe("test GetReference", func() {
 	Context("imagepath override", func() {
 		DescribeTable("should render",
 			func(c component, registry, image string) {
-				Expect(GetReference(c, "", "userpath", "", nil)).To(Equal(fmt.Sprintf("%s%s:%s", registry, image, c.Version)))
+				Expect(GetReference(c, "", "userpath", "", "", nil)).To(Equal(fmt.Sprintf("%s%s:%s", registry, image, c.Version)))
 			},
 			Entry("a calico image correctly", ComponentCalicoNode, CalicoRegistry, "userpath/node"),
 			Entry("a tigera image correctly", ComponentTigeraNode, TigeraRegistry, "userpath/cnx-node"),
@@ -93,7 +93,7 @@ var _ = Describe("test GetReference", func() {
 	Context("registry and imagepath override", func() {
 		DescribeTable("should render",
 			func(c component, image string) {
-				Expect(GetReference(c, "quay.io/extra/", "userpath", "", nil)).To(Equal(fmt.Sprintf("quay.io/extra/%s:%s", image, c.Version)))
+				Expect(GetReference(c, "quay.io/extra/", "userpath", "", "", nil)).To(Equal(fmt.Sprintf("quay.io/extra/%s:%s", image, c.Version)))
 			},
 			Entry("a calico image correctly", ComponentCalicoNode, "userpath/node"),
 			Entry("a tigera image correctly", ComponentTigeraNode, "userpath/cnx-node"),
@@ -116,7 +116,7 @@ var _ = Describe("test GetReference", func() {
 						},
 					},
 				}
-				Expect(GetReference(c, "quay.io/extra/", "userpath", "", is)).To(Equal(fmt.Sprintf("quay.io/extra/%s%s", image, hash)))
+				Expect(GetReference(c, "quay.io/extra/", "userpath", "", "", is)).To(Equal(fmt.Sprintf("quay.io/extra/%s%s", image, hash)))
 			},
 			Entry("a calico image correctly", ComponentCalicoNode, "userpath/node", "@sha256:caliconodehash"),
 			Entry("a tigera image correctly", ComponentTigeraNode, "userpath/cnx-node", "@sha256:tigeracnxnodehash"),

pkg/components/references.go

@@ -34,7 +34,7 @@ type component struct {
 const UseDefault = "UseDefault"
 
 // GetReference returns the fully qualified image to use, including registry and version.
-func GetReference(c component, registry, imagePath, imagePrefix string, is *operator.ImageSet) (string, error) {
+func GetReference(c component, registry, imagePath, imagePrefix, imageSuffix string, is *operator.ImageSet) (string, error) {
 	// If a user did not supply a registry, use the default registry
 	// based on component
 	if registry == "" || registry == UseDefault {
@@ -80,6 +80,9 @@ func GetReference(c component, registry, imagePath, imagePrefix string, is *oper
 	if imagePath != "" && imagePath != UseDefault {
 		image = ReplaceImagePath(image, imagePath)
 	}
+	if imageSuffix != "" && imageSuffix != UseDefault {
+		image = appendSuffix(image, imageSuffix)
+	}
 
 	if is == nil {
 		return fmt.Sprintf("%s%s:%s", registry, image, c.Version), nil
@@ -111,3 +114,7 @@ func insertPrefix(image, prefix string) string {
 	subs = append(subs[:len(subs)-1], fmt.Sprintf("%s%s", prefix, subs[len(subs)-1]))
 	return strings.Join(subs, "/")
 }
+
+func appendSuffix(image, suffix string) string {
+	return fmt.Sprintf("%s%s", image, suffix)
+}

pkg/controller/certificatemanager/certificatemanager.go

@@ -161,6 +161,7 @@ func Create(cli client.Client, installation *operatorv1.InstallationSpec, cluste
 			installation.Registry,
 			installation.ImagePath,
 			installation.ImagePrefix,
+			installation.ImageSuffix,
 			imageSet,
 		)
 		if err != nil {

pkg/controller/certificatemanager/certificatemanager_test.go

@@ -407,6 +407,7 @@ var _ = Describe("Test CertificateManagement suite", func() {
 				installation.Registry,
 				installation.ImagePath,
 				installation.ImagePrefix,
+				installation.ImageSuffix,
 				imageSet,
 			)
 			Expect(err).NotTo(HaveOccurred())

pkg/crds/operator/operator.tigera.io_installations.yaml

@@ -6974,7 +6974,7 @@ spec:
                   the image path for each image. If not specified or empty, the default
                   for each image will be used. A special case value, UseDefault, is
                   supported to explicitly specify the default image path will be used
-                  for each image. \n Image format: `<registry><imagePath>/<imagePrefix><imageName>:<image-tag>`
+                  for each image. \n Image format: `<registry><imagePath>/<imagePrefix><imageName><imageSuffix>:<image-tag>`
                   \n This option allows configuring the `<imagePath>` portion of the
                   above format."
                 type: string
@@ -6984,7 +6984,7 @@ spec:
                   a prefix on each image. If not specified or empty, no prefix will
                   be used. A special case value, UseDefault, is supported to explicitly
                   specify the default image prefix will be used for each image. \n
-                  Image format: `<registry><imagePath>/<imagePrefix><imageName>:<image-tag>`
+                  Image format: `<registry><imagePath>/<imagePrefix><imageName><imageSuffix>:<image-tag>`
                   \n This option allows configuring the `<imagePrefix>` portion of
                   the above format."
                 type: string
@@ -7003,6 +7003,14 @@ spec:
                   type: object
                   x-kubernetes-map-type: atomic
                 type: array
+              imageSuffix:
+                description: "ImageSuffix allows for the suffix part of an image to
+                  be specified. If specified then the given value will be appended
+                  to each image name. If not specified, or if specified value is empty,
+                  no suffix will be appended. \n Image format: `<registry><imagePath>/<imagePrefix><imageName><imageSuffix>:<image-tag>`
+                  \n This option allows configuring the `<imageSuffix>` portion of
+                  the above format."
+                type: string
               kubeletVolumePluginPath:
                 description: 'KubeletVolumePluginPath optionally specifies enablement
                   of Calico CSI plugin. If not specified, CSI will be enabled by default.
@@ -7136,7 +7144,7 @@ spec:
                   slash character (`/`) and all images will be pulled from this registry.
                   If not specified then the default registries will be used. A special
                   case value, UseDefault, is supported to explicitly specify the default
-                  registries will be used. \n Image format: `<registry><imagePath>/<imagePrefix><imageName>:<image-tag>`
+                  registries will be used. \n Image format: `<registry><imagePath>/<imagePrefix><imageName><imageSuffix>:<image-tag>`
                   \n This option allows configuring the `<registry>` portion of the
                   above format."
                 type: string
@@ -16481,7 +16489,7 @@ spec:
                       used as the image path for each image. If not specified or empty,
                       the default for each image will be used. A special case value,
                       UseDefault, is supported to explicitly specify the default image
-                      path will be used for each image. \n Image format: `<registry><imagePath>/<imagePrefix><imageName>:<image-tag>`
+                      path will be used for each image. \n Image format: `<registry><imagePath>/<imagePrefix><imageName><imageSuffix>:<image-tag>`
                       \n This option allows configuring the `<imagePath>` portion
                       of the above format."
                     type: string
@@ -16491,7 +16499,7 @@ spec:
                       as a prefix on each image. If not specified or empty, no prefix
                       will be used. A special case value, UseDefault, is supported
                       to explicitly specify the default image prefix will be used
-                      for each image. \n Image format: `<registry><imagePath>/<imagePrefix><imageName>:<image-tag>`
+                      for each image. \n Image format: `<registry><imagePath>/<imagePrefix><imageName><imageSuffix>:<image-tag>`
                       \n This option allows configuring the `<imagePrefix>` portion
                       of the above format."
                     type: string
@@ -16510,6 +16518,14 @@ spec:
                       type: object
                       x-kubernetes-map-type: atomic
                     type: array
+                  imageSuffix:
+                    description: "ImageSuffix allows for the suffix part of an image
+                      to be specified. If specified then the given value will be appended
+                      to each image name. If not specified, or if specified value
+                      is empty, no suffix will be appended. \n Image format: `<registry><imagePath>/<imagePrefix><imageName><imageSuffix>:<image-tag>`
+                      \n This option allows configuring the `<imageSuffix>` portion
+                      of the above format."
+                    type: string
                   kubeletVolumePluginPath:
                     description: 'KubeletVolumePluginPath optionally specifies enablement
                       of Calico CSI plugin. If not specified, CSI will be enabled
@@ -16649,7 +16665,7 @@ spec:
                       from this registry. If not specified then the default registries
                       will be used. A special case value, UseDefault, is supported
                       to explicitly specify the default registries will be used. \n
-                      Image format: `<registry><imagePath>/<imagePrefix><imageName>:<image-tag>`
+                      Image format: `<registry><imagePath>/<imagePrefix><imageName><imageSuffix>:<image-tag>`
                       \n This option allows configuring the `<registry>` portion of
                       the above format."
                     type: string

pkg/render/amazoncloudintegration.go

@@ -63,8 +63,9 @@ func (c *amazonCloudIntegrationComponent) ResolveImages(is *operatorv1.ImageSet)
 	reg := c.cfg.Installation.Registry
 	path := c.cfg.Installation.ImagePath
 	prefix := c.cfg.Installation.ImagePrefix
+	suffix := c.cfg.Installation.ImageSuffix
 	var err error
-	c.image, err = components.GetReference(components.ComponentCloudControllers, reg, path, prefix, is)
+	c.image, err = components.GetReference(components.ComponentCloudControllers, reg, path, prefix, suffix, is)
 	return err
 }
 

pkg/render/apiserver.go

@@ -133,26 +133,27 @@ func (c *apiServerComponent) ResolveImages(is *operatorv1.ImageSet) error {
 	reg := c.cfg.Installation.Registry
 	path := c.cfg.Installation.ImagePath
 	prefix := c.cfg.Installation.ImagePrefix
+	suffix := c.cfg.Installation.ImageSuffix
 	var err error
 	errMsgs := []string{}
 
 	if c.cfg.Installation.Variant == operatorv1.TigeraSecureEnterprise {
-		c.apiServerImage, err = components.GetReference(components.ComponentAPIServer, reg, path, prefix, is)
+		c.apiServerImage, err = components.GetReference(components.ComponentAPIServer, reg, path, prefix, suffix, is)
 		if err != nil {
 			errMsgs = append(errMsgs, err.Error())
 		}
-		c.queryServerImage, err = components.GetReference(components.ComponentQueryServer, reg, path, prefix, is)
+		c.queryServerImage, err = components.GetReference(components.ComponentQueryServer, reg, path, prefix, suffix, is)
 		if err != nil {
 			errMsgs = append(errMsgs, err.Error())
 		}
 	} else {
 		if operatorv1.IsFIPSModeEnabled(c.cfg.Installation.FIPSMode) {
-			c.apiServerImage, err = components.GetReference(components.ComponentCalicoAPIServerFIPS, reg, path, prefix, is)
+			c.apiServerImage, err = components.GetReference(components.ComponentCalicoAPIServerFIPS, reg, path, prefix, suffix, is)
 			if err != nil {
 				errMsgs = append(errMsgs, err.Error())
 			}
 		} else {
-			c.apiServerImage, err = components.GetReference(components.ComponentCalicoAPIServer, reg, path, prefix, is)
+			c.apiServerImage, err = components.GetReference(components.ComponentCalicoAPIServer, reg, path, prefix, suffix, is)
 			if err != nil {
 				errMsgs = append(errMsgs, err.Error())
 			}

pkg/render/applicationlayer/applicationlayer.go

@@ -114,6 +114,7 @@ func (c *component) ResolveImages(is *operatorv1.ImageSet) error {
 	reg := c.config.Installation.Registry
 	path := c.config.Installation.ImagePath
 	prefix := c.config.Installation.ImagePrefix
+	suffix := c.config.Installation.ImageSuffix
 
 	if c.config.OsType != c.SupportedOSType() {
 		return fmt.Errorf("layer 7 features are supported only on %s", c.SupportedOSType())
@@ -122,17 +123,17 @@ func (c *component) ResolveImages(is *operatorv1.ImageSet) error {
 	var err error
 	var errMsgs []string
 
-	c.config.proxyImage, err = components.GetReference(components.ComponentEnvoyProxy, reg, path, prefix, is)
+	c.config.proxyImage, err = components.GetReference(components.ComponentEnvoyProxy, reg, path, prefix, suffix, is)
 	if err != nil {
 		errMsgs = append(errMsgs, err.Error())
 	}
 
-	c.config.collectorImage, err = components.GetReference(components.ComponentL7Collector, reg, path, prefix, is)
+	c.config.collectorImage, err = components.GetReference(components.ComponentL7Collector, reg, path, prefix, suffix, is)
 	if err != nil {
 		errMsgs = append(errMsgs, err.Error())
 	}
 
-	c.config.dikastesImage, err = components.GetReference(components.ComponentDikastes, reg, path, prefix, is)
+	c.config.dikastesImage, err = components.GetReference(components.ComponentDikastes, reg, path, prefix, suffix, is)
 	if err != nil {
 		errMsgs = append(errMsgs, err.Error())
 	}

pkg/render/aws-securitygroup-setup.go

@@ -51,8 +51,9 @@ func (c *awsSGSetupComponent) ResolveImages(is *operatorv1.ImageSet) error {
 	reg := c.cfg.Installation.Registry
 	path := c.cfg.Installation.ImagePath
 	prefix := c.cfg.Installation.ImagePrefix
+	suffix := c.cfg.Installation.ImageSuffix
 	var err error
-	c.image, err = components.GetReference(components.ComponentOperatorInit, reg, path, prefix, is)
+	c.image, err = components.GetReference(components.ComponentOperatorInit, reg, path, prefix, suffix, is)
 	return err
 }
 

pkg/render/compliance.go

@@ -141,30 +141,31 @@ func (c *complianceComponent) ResolveImages(is *operatorv1.ImageSet) error {
 	reg := c.cfg.Installation.Registry
 	path := c.cfg.Installation.ImagePath
 	prefix := c.cfg.Installation.ImagePrefix
+	suffix := c.cfg.Installation.ImageSuffix
 	var err error
-	c.benchmarkerImage, err = components.GetReference(components.ComponentComplianceBenchmarker, reg, path, prefix, is)
+	c.benchmarkerImage, err = components.GetReference(components.ComponentComplianceBenchmarker, reg, path, prefix, suffix, is)
 
 	errMsgs := []string{}
 	if err != nil {
 		errMsgs = append(errMsgs, err.Error())
 	}
 
-	c.snapshotterImage, err = components.GetReference(components.ComponentComplianceSnapshotter, reg, path, prefix, is)
+	c.snapshotterImage, err = components.GetReference(components.ComponentComplianceSnapshotter, reg, path, prefix, suffix, is)
 	if err != nil {
 		errMsgs = append(errMsgs, err.Error())
 	}
 
-	c.serverImage, err = components.GetReference(components.ComponentComplianceServer, reg, path, prefix, is)
+	c.serverImage, err = components.GetReference(components.ComponentComplianceServer, reg, path, prefix, suffix, is)
 	if err != nil {
 		errMsgs = append(errMsgs, err.Error())
 	}
 
-	c.controllerImage, err = components.GetReference(components.ComponentComplianceController, reg, path, prefix, is)
+	c.controllerImage, err = components.GetReference(components.ComponentComplianceController, reg, path, prefix, suffix, is)
 	if err != nil {
 		errMsgs = append(errMsgs, err.Error())
 	}
 
-	c.reporterImage, err = components.GetReference(components.ComponentComplianceReporter, reg, path, prefix, is)
+	c.reporterImage, err = components.GetReference(components.ComponentComplianceReporter, reg, path, prefix, suffix, is)
 	if err != nil {
 		errMsgs = append(errMsgs, err.Error())
 	}