Replace hardcoded openstack config values

kstrenkova · kstrenkova · commit d5e074f84ede · 2026-01-27T06:51:02.000-05:00
This PR will remove the hardcoded values around the openstack
config - configmap, secret. It also adds a way to change these
values for HorizonTest and Tobiko resources. It was already
possible in AnsibleTest and Tempest, so it should also keep
consistency between test-operator resource types.
diff --git a/api/bases/test.openstack.org_horizontests.yaml b/api/bases/test.openstack.org_horizontests.yaml
@@ -1284,6 +1284,16 @@ spec:
                   This value contains a nodeSelector value that is applied to test pods
                   spawned by the test operator.
                 type: object
+              openStackConfigMap:
+                default: openstack-config
+                description: OpenStackConfigMap is the name of the ConfigMap containing
+                  the clouds.yaml
+                type: string
+              openStackConfigSecret:
+                default: openstack-config-secret
+                description: OpenStackConfigSecret is the name of the Secret containing
+                  the secure.yaml
+                type: string
               parallel:
                 default: false
                 description: Parallel
diff --git a/api/bases/test.openstack.org_tobikoes.yaml b/api/bases/test.openstack.org_tobikoes.yaml
@@ -1250,6 +1250,16 @@ spec:
                 description: Number of processes/workers used to run tobiko tests
                   - value 0 results in automatic decision
                 type: integer
+              openStackConfigMap:
+                default: openstack-config
+                description: OpenStackConfigMap is the name of the ConfigMap containing
+                  the clouds.yaml
+                type: string
+              openStackConfigSecret:
+                default: openstack-config-secret
+                description: OpenStackConfigSecret is the name of the Secret containing
+                  the secure.yaml
+                type: string
               parallel:
                 default: false
                 description: |-
@@ -1498,6 +1508,16 @@ spec:
                       description: Number of processes/workers used to run tobiko
                         tests - value 0 results in automatic decision
                       type: integer
+                    openStackConfigMap:
+                      default: openstack-config
+                      description: OpenStackConfigMap is the name of the ConfigMap
+                        containing the clouds.yaml
+                      type: string
+                    openStackConfigSecret:
+                      default: openstack-config-secret
+                      description: OpenStackConfigSecret is the name of the Secret
+                        containing the secure.yaml
+                      type: string
                     patch:
                       description: Optional patch to apply to the Tobiko repository
                         for this step.
