Console: Add OpenShift->OpenStack text replacement

To avoid having the console saying it's OpenShift Lightspeed we will be
doing a replacement of the OpenShift word in the internationalization
file.

This mechanism is a bit hacky, but it's a patch that's easy to revert if
we decide to.

Add an init container that rewrites "OpenShift" references to
"OpenStack" in the locales JSON file using awk.

The awk script splits each line at the key-value boundary and only
replaces in values, preserving i18n lookup keys.

Using this mechanism should not be a problem for non English locales (at
least according to Claude), since the i18n fallback mechanism works like
this:

1. This plugin doesn't initialize i18next itself. It relies on the
   parent OpenShift Console (via ConsoleRemotePlugin in
   webpack.config.ts) to set up i18next globally. The plugin just uses
   useTranslation('plugin__lightspeed-console-plugin') to access its
   namespace.
2. When a non-English locale is requested, i18next looks for
   locales/<locale>/plugin__lightspeed-console-plugin.json. Since only
   locales/en/ exists, i18next falls back to English — this is standard
   i18next behavior where missing locale files cause a fallback to the
   default language.
 3. Additionally, the translation keys in
    locales/en/plugin__lightspeed-console-plugin.json are the English
    strings themselves (e.g., "Close": "Close"). So even if the fallback
    mechanism somehow failed entirely, i18next's last resort is to
    display the key as-is — which in this case is already readable
    English text.

As long as OLS console doesn't have a bug in their code that doesn't use
the internationalization with a string and that string has OpenShift in
the wording we should be fine.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Author: Akrog

internal/controller/assets/console_locales_rewrite.awk

@@ -0,0 +1,11 @@
+{
+  idx = index($0, "\": ")
+  if (idx > 0) {
+    key_part = substr($0, 1, idx + 2)
+    val_part = substr($0, idx + 3)
+    gsub(/OpenShift/, "OpenStack", val_part)
+    gsub(/openshift/, "openstack", val_part)
+    gsub(/OPENSHIFT/, "OPENSTACK", val_part)
+    printf "%s%s\n", key_part, val_part
+  } else { print }
+}

internal/controller/console_deployment.go

@@ -38,7 +38,15 @@ func generateConsoleSelectorLabels() map[string]string {
 	}
 }
 
+// consoleLocalesFilename is the filename of the locales JSON file.
+const consoleLocalesFilename = "plugin__lightspeed-console-plugin.json"
+
+// consoleLocalesPath is the path to the locales JSON file inside the console image.
+const consoleLocalesPath = "/usr/share/nginx/html/locales/en/" + consoleLocalesFilename
+
 // buildConsoleDeploymentSpec builds the Deployment spec for the console plugin.
+// Includes an init container that rewrites OpenShift references to OpenStack
+// in the locales JSON file using an emptyDir volume.
 func buildConsoleDeploymentSpec(consoleImage string) appsv1.DeploymentSpec {
 	replicas := int32(1)
 	volumeDefaultMode := VolumeDefaultMode
@@ -61,6 +69,30 @@ func buildConsoleDeploymentSpec(consoleImage string) appsv1.DeploymentSpec {
 					},
 				},
 				ServiceAccountName: ConsoleUIServiceAccountName,
+				InitContainers: []corev1.Container{
+					{
+						Name:  "rewrite-locales",
+						Image: consoleImage,
+						SecurityContext: &corev1.SecurityContext{
+							AllowPrivilegeEscalation: toPtr(false),
+							ReadOnlyRootFilesystem:   toPtr(true),
+							Capabilities: &corev1.Capabilities{
+								Drop: []corev1.Capability{"ALL"},
+							},
+						},
+						Command: []string{
+							"sh", "-c",
+							"awk '" + consoleLocalesRewriteAwk + "' " +
+								consoleLocalesPath + " > /locales-rewrite/" + consoleLocalesFilename,
+						},
+						VolumeMounts: []corev1.VolumeMount{
+							{
+								Name:      "locales-rewrite",
+								MountPath: "/locales-rewrite",
+							},
+						},
+					},
+				},
 				Containers: []corev1.Container{
 					{
 						Name:  "lightspeed-console-plugin",
@@ -92,6 +124,12 @@ func buildConsoleDeploymentSpec(consoleImage string) appsv1.DeploymentSpec {
 								Name:      "nginx-temp",
 								MountPath: "/tmp/nginx",
 							},
+							{
+								Name:      "locales-rewrite",
+								MountPath: consoleLocalesPath,
+								SubPath:   consoleLocalesFilename,
+								ReadOnly:  true,
+							},
 						},
 					},
 				},
@@ -122,6 +160,12 @@ func buildConsoleDeploymentSpec(consoleImage string) appsv1.DeploymentSpec {
 							EmptyDir: &corev1.EmptyDirVolumeSource{},
 						},
 					},
+					{
+						Name: "locales-rewrite",
+						VolumeSource: corev1.VolumeSource{
+							EmptyDir: &corev1.EmptyDirVolumeSource{},
+						},
+					},
 				},
 			},
 		},

internal/controller/console_reconciler_test.go

@@ -75,15 +75,29 @@ var _ = Describe("Console Plugin", func() {
 			Expect(ports[0].Protocol).To(Equal(corev1.ProtocolTCP))
 		})
 
