Move ContainerImage field from GlanceAPITemplate to GlanceAPI spec

Previously, the ContainerImage field was defined in the shared
GlanceAPITemplate struct and inherited by both Glance and GlanceAPI
resources. This commit moves the ContainerImage field to the GlanceAPI spec,
removing it from the common template.
As a result of that, the field is hidden (like every other service) from
the main openstack control plane CR.

Author: fmount

api/bases/glance.openstack.org_glanceapis.yaml

@@ -66,8 +66,7 @@ spec:
                 - edge
                 type: string
               containerImage:
-                description: Glance Container Image URL (will be set to environmental
-                  default if empty)
+                description: ContainerImage - GlanceAPI Container Image URL
                 type: string
               customServiceConfig:
                 description: |-

api/bases/glance.openstack.org_glances.yaml

@@ -1229,10 +1229,6 @@ spec:
                         APITimeout
                       minimum: 1
                       type: integer
-                    containerImage:
-                      description: Glance Container Image URL (will be set to environmental
-                        default if empty)
-                      type: string
                     customServiceConfig:
                       description: |-
                         CustomServiceConfig - customize the service config using this parameter to change service defaults,
@@ -1578,8 +1574,6 @@ spec:
                       - single
                       - edge
                       type: string
-                  required:
-                  - containerImage
                   type: object
                 default: {}
                 description: GlanceAPIs - Spec definition for the API service of this

api/v1beta1/common_types.go

