Allow running custom script for debugging purposes

This commit adds a CustomScriptConfigMap spec field to let users run
custom scripts for debugging purposes.
If CustomScriptConfigMap is used, the status of the instanceha resource
would reflect setting status.unsupported.

Author: lmiccini

apis/bases/instanceha.openstack.org_instancehas.yaml

@@ -56,6 +56,11 @@ spec:
                 description: ContainerImage for the InstanceHa container (will be
                   set to environmental default if empty)
                 type: string
+              customScriptConfigMap:
+                description: |-
+                  CustomScriptConfigMap allows overriding the default instanceha.py script
+                  with a custom script from a pre-created ConfigMap
+                type: string
               fencingSecret:
                 default: fencing-secret
                 description: FencingSecret is the name of the Secret containing the
@@ -198,6 +203,10 @@ spec:
               podName:
                 description: PodName
                 type: string
+              unsupported:
+                description: Unsupported - indicates when unsupported configurations
+                  are used
+                type: string
             type: object
         type: object
     served: true

apis/instanceha/v1beta1/instanceha_types.go

@@ -86,6 +86,11 @@ type InstanceHaSpec struct {
 	// TopologyRef to apply the Topology defined by the associated CR referenced
 	// by name
 	TopologyRef *topologyv1.TopoRef `json:"topologyRef,omitempty"`
+
+	// +kubebuilder:validation:Optional
+	// CustomScriptConfigMap allows overriding the default instanceha.py script
+	// with a custom script from a pre-created ConfigMap
+	CustomScriptConfigMap *string `json:"customScriptConfigMap,omitempty"`
 }
 
 // InstanceHaStatus defines the observed state of InstanceHa
@@ -104,6 +109,9 @@ type InstanceHaStatus struct {
 
 	// LastAppliedTopology - the last applied Topology
 	LastAppliedTopology *topologyv1.TopoRef `json:"lastAppliedTopology,omitempty"`
+
+	// Unsupported - indicates when unsupported configurations are used
+	Unsupported string `json:"unsupported,omitempty"`
 }
 
 //+kubebuilder:object:root=true

apis/instanceha/v1beta1/zz_generated.deepcopy.go

@@ -56,6 +56,11 @@ spec:
                 description: ContainerImage for the InstanceHa container (will be
                   set to environmental default if empty)
                 type: string
+              customScriptConfigMap:
+                description: |-
+                  CustomScriptConfigMap allows overriding the default instanceha.py script
+                  with a custom script from a pre-created ConfigMap
+                type: string
               fencingSecret:
                 default: fencing-secret
                 description: FencingSecret is the name of the Secret containing the
@@ -198,6 +203,10 @@ spec:
               podName:
                 description: PodName
                 type: string
+              unsupported:
+                description: Unsupported - indicates when unsupported configurations
+                  are used
+                type: string
             type: object
         type: object
     served: true

config/crd/bases/instanceha.openstack.org_instancehas.yaml

@@ -367,25 +367,30 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ct
 	}
 
 	// begin custom script inject
-	cmLabels := labels.GetLabels(instance, labels.GetGroupLabel("instanceha"), map[string]string{})
-	envVars := make(map[string]env.Setter)
-	cms := []util.Template{
-		// ScriptsConfigMap
-		{
-			Name:               instance.Name + "-sh",
-			Namespace:          instance.Namespace,
-			Type:               util.TemplateTypeScripts,
-			InstanceType:       instance.Kind,
-			AdditionalTemplate: map[string]string{},
-			Labels:             cmLabels,
-		},
-	}
+	// Only create the default script ConfigMap if CustomScriptConfigMap is not specified
+	if instance.Spec.CustomScriptConfigMap == nil || *instance.Spec.CustomScriptConfigMap == "" {
+		cmLabels := labels.GetLabels(instance, labels.GetGroupLabel("instanceha"), map[string]string{})
+		envVars := make(map[string]env.Setter)
+		cms := []util.Template{
+			// ScriptsConfigMap
+			{
+				Name:               instance.Name + "-sh",
+				Namespace:          instance.Namespace,
+				Type:               util.TemplateTypeScripts,
+				InstanceType:       instance.Kind,
+				AdditionalTemplate: map[string]string{},
+				Labels:             cmLabels,
+			},
+		}
 
-	err = configmap.EnsureConfigMaps(ctx, helper, instance, cms, &envVars)
-	if err != nil {
-		return ctrl.Result{}, err
+		err = configmap.EnsureConfigMaps(ctx, helper, instance, cms, &envVars)
+		if err != nil {
+			return ctrl.Result{}, err
+		}
+		instance.Status.Unsupported = ""
+	} else {
+		instance.Status.Unsupported = "CustomScriptConfigMap"
 	}
-
 	// end custom script inject
 
 	// Create netattachment

controllers/instanceha/instanceha_controller.go

@@ -203,7 +203,12 @@ func instancehaPodVolumes(
 				ConfigMap: &corev1.ConfigMapVolumeSource{
 					DefaultMode: &config0644AccessMode,
 					LocalObjectReference: corev1.LocalObjectReference{
-						Name: instance.Name + "-sh",
+						Name: func() string {
+							if instance.Spec.CustomScriptConfigMap != nil && *instance.Spec.CustomScriptConfigMap != "" {
+								return *instance.Spec.CustomScriptConfigMap
+							}
+							return instance.Name + "-sh"
+						}(),
 					},
 				},
 			},