-		It("should have TLS cert, nginx config, and nginx temp volume mounts", func() {
+		It("should have TLS cert, nginx config, nginx temp, and locales-rewrite volume mounts", func() {
 			mounts := spec.Template.Spec.Containers[0].VolumeMounts
-			Expect(mounts).To(HaveLen(3))
+			Expect(mounts).To(HaveLen(4))
 
 			var names []string
 			for _, m := range mounts {
 				names = append(names, m.Name)
 			}
-			Expect(names).To(ContainElements("lightspeed-console-plugin-cert", "nginx-config", "nginx-temp"))
+			Expect(names).To(ContainElements("lightspeed-console-plugin-cert", "nginx-config", "nginx-temp", "locales-rewrite"))
+		})
+
+		It("should mount locales-rewrite with SubPath at the locales file path", func() {
+			mounts := spec.Template.Spec.Containers[0].VolumeMounts
+			var found bool
+			for _, m := range mounts {
+				if m.Name == "locales-rewrite" {
+					found = true
+					Expect(m.MountPath).To(Equal(consoleLocalesPath))
+					Expect(m.SubPath).To(Equal(consoleLocalesFilename))
+					Expect(m.ReadOnly).To(BeTrue())
+				}
+			}
+			Expect(found).To(BeTrue())
 		})
 
 		It("should have TLS cert volume from secret", func() {
@@ -127,6 +141,50 @@ var _ = Describe("Console Plugin", func() {
 		It("should use the console service account", func() {
 			Expect(spec.Template.Spec.ServiceAccountName).To(Equal(ConsoleUIServiceAccountName))
 		})
+
+		It("should have a locales-rewrite emptyDir volume", func() {
+			volumes := spec.Template.Spec.Volumes
+			var found bool
+			for _, v := range volumes {
+				if v.Name == "locales-rewrite" {
+					found = true
+					Expect(v.VolumeSource.EmptyDir).NotTo(BeNil())
+				}
+			}
+			Expect(found).To(BeTrue())
+		})
+
+		It("should have one init container for rewriting locales", func() {
+			initContainers := spec.Template.Spec.InitContainers
+			Expect(initContainers).To(HaveLen(1))
+			Expect(initContainers[0].Name).To(Equal("rewrite-locales"))
+		})
+
+		It("should use the same console image for the init container", func() {
+			initContainer := spec.Template.Spec.InitContainers[0]
+			mainContainer := spec.Template.Spec.Containers[0]
+			Expect(initContainer.Image).To(Equal(mainContainer.Image))
+		})
+
+		It("should have the init container command with awk for text replacement", func() {
+			initContainer := spec.Template.Spec.InitContainers[0]
+			Expect(initContainer.Command).To(HaveLen(3))
+			Expect(initContainer.Command[0]).To(Equal("sh"))
+			Expect(initContainer.Command[1]).To(Equal("-c"))
+			cmd := initContainer.Command[2]
+			Expect(cmd).To(ContainSubstring("awk"))
+			Expect(cmd).To(ContainSubstring("OpenShift"))
+			Expect(cmd).To(ContainSubstring("OpenStack"))
+			Expect(cmd).To(ContainSubstring(consoleLocalesPath))
+			Expect(cmd).To(ContainSubstring("/locales-rewrite/" + consoleLocalesFilename))
+		})
+
+		It("should mount locales-rewrite volume in the init container", func() {
+			initContainer := spec.Template.Spec.InitContainers[0]
+			Expect(initContainer.VolumeMounts).To(HaveLen(1))
+			Expect(initContainer.VolumeMounts[0].Name).To(Equal("locales-rewrite"))
+			Expect(initContainer.VolumeMounts[0].MountPath).To(Equal("/locales-rewrite"))
+		})
 	})
 
 	Describe("buildConsolePluginSpec", func() {

internal/controller/constants.go

@@ -224,3 +224,9 @@ var vectorDatabaseBuildScript string
 
 //go:embed assets/console_nginx.conf.tmpl
 var consoleNginxConfigTemplate string
+
+// consoleLocalesRewriteAwk is the awk script that performs case-preserving
+// OpenShift -> OpenStack replacement only in JSON values (after the first `": `).
+//
+//go:embed assets/console_locales_rewrite.awk
+var consoleLocalesRewriteAwk string

test/kuttl/common/openstack-lightspeed-instance/assert-openstack-lightspeed-instance.yaml

@@ -189,6 +189,16 @@ spec:
         runAsNonRoot: true
         seccompProfile:
           type: RuntimeDefault
+      initContainers:
+        - name: rewrite-locales
+          securityContext:
+            allowPrivilegeEscalation: false
+            readOnlyRootFilesystem: true
+            capabilities:
+              drop: ["ALL"]
+          volumeMounts:
+            - name: locales-rewrite
+              mountPath: /locales-rewrite
 ---
 apiVersion: v1
 kind: Service

test/kuttl/tests/update-openstacklightspeed/08-assert-openstacklightspeed-update.yaml

@@ -117,6 +117,14 @@ kind: Deployment
 metadata:
   name: lightspeed-console-plugin
   namespace: openstack-lightspeed
+spec:
+  template:
+    spec:
+      initContainers:
+        - name: rewrite-locales
+          volumeMounts:
+            - name: locales-rewrite
+              mountPath: /locales-rewrite
 ---
 apiVersion: v1
 kind: Service