diff --git a/api/v1beta1/horizontest_types.go b/api/v1beta1/horizontest_types.go
@@ -24,7 +24,8 @@ import (
 
 // HorizonTestSpec defines the desired state of HorizonTest
 type HorizonTestSpec struct {
-	CommonOptions `json:",inline"`
+	CommonOptions         `json:",inline"`
+	CommonOpenstackConfig `json:",inline"`
 
 	// +kubebuilder:default:={limits: {cpu: "2000m", memory: "4Gi"}, requests: {cpu: "1000m", memory: "2Gi"}}
 	// The desired amount of resources that should be assigned to each test pod
diff --git a/api/v1beta1/tobiko_types.go b/api/v1beta1/tobiko_types.go
@@ -36,7 +36,8 @@ type PatchType struct {
 
 // TobikoSpec defines the desired state of Tobiko
 type TobikoSpec struct {
-	CommonOptions `json:",inline"`
+	CommonOptions         `json:",inline"`
+	CommonOpenstackConfig `json:",inline"`
 
 	// +kubebuilder:default:={limits: {cpu: "8000m", memory: "8Gi"}, requests: {cpu: "4000m", memory: "4Gi"}}
 	// The desired amount of resources that should be assigned to each test pod
@@ -134,6 +135,7 @@ type TobikoSpec struct {
 
 type TobikoWorkflowSpec struct {
 	WorkflowCommonOptions `json:",inline"`
+	CommonOpenstackConfig `json:",inline"`
 
 	// The desired amount of resources that should be assigned to each test pod
 	// spawned using the Tobiko CR. https://pkg.go.dev/k8s.io/api/core/v1#ResourceRequirements
diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/test.openstack.org_horizontests.yaml b/config/crd/bases/test.openstack.org_horizontests.yaml
@@ -1284,6 +1284,16 @@ spec:
                   This value contains a nodeSelector value that is applied to test pods
                   spawned by the test operator.
                 type: object
+              openStackConfigMap:
+                default: openstack-config
+                description: OpenStackConfigMap is the name of the ConfigMap containing
+                  the clouds.yaml
+                type: string
+              openStackConfigSecret:
+                default: openstack-config-secret
+                description: OpenStackConfigSecret is the name of the Secret containing
+                  the secure.yaml
+                type: string
               parallel:
                 default: false
                 description: Parallel
diff --git a/config/crd/bases/test.openstack.org_tobikoes.yaml b/config/crd/bases/test.openstack.org_tobikoes.yaml
@@ -1250,6 +1250,16 @@ spec:
                 description: Number of processes/workers used to run tobiko tests
                   - value 0 results in automatic decision
                 type: integer
+              openStackConfigMap:
+                default: openstack-config
+                description: OpenStackConfigMap is the name of the ConfigMap containing
+                  the clouds.yaml
+                type: string
+              openStackConfigSecret:
+                default: openstack-config-secret
+                description: OpenStackConfigSecret is the name of the Secret containing
+                  the secure.yaml
+                type: string
               parallel:
                 default: false
                 description: |-
@@ -1498,6 +1508,16 @@ spec:
                       description: Number of processes/workers used to run tobiko
                         tests - value 0 results in automatic decision
                       type: integer
+                    openStackConfigMap:
+                      default: openstack-config
+                      description: OpenStackConfigMap is the name of the ConfigMap
+                        containing the clouds.yaml
+                      type: string
+                    openStackConfigSecret:
+                      default: openstack-config-secret
+                      description: OpenStackConfigSecret is the name of the Secret
+                        containing the secure.yaml
+                      type: string
                     patch:
                       description: Optional patch to apply to the Tobiko repository
                         for this step.
diff --git a/internal/ansibletest/volumes.go b/internal/ansibletest/volumes.go
@@ -22,8 +22,8 @@ func GetVolumes(
 ) []corev1.Volume {
 
 	volumes := []corev1.Volume{
-		util.CreateOpenstackConfigMapVolume("openstack-config"),
-		util.CreateOpenstackConfigSecretVolume(),
+		util.CreateOpenstackConfigMapVolume(instance.Spec.OpenStackConfigMap),
+		util.CreateOpenstackConfigSecretVolume(instance.Spec.OpenStackConfigSecret),
 		util.CreateLogsPVCVolume(logsPVCName),
 		util.CreateWorkdirVolume(),
 		util.CreateTmpVolume(),
@@ -63,9 +63,9 @@ func GetVolumeMounts(
 		util.CreateVolumeMount(util.TestOperatorEphemeralVolumeNameWorkdir, "/var/lib/ansible", false),
 		util.CreateVolumeMount(util.TestOperatorEphemeralVolumeNameTmp, "/tmp", false),
 		util.CreateVolumeMount(util.TestOperatorLogsVolumeName, "/var/lib/AnsibleTests/external_files", false),
-		util.CreateOpenstackConfigVolumeMount("/etc/openstack/clouds.yaml"),
-		util.CreateOpenstackConfigVolumeMount("/var/lib/ansible/.config/openstack/clouds.yaml"),
-		util.CreateOpenstackConfigSecretVolumeMount("/var/lib/ansible/.config/openstack/secure.yaml"),
+		util.CreateOpenstackConfigVolumeMount(instance.Spec.OpenStackConfigMap, "/etc/openstack/clouds.yaml"),
+		util.CreateOpenstackConfigVolumeMount(instance.Spec.OpenStackConfigMap, "/var/lib/ansible/.config/openstack/clouds.yaml"),
+		util.CreateOpenstackConfigSecretVolumeMount(instance.Spec.OpenStackConfigSecret, "/var/lib/ansible/.config/openstack/secure.yaml"),
 	}
 
 	if mountCerts {
diff --git a/internal/controller/common.go b/internal/controller/common.go
@@ -647,8 +647,8 @@ func EnsureCloudsConfigMapExists(
 	instance client.Object,
 	helper *helper.Helper,
 	labels map[string]string,
+	openstackConfigMapName string,
 ) (ctrl.Result, error) {
-	const openstackConfigMapName = "openstack-config"
 	const testOperatorCloudsConfigMapName = "test-operator-clouds-config"
 
 	cm, _, _ := configmap.GetConfigMap(
diff --git a/internal/controller/horizontest_controller.go b/internal/controller/horizontest_controller.go
@@ -186,7 +186,13 @@ func (r *HorizonTestReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 		workflowStepLabel: "0",
 	}
 
-	yamlResult, err := EnsureCloudsConfigMapExists(ctx, instance, helper, serviceLabels)
+	yamlResult, err := EnsureCloudsConfigMapExists(
+		ctx,
+		instance,
+		helper,
+		serviceLabels,
+		instance.Spec.OpenStackConfigMap,
+	)
 
 	if err != nil {
 		return yamlResult, err
diff --git a/internal/controller/tobiko_controller.go b/internal/controller/tobiko_controller.go
@@ -194,7 +194,13 @@ func (r *TobikoReconciler) Reconcile(ctx context.Context, req ctrl.Request) (res
 		operatorNameLabel:  "test-operator",
 	}
 
-	yamlResult, err := EnsureCloudsConfigMapExists(ctx, instance, helper, serviceLabels)
+	yamlResult, err := EnsureCloudsConfigMapExists(
+		ctx,
+		instance,
+		helper,
+		serviceLabels,
+		instance.Spec.OpenStackConfigMap,
+	)
 
 	if err != nil {
 		return yamlResult, err
diff --git a/internal/horizontest/volumes.go b/internal/horizontest/volumes.go
@@ -21,7 +21,7 @@ func GetVolumes(
 	volumes := []corev1.Volume{
 		util.CreateConfigMapVolume(horizonTestConfig, instance.Name+horizonTestConfig, util.ScriptsVolumeDefaultMode),
 		util.CreateOpenstackConfigMapVolume(util.TestOperatorCloudsConfigMapName),
-		util.CreateOpenstackConfigSecretVolume(),
+		util.CreateOpenstackConfigSecretVolume(instance.Spec.OpenStackConfigSecret),
 		util.CreateLogsPVCVolume(logsPVCName),
 		util.CreateWorkdirVolume(),
 		util.CreateTmpVolume(),
@@ -54,7 +54,7 @@ func GetVolumeMounts(
 		util.CreateVolumeMount(util.TestOperatorLogsVolumeName, "/var/lib/horizontest/external_files", false),
 		util.CreateTestOperatorCloudsConfigVolumeMount("/var/lib/horizontest/.config/openstack/clouds.yaml"),
 		util.CreateTestOperatorCloudsConfigVolumeMount("/etc/openstack/clouds.yaml"),
-		util.CreateOpenstackConfigSecretVolumeMount("/etc/openstack/secure.yaml"),
+		util.CreateOpenstackConfigSecretVolumeMount(instance.Spec.OpenStackConfigSecret, "/etc/openstack/secure.yaml"),
 	}
 
 	if mountCerts {
diff --git a/internal/tempest/volumes.go b/internal/tempest/volumes.go
@@ -23,8 +23,8 @@ func GetVolumes(
 
 	volumes := []corev1.Volume{
 		util.CreateConfigMapVolume(configData, customDataConfigMapName, util.ScriptsVolumeDefaultMode),
-		util.CreateOpenstackConfigMapVolume("openstack-config"),
-		util.CreateOpenstackConfigSecretVolume(),
+		util.CreateOpenstackConfigMapVolume(instance.Spec.OpenStackConfigMap),
+		util.CreateOpenstackConfigSecretVolume(instance.Spec.OpenStackConfigSecret),
 		util.CreateLogsPVCVolume(logsPVCName),
 		util.CreateWorkdirVolume(),
 		util.CreateTmpVolume(),
@@ -56,9 +56,9 @@ func GetVolumeMounts(
 		util.CreateVolumeMount(util.TestOperatorEphemeralVolumeNameWorkdir, "/var/lib/tempest", false),
 		util.CreateVolumeMount(util.TestOperatorEphemeralVolumeNameTmp, "/tmp", false),
 		util.CreateVolumeMount(util.TestOperatorLogsVolumeName, "/var/lib/tempest/external_files", false),
-		util.CreateOpenstackConfigVolumeMount("/etc/openstack/clouds.yaml"),
-		util.CreateOpenstackConfigVolumeMount("/var/lib/tempest/.config/openstack/clouds.yaml"),
-		util.CreateOpenstackConfigSecretVolumeMount("/etc/openstack/secure.yaml"),
+		util.CreateOpenstackConfigVolumeMount(instance.Spec.OpenStackConfigMap, "/etc/openstack/clouds.yaml"),
+		util.CreateOpenstackConfigVolumeMount(instance.Spec.OpenStackConfigMap, "/var/lib/tempest/.config/openstack/clouds.yaml"),
+		util.CreateOpenstackConfigSecretVolumeMount(instance.Spec.OpenStackConfigSecret, "/etc/openstack/secure.yaml"),
 	}
 
 	if mountCerts {
diff --git a/internal/tobiko/volumes.go b/internal/tobiko/volumes.go
@@ -26,7 +26,7 @@ func GetVolumes(
 	volumes := []corev1.Volume{
 		util.CreateConfigMapVolume(tobikoConfig, instance.Name+tobikoConfig, util.ScriptsVolumeDefaultMode),
 		util.CreateOpenstackConfigMapVolume(util.TestOperatorCloudsConfigMapName),
-		util.CreateOpenstackConfigSecretVolume(),
+		util.CreateOpenstackConfigSecretVolume(instance.Spec.OpenStackConfigSecret),
 		util.CreateLogsPVCVolume(logsPVCName),
 		util.CreateWorkdirVolume(),
 		util.CreateTmpVolume(),
@@ -67,7 +67,7 @@ func GetVolumeMounts(
 		util.CreateVolumeMount(util.TestOperatorLogsVolumeName, "/var/lib/tobiko/external_files", false),
 		util.CreateTestOperatorCloudsConfigVolumeMount("/var/lib/tobiko/.config/openstack/clouds.yaml"),
 		util.CreateTestOperatorCloudsConfigVolumeMount("/etc/openstack/clouds.yaml"),
-		util.CreateOpenstackConfigSecretVolumeMount("/etc/openstack/secure.yaml"),
+		util.CreateOpenstackConfigSecretVolumeMount(instance.Spec.OpenStackConfigSecret, "/etc/openstack/secure.yaml"),
 		util.CreateVolumeMountWithSubPath(tobikoConfig, "/etc/tobiko/tobiko.conf", "tobiko.conf", false),
 	}
 
diff --git a/internal/util/volumes.go b/internal/util/volumes.go
@@ -28,12 +28,10 @@ const (
 )
 
 const (
-	volumeNameCACerts         = "ca-certs"
-	volumeNameKubeconfig      = "kubeconfig"
-	volumeNameOpenstackConfig = "openstack-config"
+	volumeNameCACerts    = "ca-certs"
+	volumeNameKubeconfig = "kubeconfig"
 
-	scrtNameCombinedCABundle = "combined-ca-bundle"
-	scrtNameOpenstackConfig  = "openstack-config-secret"
+	secretNameCombinedCABundle = "combined-ca-bundle" // #nosec G101
 
 	subPathCloudsYAML  = "clouds.yaml"
 	subPathConfig      = "config"
@@ -73,14 +71,14 @@ func CreateOpenstackConfigMapVolume(configMapName string) corev1.Volume {
 }
 
 // CreateOpenstackConfigSecretVolume creates the openstack-config-secret volume
-func CreateOpenstackConfigSecretVolume() corev1.Volume {
+func CreateOpenstackConfigSecretVolume(secretName string) corev1.Volume {
 	mode := TLSCertificateMode
 	return corev1.Volume{
-		Name: scrtNameOpenstackConfig,
+		Name: secretName,
 		VolumeSource: corev1.VolumeSource{
 			Secret: &corev1.SecretVolumeSource{
 				DefaultMode: &mode,
-				SecretName:  scrtNameOpenstackConfig,
+				SecretName:  secretName,
 			},
 		},
 	}
@@ -127,7 +125,7 @@ func AppendCACertsVolume(volumes []corev1.Volume) []corev1.Volume {
 		VolumeSource: corev1.VolumeSource{
 			Secret: &corev1.SecretVolumeSource{
 				DefaultMode: &mode,
-				SecretName:  scrtNameCombinedCABundle,
+				SecretName:  secretNameCombinedCABundle,
 			},
 		},
 	}
@@ -266,13 +264,13 @@ func CreateCACertVolumeMount(mountPath string) corev1.VolumeMount {
 }
 
 // CreateOpenstackConfigVolumeMount creates an openstack config volume mount
-func CreateOpenstackConfigVolumeMount(mountPath string) corev1.VolumeMount {
-	return CreateVolumeMountWithSubPath(volumeNameOpenstackConfig, mountPath, subPathCloudsYAML, true)
+func CreateOpenstackConfigVolumeMount(configMapName string, mountPath string) corev1.VolumeMount {
+	return CreateVolumeMountWithSubPath(configMapName, mountPath, subPathCloudsYAML, true)
 }
 
 // CreateOpenstackConfigSecretVolumeMount creates an openstack config secret volume mount
-func CreateOpenstackConfigSecretVolumeMount(mountPath string) corev1.VolumeMount {
-	return CreateVolumeMountWithSubPath(scrtNameOpenstackConfig, mountPath, subPathSecureYAML, false)
+func CreateOpenstackConfigSecretVolumeMount(secretName string, mountPath string) corev1.VolumeMount {
+	return CreateVolumeMountWithSubPath(secretName, mountPath, subPathSecureYAML, false)
 }
 
 // CreateTestOperatorCloudsConfigVolumeMount creates a test-operator-clouds-config volume mount
