Merge pull request kubernetes-sigs#6989 from killianmuldoon/fix/clusterresourcesetbinding-ownerref

🐛 Add OwnerRef to clusterResourceSetBinding on each reconcile

Author: k8s-ci-robot

exp/addons/api/v1beta1/clusterresourcesetbinding_types.go

@@ -20,6 +20,8 @@ import (
 	"reflect"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	"sigs.k8s.io/cluster-api/util"
 )
 
 // ANCHOR: ResourceBinding
@@ -100,6 +102,11 @@ func (c *ClusterResourceSetBinding) DeleteBinding(clusterResourceSet *ClusterRes
 			break
 		}
 	}
+	clusterResourceSet.OwnerReferences = util.RemoveOwnerRef(c.OwnerReferences, metav1.OwnerReference{
+		APIVersion: clusterResourceSet.APIVersion,
+		Kind:       clusterResourceSet.Kind,
+		Name:       clusterResourceSet.Name,
+	})
 }
 
 // +kubebuilder:object:root=true

exp/addons/internal/controllers/clusterresourceset_controller.go

@@ -264,6 +264,8 @@ func (r *ClusterResourceSetReconciler) ApplyClusterResourceSet(ctx context.Conte
 		}
 	}()
 
+	// Ensure that the owner references are set on the ClusterResourceSetBinding.
+	clusterResourceSetBinding.OwnerReferences = ensureOwnerRefs(clusterResourceSetBinding, clusterResourceSet, cluster)
 	errList := []error{}
 	resourceSetBinding := clusterResourceSetBinding.GetOrCreateBinding(clusterResourceSet)
 

exp/addons/internal/controllers/clusterresourceset_controller_test.go

@@ -518,8 +518,8 @@ metadata:
 			if err != nil {
 				return false
 			}
-			return len(binding.Spec.Bindings) == 2
-		}, timeout).Should(BeTrue())
+			return len(binding.Spec.Bindings) == 2 && len(binding.OwnerReferences) == 3
+		}, timeout).Should(BeTrue(), "Expected 2 ClusterResourceSets and 3 OwnerReferences")
 
 		t.Log("Verifying deleted CRS is deleted from ClusterResourceSetBinding")
 		// Delete one of the CRS instances and wait until it is removed from the binding list.
@@ -534,8 +534,8 @@ metadata:
 			if err != nil {
 				return false
 			}
-			return len(binding.Spec.Bindings) == 1
-		}, timeout).Should(BeTrue())
+			return len(binding.Spec.Bindings) == 1 && len(binding.OwnerReferences) == 2
+		}, timeout).Should(BeTrue(), "ClusterResourceSetBinding should have 1 ClusterResourceSet and 2 OwnerReferences")
 
 		t.Log("Verifying ClusterResourceSetBinding is deleted after deleting all matching CRS objects")
 		// Delete one of the CRS instances and wait until it is removed from the binding list.

exp/addons/internal/controllers/clusterresourceset_helpers.go

@@ -120,18 +120,11 @@ func (r *ClusterResourceSetReconciler) getOrCreateClusterResourceSetBinding(ctx
 		if !apierrors.IsNotFound(err) {
 			return nil, err
 		}
-
 		clusterResourceSetBinding.Name = cluster.Name
 		clusterResourceSetBinding.Namespace = cluster.Namespace
-		clusterResourceSetBinding.OwnerReferences = util.EnsureOwnerRef(clusterResourceSetBinding.OwnerReferences, metav1.OwnerReference{
-			APIVersion: clusterv1.GroupVersion.String(),
-			Kind:       "Cluster",
-			Name:       cluster.Name,
-			UID:        cluster.UID,
-		})
-		clusterResourceSetBinding.OwnerReferences = util.EnsureOwnerRef(clusterResourceSetBinding.OwnerReferences, *metav1.NewControllerRef(clusterResourceSet, clusterResourceSet.GroupVersionKind()))
-
+		clusterResourceSetBinding.OwnerReferences = ensureOwnerRefs(clusterResourceSetBinding, clusterResourceSet, cluster)
 		clusterResourceSetBinding.Spec.Bindings = []*addonsv1.ResourceSetBinding{}
+
 		if err := r.Client.Create(ctx, clusterResourceSetBinding); err != nil {
 			if apierrors.IsAlreadyExists(err) {
 				if err = r.Client.Get(ctx, clusterResourceSetBindingKey, clusterResourceSetBinding); err != nil {
@@ -142,10 +135,29 @@ func (r *ClusterResourceSetReconciler) getOrCreateClusterResourceSetBinding(ctx
 			return nil, errors.Wrapf(err, "failed to create clusterResourceSetBinding for cluster: %s/%s", cluster.Namespace, cluster.Name)
 		}
 	}
-
 	return clusterResourceSetBinding, nil
 }
 
+// ensureOwnerRefs ensures Cluster and ClusterResourceSet owner references are set on the ClusterResourceSetBinding.
+func ensureOwnerRefs(clusterResourceSetBinding *addonsv1.ClusterResourceSetBinding, clusterResourceSet *addonsv1.ClusterResourceSet, cluster *clusterv1.Cluster) []metav1.OwnerReference {
+	ownerRefs := make([]metav1.OwnerReference, len(clusterResourceSetBinding.GetOwnerReferences()))
+	copy(ownerRefs, clusterResourceSetBinding.GetOwnerReferences())
+	ownerRefs = util.EnsureOwnerRef(ownerRefs, metav1.OwnerReference{
+		APIVersion: clusterv1.GroupVersion.String(),
+		Kind:       "Cluster",
+		Name:       cluster.Name,
+		UID:        cluster.UID,
+	})
+	ownerRefs = util.EnsureOwnerRef(ownerRefs,
+		metav1.OwnerReference{
+			APIVersion: clusterResourceSet.GroupVersionKind().String(),
+			Kind:       clusterResourceSet.GroupVersionKind().Kind,
+			Name:       clusterResourceSet.Name,
+			UID:        clusterResourceSet.UID,
+		})
+	return ownerRefs
+}
+
 // getConfigMap retrieves any ConfigMap from the given name and namespace.
 func getConfigMap(ctx context.Context, c client.Client, configmapName types.NamespacedName) (*corev1.ConfigMap, error) {
 	configMap := &corev1.ConfigMap{}