move binding's namespace/name from work's label to annotation

Signed-off-by: changzhen <[email protected]>

pkg/apis/work/v1alpha2/well_known_labels.go

@@ -1,6 +1,16 @@
 package v1alpha2
 
 const (
+	// ResourceBindingReferenceKey is the key of ResourceBinding object.
+	// It is usually a unique hash value of ResourceBinding object's namespace and name, intended to be added to the Work object.
+	// It will be used to retrieve all Works objects that derived from a specific ResourceBinding object.
+	ResourceBindingReferenceKey = "resourcebinding.karmada.io/key"
+
+	// ClusterResourceBindingReferenceKey is the key of ClusterResourceBinding object.
+	// It is usually a unique hash value of ClusterResourceBinding object's namespace and name, intended to be added to the Work object.
+	// It will be used to retrieve all Works objects that derived by a specific ClusterResourceBinding object.
+	ClusterResourceBindingReferenceKey = "clusterresourcebinding.karmada.io/key"
+
 	// ResourceBindingNamespaceLabel is added to objects to specify associated ResourceBinding's namespace.
 	ResourceBindingNamespaceLabel = "resourcebinding.karmada.io/namespace"
 

pkg/controllers/binding/binding_controller.go

@@ -6,7 +6,6 @@ import (
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/meta"
-	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/dynamic"
 	"k8s.io/client-go/tools/record"
@@ -47,10 +46,12 @@ func (c *ResourceBindingController) Reconcile(ctx context.Context, req controlle
 	if err := c.Client.Get(context.TODO(), req.NamespacedName, binding); err != nil {
 		// The resource no longer exist, clean up derived Work objects.
 		if apierrors.IsNotFound(err) {
-			return helper.DeleteWorks(c.Client, labels.Set{
-				workv1alpha2.ResourceBindingNamespaceLabel: req.Namespace,
-				workv1alpha2.ResourceBindingNameLabel:      req.Name,
-			})
+			klog.V(4).Infof("Begin to delete works owned by binding(%s).", req.NamespacedName.String())
+			err = helper.DeleteWorkByRBNamespaceAndName(c.Client, req.Namespace, req.Name)
+			if err != nil {
+				return controllerruntime.Result{Requeue: true}, err
+			}
+			return controllerruntime.Result{}, nil
 		}
 
 		return controllerruntime.Result{Requeue: true}, err
@@ -117,18 +118,31 @@ func (c *ResourceBindingController) SetupWithManager(mgr controllerruntime.Manag
 		func(a client.Object) []reconcile.Request {
 			var requests []reconcile.Request
 
+			// TODO: Delete this logic in the next release to prevent incompatibility when upgrading the current release (v0.9.0).
 			labels := a.GetLabels()
-			resourcebindingNamespace, namespaceExist := labels[workv1alpha2.ResourceBindingNamespaceLabel]
-			resourcebindingName, nameExist := labels[workv1alpha2.ResourceBindingNameLabel]
-			if !namespaceExist || !nameExist {
-				return nil
+			crNamespace, namespaceExist := labels[workv1alpha2.ResourceBindingNamespaceLabel]
+			crName, nameExist := labels[workv1alpha2.ResourceBindingNameLabel]
+			if namespaceExist && nameExist {
+				requests = append(requests, reconcile.Request{
+					NamespacedName: types.NamespacedName{
+						Namespace: crNamespace,
+						Name:      crName,
+					},
+				})
 			}
-			namespacesName := types.NamespacedName{
-				Namespace: resourcebindingNamespace,
-				Name:      resourcebindingName,
+
+			annotations := a.GetAnnotations()
+			crNamespace, namespaceExist = annotations[workv1alpha2.ResourceBindingNamespaceLabel]
+			crName, nameExist = annotations[workv1alpha2.ResourceBindingNameLabel]
+			if namespaceExist && nameExist {
+				requests = append(requests, reconcile.Request{
+					NamespacedName: types.NamespacedName{
+						Namespace: crNamespace,
+						Name:      crName,
+					},
+				})
 			}
 
-			requests = append(requests, reconcile.Request{NamespacedName: namespacesName})
 			return requests
 		})
 

pkg/controllers/binding/cluster_resource_binding_controller.go

@@ -6,7 +6,6 @@ import (
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/meta"
-	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/dynamic"
 	"k8s.io/client-go/tools/record"
@@ -47,9 +46,12 @@ func (c *ClusterResourceBindingController) Reconcile(ctx context.Context, req co
 	if err := c.Client.Get(context.TODO(), req.NamespacedName, clusterResourceBinding); err != nil {
 		// The resource no longer exist, clean up derived Work objects.
 		if apierrors.IsNotFound(err) {
-			return helper.DeleteWorks(c.Client, labels.Set{
-				workv1alpha2.ClusterResourceBindingLabel: req.Name,
-			})
+			klog.V(4).Infof("Begin to delete works owned by binding(%s).", req.NamespacedName.String())
+			err = helper.DeleteWorkByCRBName(c.Client, req.Name)
+			if err != nil {
+				return controllerruntime.Result{Requeue: true}, err
+			}
+			return controllerruntime.Result{}, nil
 		}
 
 		return controllerruntime.Result{Requeue: true}, err
@@ -111,16 +113,27 @@ func (c *ClusterResourceBindingController) SetupWithManager(mgr controllerruntim
 		func(a client.Object) []reconcile.Request {
 			var requests []reconcile.Request
 
+			// TODO: Delete this logic in the next release to prevent incompatibility when upgrading the current release (v0.9.0).
 			labels := a.GetLabels()
-			clusterResourcebindingName, nameExist := labels[workv1alpha2.ClusterResourceBindingLabel]
-			if !nameExist {
-				return nil
+			crbName, nameExist := labels[workv1alpha2.ClusterResourceBindingLabel]
+			if nameExist {
+				requests = append(requests, reconcile.Request{
+					NamespacedName: types.NamespacedName{
+						Name: crbName,
+					},
+				})
 			}
-			namespacesName := types.NamespacedName{
-				Name: clusterResourcebindingName,
+
+			annotations := a.GetAnnotations()
+			crbName, nameExist = annotations[workv1alpha2.ClusterResourceBindingLabel]
+			if nameExist {
+				requests = append(requests, reconcile.Request{
+					NamespacedName: types.NamespacedName{
+						Name: crbName,
+					},
+				})
 			}
 
-			requests = append(requests, reconcile.Request{NamespacedName: namespacesName})
 			return requests
 		})
 

pkg/controllers/binding/common.go

@@ -97,7 +97,8 @@ func ensureWork(c client.Client, workload *unstructured.Unstructured, overrideMa
 			}
 		}
 
-		annotations, err := recordAppliedOverrides(cops, ops)
+		annotations := mergeAnnotations(clonedWorkload, binding, scope)
+		annotations, err = recordAppliedOverrides(cops, ops, annotations)
 		if err != nil {
 			klog.Errorf("failed to record appliedOverrides, Error: %v", err)
 			return err
@@ -150,22 +151,36 @@ func mergeLabel(workload *unstructured.Unstructured, workNamespace string, bindi
 	var workLabel = make(map[string]string)
 	util.MergeLabel(workload, workv1alpha2.WorkNamespaceLabel, workNamespace)
 	util.MergeLabel(workload, workv1alpha2.WorkNameLabel, names.GenerateWorkName(workload.GetKind(), workload.GetName(), workload.GetNamespace()))
-
 	if scope == apiextensionsv1.NamespaceScoped {
-		util.MergeLabel(workload, workv1alpha2.ResourceBindingNamespaceLabel, binding.GetNamespace())
-		util.MergeLabel(workload, workv1alpha2.ResourceBindingNameLabel, binding.GetName())
-		workLabel[workv1alpha2.ResourceBindingNamespaceLabel] = binding.GetNamespace()
-		workLabel[workv1alpha2.ResourceBindingNameLabel] = binding.GetName()
+		util.MergeLabel(workload, workv1alpha2.ResourceBindingReferenceKey, names.GenerateBindingReferenceKey(binding.GetNamespace(), binding.GetName()))
+		workLabel[workv1alpha2.ResourceBindingReferenceKey] = names.GenerateBindingReferenceKey(binding.GetNamespace(), binding.GetName())
 	} else {
-		util.MergeLabel(workload, workv1alpha2.ClusterResourceBindingLabel, binding.GetName())
-		workLabel[workv1alpha2.ClusterResourceBindingLabel] = binding.GetName()
+		util.MergeLabel(workload, workv1alpha2.ClusterResourceBindingReferenceKey, names.GenerateBindingReferenceKey("", binding.GetName()))
+		workLabel[workv1alpha2.ClusterResourceBindingReferenceKey] = names.GenerateBindingReferenceKey("", binding.GetName())
 	}
-
 	return workLabel
 }
 
-func recordAppliedOverrides(cops *overridemanager.AppliedOverrides, ops *overridemanager.AppliedOverrides) (map[string]string, error) {
+func mergeAnnotations(workload *unstructured.Unstructured, binding metav1.Object, scope apiextensionsv1.ResourceScope) map[string]string {
 	annotations := make(map[string]string)
+	if scope == apiextensionsv1.NamespaceScoped {
+		util.MergeAnnotation(workload, workv1alpha2.ResourceBindingNamespaceLabel, binding.GetNamespace())
+		util.MergeAnnotation(workload, workv1alpha2.ResourceBindingNameLabel, binding.GetName())
+		annotations[workv1alpha2.ResourceBindingNamespaceLabel] = binding.GetNamespace()
+		annotations[workv1alpha2.ResourceBindingNameLabel] = binding.GetName()
+	} else {
+		util.MergeAnnotation(workload, workv1alpha2.ClusterResourceBindingLabel, binding.GetName())
+		annotations[workv1alpha2.ClusterResourceBindingLabel] = binding.GetName()
+	}
+
+	return annotations
+}
+
+func recordAppliedOverrides(cops *overridemanager.AppliedOverrides, ops *overridemanager.AppliedOverrides,
+	annotations map[string]string) (map[string]string, error) {
+	if annotations == nil {
+		annotations = make(map[string]string)
+	}
 
 	if cops != nil {
 		appliedBytes, err := cops.MarshalJSON()

pkg/util/helper/binding.go

@@ -6,6 +6,7 @@ import (
 
 	corev1 "k8s.io/api/core/v1"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
@@ -15,7 +16,6 @@ import (
 	"k8s.io/apimachinery/pkg/util/sets"
 	"k8s.io/client-go/dynamic"
 	"k8s.io/klog/v2"
-	controllerruntime "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	workv1alpha1 "github.com/karmada-io/karmada/pkg/apis/work/v1alpha1"
@@ -81,29 +81,51 @@ func GetBindingClusterNames(targetClusters []workv1alpha2.TargetCluster) []strin
 // FindOrphanWorks retrieves all works that labeled with current binding(ResourceBinding or ClusterResourceBinding) objects,
 // then pick the works that not meet current binding declaration.
 func FindOrphanWorks(c client.Client, bindingNamespace, bindingName string, clusterNames []string, scope apiextensionsv1.ResourceScope) ([]workv1alpha1.Work, error) {
-	workList := &workv1alpha1.WorkList{}
+	var needJudgeWorks []workv1alpha1.Work
 	if scope == apiextensionsv1.NamespaceScoped {
-		selector := labels.SelectorFromSet(labels.Set{
+		// TODO: Delete this logic in the next release to prevent incompatibility when upgrading the current release (v0.9.0).
+		workList, err := GetWorksByLabelSelector(c, labels.SelectorFromSet(labels.Set{
 			workv1alpha2.ResourceBindingNamespaceLabel: bindingNamespace,
 			workv1alpha2.ResourceBindingNameLabel:      bindingName,
-		})
+		}))
+		if err != nil {
+			klog.Errorf("Failed to get works by ResourceBinding(%s/%s): %v", bindingNamespace, bindingName, err)
+			return nil, err
+		}
+		needJudgeWorks = append(needJudgeWorks, workList.Items...)
 
-		if err := c.List(context.TODO(), workList, &client.ListOptions{LabelSelector: selector}); err != nil {
+		workList, err = GetWorksByLabelSelector(c, labels.SelectorFromSet(labels.Set{
+			workv1alpha2.ResourceBindingReferenceKey: names.GenerateBindingReferenceKey(bindingNamespace, bindingName),
+		}))
+		if err != nil {
+			klog.Errorf("Failed to get works by ResourceBinding(%s/%s): %v", bindingNamespace, bindingName, err)
 			return nil, err
 		}
+		needJudgeWorks = append(needJudgeWorks, workList.Items...)
 	} else {
-		selector := labels.SelectorFromSet(labels.Set{
+		// TODO: Delete this logic in the next release to prevent incompatibility when upgrading the current release (v0.9.0).
+		workList, err := GetWorksByLabelSelector(c, labels.SelectorFromSet(labels.Set{
 			workv1alpha2.ClusterResourceBindingLabel: bindingName,
-		})
+		}))
+		if err != nil {
+			klog.Errorf("Failed to get works by ClusterResourceBinding(%s): %v", bindingName, err)
+			return nil, err
+		}
+		needJudgeWorks = append(needJudgeWorks, workList.Items...)
 
-		if err := c.List(context.TODO(), workList, &client.ListOptions{LabelSelector: selector}); err != nil {
+		workList, err = GetWorksByLabelSelector(c, labels.SelectorFromSet(labels.Set{
+			workv1alpha2.ClusterResourceBindingReferenceKey: names.GenerateBindingReferenceKey("", bindingName),
+		}))
+		if err != nil {
+			klog.Errorf("Failed to get works by ClusterResourceBinding(%s): %v", bindingName, err)
 			return nil, err
 		}
+		needJudgeWorks = append(needJudgeWorks, workList.Items...)
 	}
 
 	var orphanWorks []workv1alpha1.Work
 	expectClusters := sets.NewString(clusterNames...)
-	for _, work := range workList.Items {
+	for _, work := range needJudgeWorks {
 		workTargetCluster, err := names.GetClusterName(work.GetNamespace())
 		if err != nil {
 			klog.Errorf("Failed to get cluster name which Work %s/%s belongs to. Error: %v.",
@@ -174,27 +196,61 @@ func GetWorks(c client.Client, ls labels.Set) (*workv1alpha1.WorkList, error) {
 	return works, c.List(context.TODO(), works, listOpt)
 }
 
+// DeleteWorkByRBNamespaceAndName will delete all Work objects by ResourceBinding namespace and name.
+func DeleteWorkByRBNamespaceAndName(c client.Client, namespace, name string) error {
+	err := DeleteWorks(c, labels.Set{
+		workv1alpha2.ResourceBindingReferenceKey: names.GenerateBindingReferenceKey(namespace, name),
+	})
+	if err != nil {
+		return err
+	}
+
+	// TODO: Delete this logic in the next release to prevent incompatibility when upgrading the current release (v0.9.0).
+	return DeleteWorks(c, labels.Set{
+		workv1alpha2.ResourceBindingNamespaceLabel: namespace,
+		workv1alpha2.ResourceBindingNameLabel:      name,
+	})
+}
+
+// DeleteWorkByCRBName will delete all Work objects by ClusterResourceBinding name.
+func DeleteWorkByCRBName(c client.Client, name string) error {
+	err := DeleteWorks(c, labels.Set{
+		workv1alpha2.ClusterResourceBindingReferenceKey: names.GenerateBindingReferenceKey("", name),
+	})
+	if err != nil {
+		return err
+	}
+
+	// TODO: Delete this logic in the next release to prevent incompatibility when upgrading the current release (v0.9.0).
+	return DeleteWorks(c, labels.Set{
+		workv1alpha2.ClusterResourceBindingLabel: name,
+	})
+}
+
 // DeleteWorks will delete all Work objects by labels.
-func DeleteWorks(c client.Client, selector labels.Set) (controllerruntime.Result, error) {
+func DeleteWorks(c client.Client, selector labels.Set) error {
 	workList, err := GetWorks(c, selector)
 	if err != nil {
 		klog.Errorf("Failed to get works by label %v: %v", selector, err)
-		return controllerruntime.Result{Requeue: true}, err
+		return err
 	}
 
 	var errs []error
 	for index, work := range workList.Items {
 		if err := c.Delete(context.TODO(), &workList.Items[index]); err != nil {
 			klog.Errorf("Failed to delete work(%s/%s): %v", work.Namespace, work.Name, err)
+			if apierrors.IsNotFound(err) {
+				continue
+			}
 			errs = append(errs, err)
 		}
 	}
 
 	if len(errs) > 0 {
-		return controllerruntime.Result{Requeue: true}, errors.NewAggregate(errs)
+		return errors.NewAggregate(errs)
 	}
 
-	return controllerruntime.Result{}, nil
+	return nil
 }
 
 // GenerateNodeClaimByPodSpec will return a NodeClaim from PodSpec.

pkg/util/helper/work.go

@@ -5,6 +5,7 @@ import (
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/klog/v2"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -59,3 +60,14 @@ func CreateOrUpdateWork(client client.Client, workMeta metav1.ObjectMeta, resour
 
 	return nil
 }
+
+// GetWorksByLabelSelector get WorkList by matching label selector.
+func GetWorksByLabelSelector(c client.Client, selector labels.Selector) (*workv1alpha1.WorkList, error) {
+	workList := &workv1alpha1.WorkList{}
+	err := c.List(context.TODO(), workList, &client.ListOptions{LabelSelector: selector})
+	if err != nil {
+		return nil, err
+	}
+
+	return workList, nil
+}