@@ -54,10 +54,6 @@ type GlanceAPITemplate struct {
 	// Replicas of glance API to run
 	Replicas *int32 `json:"replicas"`
 
-	// +kubebuilder:validation:Required
-	// Glance Container Image URL (will be set to environmental default if empty)
-	ContainerImage string `json:"containerImage"`
-
 	// +kubebuilder:validation:Optional
 	// NodeSelector to target subset of worker nodes running this service
 	NodeSelector *map[string]string `json:"nodeSelector,omitempty"`

api/v1beta1/glance_webhook.go

@@ -66,6 +66,9 @@ var _ webhook.Defaulter = &Glance{}
 func (r *Glance) Default() {
 	glancelog.Info("default", "name", r.Name)
 
+	// .Spec.ContainerImage is inherited by all the GlanceAPI instances.
+	// It's not supported to deploy different ContainerImages for different
+	// instances.
 	if len(r.Spec.ContainerImage) == 0 {
 		r.Spec.ContainerImage = glanceDefaults.ContainerImageURL
 	}
@@ -116,7 +119,7 @@ func (r *GlanceSpecCore) Default() {
 	// build a "CustomServiceConfig" template that should be
 	// customized: by doing this we force to provide the
 	// required parameters
-	if r.GlanceAPIs == nil || len(r.GlanceAPIs) == 0 {
+	if len(r.GlanceAPIs) == 0 {
 		// keystoneEndpoint will match with the only instance
 		// deployed by default
 		r.KeystoneEndpoint = "default"
@@ -129,11 +132,6 @@ func (r *GlanceSpecCore) Default() {
 	}
 
 	for key, glanceAPI := range r.GlanceAPIs {
-		// Check the sub-cr ContainerImage parameter
-		if glanceAPI.ContainerImage == "" {
-			glanceAPI.ContainerImage = glanceDefaults.ContainerImageURL
-			r.GlanceAPIs[key] = glanceAPI
-		}
 		if glanceAPI.ImageCache.CleanerScheduler == "" {
 			glanceAPI.ImageCache.CleanerScheduler = glanceDefaults.CleanerSchedule
 			r.GlanceAPIs[key] = glanceAPI

api/v1beta1/glanceapi_types.go

@@ -38,6 +38,10 @@ type GlanceAPISpec struct {
 	// Input parameter coming from glance template
 	GlanceAPITemplate `json:",inline"`
 
+	// +kubebuilder:validation:Required
+	// ContainerImage - GlanceAPI Container Image URL
+	ContainerImage string `json:"containerImage"`
+
 	// +kubebuilder:validation:Optional
 	// +kubebuilder:validation:Enum=internal;external;single;edge
 	// +kubebuilder:default=external

api/v1beta1/glanceapi_webhook.go

@@ -53,8 +53,8 @@ func (r *GlanceAPI) Default() {
 
 // Default - set defaults for this Glance spec
 func (spec *GlanceAPISpec) Default() {
-	if spec.GlanceAPITemplate.ContainerImage == "" {
-		spec.GlanceAPITemplate.ContainerImage = glanceAPIDefaults.ContainerImageURL
+	if spec.ContainerImage == "" {
+		spec.ContainerImage = glanceAPIDefaults.ContainerImageURL
 	}
 }
 

config/crd/bases/glance.openstack.org_glanceapis.yaml

@@ -66,8 +66,7 @@ spec:
                 - edge
                 type: string
               containerImage:
-                description: Glance Container Image URL (will be set to environmental
-                  default if empty)
+                description: ContainerImage - GlanceAPI Container Image URL
                 type: string
               customServiceConfig:
                 description: |-

config/crd/bases/glance.openstack.org_glances.yaml

@@ -1229,10 +1229,6 @@ spec:
                         APITimeout
                       minimum: 1
                       type: integer
-                    containerImage:
-                      description: Glance Container Image URL (will be set to environmental
-                        default if empty)
-                      type: string
                     customServiceConfig:
                       description: |-
                         CustomServiceConfig - customize the service config using this parameter to change service defaults,
@@ -1578,8 +1574,6 @@ spec:
                       - single
                       - edge
                       type: string
-                  required:
-                  - containerImage
                   type: object
                 default: {}
                 description: GlanceAPIs - Spec definition for the API service of this

internal/controller/glance_controller.go

@@ -269,7 +269,7 @@ func (r *GlanceReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manage
 	// TransportURL created and used by Glance CRs.
 	transportURLSecretFn := func(_ context.Context, o client.Object) []reconcile.Request {
 		result := []reconcile.Request{}
-		// get all Manila CRs
+		// get all Glance CRs
 		glances := &glancev1.GlanceList{}
 		listOpts := []client.ListOption{
 			client.InNamespace(o.GetNamespace()),
@@ -950,6 +950,7 @@ func (r *GlanceReconciler) apiDeploymentCreateOrUpdate(
 	apiSpec := glancev1.GlanceAPISpec{
 		GlanceAPITemplate:     apiTemplate,
 		APIType:               apiType,
+		ContainerImage:        instance.Spec.ContainerImage,
 		DatabaseHostname:      instance.Status.DatabaseHostname,
 		DatabaseAccount:       instance.Spec.DatabaseAccount,
 		Secret:                instance.Spec.Secret,

test/functional/glance_controller_test.go

@@ -127,12 +127,7 @@ var _ = Describe("Glance controller", func() {
 			// (Updates) We let the Glance webhooks override the top-level CR
 			// ContainerImage, but we pass an override for each glanceAPI
 			// instance, so we can manage them independently
-			Expect(glance.Spec.ContainerImage).To(Equal(glancev1.GlanceAPIContainerImage))
-			for _, api := range glance.Spec.GlanceAPIs {
-				// We expect the containerImage enforced in the Spec by GlanceAPI()
-				// function
-				Expect(api.ContainerImage).To(Equal(glanceTest.ContainerImage))
-			}
+			Expect(glance.Spec.ContainerImage).To(Equal(util.GetEnvVar("RELATED_IMAGE_GLANCE_API_IMAGE_URL_DEFAULT", glancev1.GlanceAPIContainerImage)))
 		})
 		It("should not have a pvc yet", func() {
 			AssertPVCDoesNotExist(glanceTest.Instance)
@@ -254,12 +249,6 @@ var _ = Describe("Glance controller", func() {
 			DeferCleanup(infra.DeleteMemcached, infra.CreateMemcached(namespace, glanceTest.MemcachedInstance, memcachedSpec))
 			infra.SimulateMemcachedReady(glanceTest.GlanceMemcached)
 		})
-		It("has the expected container image defaults", func() {
-			glanceDefault := GetGlance(glanceTest.Instance)
-			for _, api := range glanceDefault.Spec.GlanceAPIs {
-				Expect(api.ContainerImage).To(Equal(util.GetEnvVar("RELATED_IMAGE_GLANCE_API_IMAGE_URL_DEFAULT", glancev1.GlanceAPIContainerImage)))
-			}
-		})
 		It("has a dummy backend set when and empty spec is passed", func() {
 			glanceDefault := GetGlance(glanceTest.Instance)
 			Expect(glanceDefault.Spec.CustomServiceConfig).To((ContainSubstring(GlanceDummyBackend)))