hypershift:status: check for duplicated configmap status

on hypershift platform,
when PerformanceProfile gets replaced with a new one,
there will be a short window when two different PerformanceProfile are exist for the same nodePool
until Hypershift operator catches up and deletes the old one.
in this case, we want to avoid creating duplicated ConfigMap for the status because it will
break Hypershift reconciliation loop:
https://github.com/openshift/hypershift/blob/53dc14cbdd1e46d8b648ed49c6419d34209ef406/hypershift-operator/controllers/nodepool/nto.go\#L330

if a different ConfigMap for the status already exists, requeue the object for later.

Signed-off-by: Talor Itzhak <titzhak@redhat.com>

Author: Tal-or

pkg/performanceprofile/controller/performanceprofile/hypershift/components/handler.go

@@ -236,7 +236,7 @@ func ConfigMapMeta(name, profileName, namespace, npNamespacedName string) *corev
 			Name:      name,
 			Labels: map[string]string{
 				hypershiftconsts.PerformanceProfileNameLabel: profileName,
-				hypershiftconsts.NodePoolNameLabel:           parseNamespacedName(npNamespacedName),
+				hypershiftconsts.NodePoolNameLabel:           ParseNamespacedName(npNamespacedName),
 			},
 			Annotations: map[string]string{
 				hypershiftconsts.NodePoolNameLabel: npNamespacedName,
@@ -245,10 +245,10 @@ func ConfigMapMeta(name, profileName, namespace, npNamespacedName string) *corev
 	}
 }
 
-// parseNamespacedName expects a string with the format "namespace/name"
+// ParseNamespacedName expects a string with the format "namespace/name"
 // and returns the name only.
 // If given a string in the format "name" returns "name".
-func parseNamespacedName(namespacedName string) string {
+func ParseNamespacedName(namespacedName string) string {
 	parts := strings.SplitN(namespacedName, "/", 2)
 	if len(parts) > 1 {
 		return parts[1]

pkg/performanceprofile/controller/performanceprofile/hypershift/status/writer.go

@@ -3,16 +3,19 @@ package status
 import (
 	"context"
 	"fmt"
-
-	"k8s.io/klog/v2"
-	ctrl "sigs.k8s.io/controller-runtime"
+	"time"
 
 	corev1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/klog/v2"
+
+	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	performancev2 "github.com/openshift/cluster-node-tuning-operator/pkg/apis/performanceprofile/v2"
 	"github.com/openshift/cluster-node-tuning-operator/pkg/performanceprofile/controller/performanceprofile/hypershift"
+	handler "github.com/openshift/cluster-node-tuning-operator/pkg/performanceprofile/controller/performanceprofile/hypershift/components"
 	hypershiftconsts "github.com/openshift/cluster-node-tuning-operator/pkg/performanceprofile/controller/performanceprofile/hypershift/consts"
 	"github.com/openshift/cluster-node-tuning-operator/pkg/performanceprofile/controller/performanceprofile/status"
 	conditionsv1 "github.com/openshift/custom-resource-status/conditions/v1"
@@ -36,6 +39,24 @@ func (w *writer) Update(ctx context.Context, object client.Object, conditions []
 		return ctrl.Result{}, fmt.Errorf("wrong type conversion; want=*ConfigMap got=%T", object)
 	}
 
+	// on hypershift platform,
+	// when PerformanceProfile gets replaced with a new one,
+	// there will be a short window when two different PerformanceProfile are exist for the same nodePool
+	// until Hypershift operator catches up and deletes the old one.
+	// in this case, we want to avoid creating duplicated ConfigMap for the status because it will
+	// break Hypershift reconciliation loop:
+	// https://github.com/openshift/hypershift/blob/53dc14cbdd1e46d8b648ed49c6419d34209ef406/hypershift-operator/controllers/nodepool/nto.go#L330
+	// if a different ConfigMap for the status already exists, requeue the object for later.
+	exists, err := isDifferentConfigMapStatusExists(ctx, w.dataPlaneClient, instance)
+	if err != nil {
+		return ctrl.Result{}, err
+	}
+	if exists {
+		return ctrl.Result{
+			RequeueAfter: time.Second * 10,
+		}, nil
+	}
+
 	s, ok := instance.Data[hypershiftconsts.TuningKey]
 	if !ok {
 		return ctrl.Result{}, fmt.Errorf("key named %q not found in ConfigMap %q", hypershiftconsts.TuningKey, client.ObjectKeyFromObject(instance).String())
@@ -75,3 +96,30 @@ func (w *writer) updateDegradedCondition(ctx context.Context, instance client.Ob
 	}
 	return result, conditionError
 }
+
+func isDifferentConfigMapStatusExists(ctx context.Context, cli client.Client, instance *corev1.ConfigMap) (bool, error) {
+	nodePoolNamespacedName, ok := instance.Annotations[hypershiftconsts.NodePoolNameLabel]
+	if !ok {
+		return false, fmt.Errorf("annotation %q not found in ConfigMap %q annotations", hypershiftconsts.NodePoolNameLabel, client.ObjectKeyFromObject(instance).String())
+	}
+	cmList := &corev1.ConfigMapList{}
+	opts := &client.ListOptions{
+		Namespace: instance.GetNamespace(),
+		LabelSelector: labels.SelectorFromSet(map[string]string{
+			hypershiftconsts.NTOGeneratedPerformanceProfileStatusConfigMapLabel: "true",
+			hypershiftconsts.NodePoolNameLabel:                                  handler.ParseNamespacedName(nodePoolNamespacedName),
+		}),
+	}
+	err := cli.List(ctx, cmList, opts)
+	if err != nil {
+		return false, fmt.Errorf("failed to list ConfigMaps in namespace %s %w", instance.GetNamespace(), err)
+	}
+	ConfigMapStatusName := hypershift.GetStatusConfigMapName(instance.Name)
+	for _, cm := range cmList.Items {
+		if ConfigMapStatusName != cm.GetName() {
+			klog.InfoS("Different PerformanceProfile-ConfigMap status found, wait for its deletion", "Existing", cm.GetName(), "NewToBeCreated", ConfigMapStatusName)
+			return true, nil
+		}
+	}
+	return false, nil
+}