Support changing all the images

Currently we can only change the image for the RAG using the `ragImage`
field in our CR, but we have many other images subject to change.

In this patch we add functionality to change the images used by the
operator for the following:

- lighspeed-core
- exporter
- postgres
- console image
- OKP image
- RHOS MCP server

To provide a consistent interface we can now set all the images under
the `images` field and we remove the top level `ragImage` field (now
available under `images`) for consistency.

Removing the field should not be a problem since we don't have a stable
CRD yet.

Author: Akrog

api/v1beta1/openstacklightspeed_types.go

@@ -17,6 +17,8 @@ limitations under the License.
 package v1beta1
 
 import (
+	"reflect"
+
 	"github.com/openstack-k8s-operators/lib-common/modules/common/condition"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/util"
 	"k8s.io/apimachinery/pkg/api/resource"
@@ -99,8 +101,9 @@ type OpenStackLightspeedSpec struct {
 	OpenStackLightspeedCore `json:",inline"`
 
 	// +kubebuilder:validation:Optional
-	// ContainerImage for the OpenStack Lightspeed RAG container (will be set to environmental default if empty)
-	RAGImage string `json:"ragImage"`
+	// Images configures container images used by the operator.
+	// When omitted, each image defaults to its environment variable or hardcoded fallback.
+	Images OpenStackLightspeedImages `json:"images,omitempty"`
 
 	// +kubebuilder:validation:Optional
 	// +kubebuilder:default=false
@@ -289,42 +292,74 @@ func (instance OpenStackLightspeed) IsReady() bool {
 	return instance.Status.Conditions.IsTrue(OpenStackLightspeedReadyCondition)
 }
 
+// OpenStackLightspeedImages groups container image URLs used by the operator.
+type OpenStackLightspeedImages struct {
+	RAGImageURL        string `json:"ragImage,omitempty"`
+	LCoreImageURL      string `json:"lcoreImage,omitempty"`
+	ExporterImageURL   string `json:"exporterImage,omitempty"`
+	PostgresImageURL   string `json:"postgresImage,omitempty"`
+	ConsoleImageURL    string `json:"consoleImage,omitempty"`
+	ConsoleImagePF5URL string `json:"consoleImagePF5,omitempty"`
+	OKPImageURL        string `json:"okpImage,omitempty"`
+	MCPServerImageURL  string `json:"mcpServerImage,omitempty"`
+}
+
 type OpenStackLightspeedDefaults struct {
-	RAGImageURL          string
-	LCoreImageURL        string
-	ExporterImageURL     string
-	PostgresImageURL     string
-	ConsoleImageURL      string
-	ConsoleImagePF5URL   string
-	OKPImageURL          string
-	MCPServerImageURL    string
-	MaxTokensForResponse int
+	OpenStackLightspeedImages `json:",inline"`
+	MaxTokensForResponse      int `json:"maxTokensForResponse,omitempty"`
 }
 
 var OpenStackLightspeedDefaultValues OpenStackLightspeedDefaults
 
-// SetupDefaults - initializes OpenStackLightspeedDefaultValues with default values from env vars
+// envVarDefaults holds the pristine env-var defaults set once by SetupDefaults.
+// MergeDefaults copies from this so that removing dev overrides correctly
+// reverts to the original values (the exported global gets overwritten each reconcile).
+var envVarDefaults OpenStackLightspeedDefaults
+
+// mergeImages applies non-zero fields from src onto dst.
+func mergeImages(dst, src *OpenStackLightspeedImages) {
+	dstVal := reflect.ValueOf(dst).Elem()
+	srcVal := reflect.ValueOf(src).Elem()
+	for i := 0; i < srcVal.NumField(); i++ {
+		if !srcVal.Field(i).IsZero() {
+			dstVal.Field(i).Set(srcVal.Field(i))
+		}
+	}
+}
+
+// SetupDefaults initializes OpenStackLightspeedDefaultValues from env vars.
+// Call once at startup; the values never change inside a container.
 func SetupDefaults() {
-	// Acquire environmental defaults and initialize OpenStackLightspeed defaults with them
-	openStackLightspeedDefaults := OpenStackLightspeedDefaults{
-		RAGImageURL: util.GetEnvVar(
-			"RELATED_IMAGE_OPENSTACK_LIGHTSPEED_IMAGE_URL_DEFAULT", OpenStackLightspeedContainerImage),
-		LCoreImageURL: util.GetEnvVar(
-			"RELATED_IMAGE_LCORE_IMAGE_URL_DEFAULT", LCoreContainerImage),
-		ExporterImageURL: util.GetEnvVar(
-			"RELATED_IMAGE_EXPORTER_IMAGE_URL_DEFAULT", ExporterContainerImage),
-		PostgresImageURL: util.GetEnvVar(
-			"RELATED_IMAGE_POSTGRES_IMAGE_URL_DEFAULT", PostgresContainerImage),
-		ConsoleImageURL: util.GetEnvVar(
-			"RELATED_IMAGE_CONSOLE_IMAGE_URL_DEFAULT", ConsoleContainerImage),
-		ConsoleImagePF5URL: util.GetEnvVar(
-			"RELATED_IMAGE_CONSOLE_PF5_IMAGE_URL_DEFAULT", ConsoleContainerImagePF5),
-		OKPImageURL: util.GetEnvVar(
-			"RELATED_IMAGE_OKP_IMAGE_URL_DEFAULT", OKPContainerImage),
-		MCPServerImageURL: util.GetEnvVar(
-			"RELATED_IMAGE_MCP_SERVER_IMAGE_URL_DEFAULT", MCPServerContainerImage),
+	envVarDefaults = OpenStackLightspeedDefaults{
+		OpenStackLightspeedImages: OpenStackLightspeedImages{
+			RAGImageURL: util.GetEnvVar(
+				"RELATED_IMAGE_OPENSTACK_LIGHTSPEED_IMAGE_URL_DEFAULT", OpenStackLightspeedContainerImage),
+			LCoreImageURL: util.GetEnvVar(
+				"RELATED_IMAGE_LCORE_IMAGE_URL_DEFAULT", LCoreContainerImage),
+			ExporterImageURL: util.GetEnvVar(
+				"RELATED_IMAGE_EXPORTER_IMAGE_URL_DEFAULT", ExporterContainerImage),
+			PostgresImageURL: util.GetEnvVar(
+				"RELATED_IMAGE_POSTGRES_IMAGE_URL_DEFAULT", PostgresContainerImage),
+			ConsoleImageURL: util.GetEnvVar(
+				"RELATED_IMAGE_CONSOLE_IMAGE_URL_DEFAULT", ConsoleContainerImage),
+			ConsoleImagePF5URL: util.GetEnvVar(
+				"RELATED_IMAGE_CONSOLE_PF5_IMAGE_URL_DEFAULT", ConsoleContainerImagePF5),
+			OKPImageURL: util.GetEnvVar(
+				"RELATED_IMAGE_OKP_IMAGE_URL_DEFAULT", OKPContainerImage),
+			MCPServerImageURL: util.GetEnvVar(
+				"RELATED_IMAGE_MCP_SERVER_IMAGE_URL_DEFAULT", MCPServerContainerImage),
+		},
 		MaxTokensForResponse: MaxTokensForResponseDefault,
 	}
+	OpenStackLightspeedDefaultValues = envVarDefaults
+}
 
-	OpenStackLightspeedDefaultValues = openStackLightspeedDefaults
+// MergeDefaults returns a copy of the env-var defaults with the spec image
+// overrides (if any) applied on top.
+func MergeDefaults(specImages *OpenStackLightspeedImages) OpenStackLightspeedDefaults {
+	merged := envVarDefaults
+	if specImages != nil {
+		mergeImages(&merged.OpenStackLightspeedImages, specImages)
+	}
+	return merged
 }

api/v1beta1/openstacklightspeed_types_test.go

@@ -0,0 +1,132 @@
+/*
+Copyright 2025.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1beta1
+
+import (
+	"fmt"
+	"reflect"
+	"testing"
+)
+
+// TestOpenStackLightspeedImagesFieldTypes guards the mergeImages
+// reflection-based implementation against future struct changes.
+// mergeImages uses reflect and IsZero to copy non-zero fields; this
+// only works correctly for simple types (string, int) where the zero
+// value reliably means "not set". Adding an unexported field, or a
+// complex type (slice, map, pointer, struct), would cause silent
+// misbehavior or a panic.
+func TestOpenStackLightspeedImagesFieldTypes(t *testing.T) {
+	allowedKinds := map[reflect.Kind]bool{
+		reflect.String: true,
+	}
+
+	typ := reflect.TypeOf(OpenStackLightspeedImages{})
+	for i := 0; i < typ.NumField(); i++ {
+		field := typ.Field(i)
+
+		if !field.IsExported() {
+			t.Errorf("field %q is unexported; mergeImages uses reflect to set fields "+
+				"and cannot write unexported fields (will panic)", field.Name)
+			continue
+		}
+
+		if !allowedKinds[field.Type.Kind()] {
+			t.Errorf("field %q has type %s (kind %s); mergeImages relies on IsZero "+
+				"to detect unset values, which is only reliable for string — "+
+				"add handling in mergeImages before using this type",
+				field.Name, field.Type, field.Type.Kind())
+		}
+	}
+}
+
+func TestMergeImages(t *testing.T) {
+	dst := OpenStackLightspeedImages{
+		RAGImageURL:   "original-rag",
+		LCoreImageURL: "original-lcore",
+	}
+	src := OpenStackLightspeedImages{
+		RAGImageURL:       "override-rag",
+		ExporterImageURL:  "override-exporter",
+		MCPServerImageURL: "override-mcp",
+	}
+
+	mergeImages(&dst, &src)
+
+	checks := []struct {
+		name string
+		got  string
+		want string
+	}{
+		{"RAGImageURL (overridden)", dst.RAGImageURL, "override-rag"},
+		{"LCoreImageURL (kept)", dst.LCoreImageURL, "original-lcore"},
+		{"ExporterImageURL (set from zero)", dst.ExporterImageURL, "override-exporter"},
+		{"MCPServerImageURL (set from zero)", dst.MCPServerImageURL, "override-mcp"},
+		{"PostgresImageURL (both zero)", dst.PostgresImageURL, ""},
+	}
+	for _, tc := range checks {
+		if tc.got != tc.want {
+			t.Errorf("%s: got %q, want %q", tc.name, tc.got, tc.want)
+		}
+	}
+}
+
+func TestMergeImages_EmptySrc(t *testing.T) {
+	dst := OpenStackLightspeedImages{
+		RAGImageURL: "keep-this",
+	}
+	src := OpenStackLightspeedImages{}
+
+	mergeImages(&dst, &src)
+
+	if dst.RAGImageURL != "keep-this" {
+		t.Errorf("RAGImageURL changed unexpectedly to %q", dst.RAGImageURL)
+	}
+}
+
+func TestMergeDefaults_GlobalWriteBackDoesNotCorruptBase(t *testing.T) {
+	SetupDefaults()
+	original := OpenStackLightspeedDefaultValues
+
+	specImages := &OpenStackLightspeedImages{RAGImageURL: "custom-rag"}
+	merged := MergeDefaults(specImages)
+	OpenStackLightspeedDefaultValues = merged
+
+	reverted := MergeDefaults(nil)
+	if reverted.RAGImageURL != original.RAGImageURL {
+		t.Errorf("RAGImageURL not reverted: got %q, want %q",
+			reverted.RAGImageURL, original.RAGImageURL)
+	}
+}
+
+func TestMergeImages_AllFields(t *testing.T) {
+	// Verify mergeImages touches every field by setting all src fields
+	// to non-zero and confirming they all arrive in dst.
+	typ := reflect.TypeOf(OpenStackLightspeedImages{})
+	src := OpenStackLightspeedImages{}
+	srcVal := reflect.ValueOf(&src).Elem()
+	for i := 0; i < typ.NumField(); i++ {
+		f := srcVal.Field(i)
+		f.SetString(fmt.Sprintf("val-%d", i))
+	}
+
+	dst := OpenStackLightspeedImages{}
+	mergeImages(&dst, &src)
+
+	if !reflect.DeepEqual(dst, src) {
+		t.Errorf("after merging fully-populated src into zero dst, values differ:\n  dst: %+v\n  src: %+v", dst, src)
+	}
+}

api/v1beta1/zz_generated.deepcopy.go

@@ -83,6 +83,28 @@ spec:
               feedbackDisabled:
                 description: Disable feedback collection
                 type: boolean
+              images:
+                description: |-
+                  Images configures container images used by the operator.
+                  When omitted, each image defaults to its environment variable or hardcoded fallback.
+                properties:
+                  consoleImage:
+                    type: string
+                  consoleImagePF5:
+                    type: string
+                  exporterImage:
+                    type: string
+                  lcoreImage:
+                    type: string
+                  mcpServerImage:
+                    type: string
+                  okpImage:
+                    type: string
+                  postgresImage:
+                    type: string
+                  ragImage:
+                    type: string
+                type: object
               llmAPIVersion:
                 description: LLM API Version for LLM providers that require it (e.g.,
                   Microsoft Azure OpenAI)
@@ -180,10 +202,6 @@ spec:
                       When false, uses reference_url (online).
                     type: boolean
                 type: object
-              ragImage:
-                description: ContainerImage for the OpenStack Lightspeed RAG container
-                  (will be set to environmental default if empty)
-                type: string
               tlsCACertBundle:
                 description: Configmap name containing a CA Certificates bundle
                 type: string

bundle/manifests/lightspeed.openstack.org_openstacklightspeeds.yaml

@@ -83,6 +83,28 @@ spec:
               feedbackDisabled:
                 description: Disable feedback collection
                 type: boolean
+              images:
+                description: |-
+                  Images configures container images used by the operator.
+                  When omitted, each image defaults to its environment variable or hardcoded fallback.
+                properties:
+                  consoleImage:
+                    type: string
+                  consoleImagePF5:
+                    type: string
+                  exporterImage:
+                    type: string
+                  lcoreImage:
+                    type: string
+                  mcpServerImage:
+                    type: string
+                  okpImage:
+                    type: string
+                  postgresImage:
+                    type: string
+                  ragImage:
+                    type: string
+                type: object
               llmAPIVersion:
                 description: LLM API Version for LLM providers that require it (e.g.,
                   Microsoft Azure OpenAI)
@@ -180,10 +202,6 @@ spec:
                       When false, uses reference_url (online).
                     type: boolean
                 type: object
-              ragImage:
-                description: ContainerImage for the OpenStack Lightspeed RAG container
-                  (will be set to environmental default if empty)
-                type: string
               tlsCACertBundle:
                 description: Configmap name containing a CA Certificates bundle
                 type: string

config/crd/bases/lightspeed.openstack.org_openstacklightspeeds.yaml

@@ -27,3 +27,13 @@ spec:
   #     - okp
   #   okpChunkFilterQuery: "product:(*openstack* OR *openshift*)"
   #   okpRagOnly: true
+  # Uncomment to customize container images:
+  # images:
+  #   ragImage: "quay.io/openstack-lightspeed/rag-content:custom"
+  #   lcoreImage: "quay.io/lightspeed-core/lightspeed-stack:custom"
+  #   exporterImage: "quay.io/lightspeed-core/lightspeed-to-dataverse-exporter:custom"
+  #   postgresImage: "registry.redhat.io/rhel9/postgresql-16:custom"
+  #   consoleImage: "registry.redhat.io/openshift-lightspeed/lightspeed-console-plugin-rhel9:custom"
+  #   consoleImagePF5: "registry.redhat.io/openshift-lightspeed/lightspeed-console-plugin-pf5-rhel9:custom"
+  #   okpImage: "registry.redhat.io/offline-knowledge-portal/rhokp-rhel9:custom"
+  #   mcpServerImage: "quay.io/openstack-lightspeed/rhos-mcps:custom"