cleanup: add finalizers for mcs to make code graceful

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

pkg/clustertree/cluster-manager/controllers/mcs/serviceexport_controller.go

@@ -2,6 +2,7 @@ package mcs
 
 import (
 	"context"
+	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 
 	"github.com/go-logr/logr"
 	corev1 "k8s.io/api/core/v1"
@@ -45,28 +46,28 @@ func (c *ServiceExportController) Reconcile(ctx context.Context, request reconci
 		klog.V(4).Infof("============ %s has been reconciled =============", request.NamespacedName.String())
 	}()
 
-	var shouldDelete bool
 	serviceExport := &mcsv1alpha1.ServiceExport{}
 	if err := c.RootClient.Get(ctx, request.NamespacedName, serviceExport); err != nil {
-		if !apierrors.IsNotFound(err) {
-			return controllerruntime.Result{Requeue: true}, err
+		if apierrors.IsNotFound(err) {
+			return controllerruntime.Result{}, nil
 		}
-		shouldDelete = true
+
+		return controllerruntime.Result{Requeue: true}, err
 	}
 
 	// The serviceExport is being deleted, in which case we should clear endpointSlice.
-	if shouldDelete || !serviceExport.DeletionTimestamp.IsZero() {
+	if !serviceExport.DeletionTimestamp.IsZero() {
 		if err := c.removeAnnotation(ctx, request.Namespace, request.Name); err != nil {
 			return controllerruntime.Result{Requeue: true}, err
 		}
-		return controllerruntime.Result{}, nil
+		return c.removeFinalizer(ctx, serviceExport)
 	}
 
 	err := c.syncServiceExport(ctx, serviceExport)
 	if err != nil {
 		return controllerruntime.Result{Requeue: true}, err
 	}
-	return controllerruntime.Result{}, nil
+	return c.ensureFinalizer(ctx, serviceExport)
 }
 
 func (c *ServiceExportController) SetupWithManager(mgr manager.Manager) error {
@@ -215,3 +216,31 @@ func (c *ServiceExportController) syncServiceExport(ctx context.Context, export
 	c.EventRecorder.Event(export, corev1.EventTypeNormal, "Synced", "serviceExport has been synced to endpointSlice's annotation successfully")
 	return nil
 }
+
+func (c *ServiceExportController) ensureFinalizer(ctx context.Context, export *mcsv1alpha1.ServiceExport) (reconcile.Result, error) {
+	if controllerutil.ContainsFinalizer(export, utils.MCSFinalizer) {
+		return controllerruntime.Result{}, nil
+	}
+
+	controllerutil.AddFinalizer(export, utils.MCSFinalizer)
+	err := c.RootClient.Update(ctx, export)
+	if err != nil {
+		return controllerruntime.Result{Requeue: true}, err
+	}
+
+	return controllerruntime.Result{}, nil
+}
+
+func (c *ServiceExportController) removeFinalizer(ctx context.Context, export *mcsv1alpha1.ServiceExport) (reconcile.Result, error) {
+	if !controllerutil.ContainsFinalizer(export, utils.MCSFinalizer) {
+		return controllerruntime.Result{}, nil
+	}
+
+	controllerutil.RemoveFinalizer(export, utils.MCSFinalizer)
+	err := c.RootClient.Update(ctx, export)
+	if err != nil {
+		return controllerruntime.Result{Requeue: true}, err
+	}
+
+	return controllerruntime.Result{}, nil
+}

pkg/clustertree/cluster-manager/controllers/mcs/serviceimport_controller.go

@@ -3,6 +3,7 @@ package mcs
 import (
 	"context"
 	"fmt"
+	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"strings"
 
 	"github.com/go-logr/logr"
@@ -109,29 +110,29 @@ func (c *ServiceImportController) Reconcile(key utils.QueueKey) error {
 		klog.V(4).Infof("============ %s has been reconciled in cluster %s =============", clusterWideKey.NamespaceKey(), c.LeafNodeName)
 	}()
 
-	var shouldDelete bool
 	serviceImport := &mcsv1alpha1.ServiceImport{}
 	if err := c.LeafClient.Get(c.ctx, types.NamespacedName{Namespace: clusterWideKey.Namespace, Name: clusterWideKey.Name}, serviceImport); err != nil {
-		if !apierrors.IsNotFound(err) {
-			klog.Errorf("Get %s in cluster %s failed, Error: %v", clusterWideKey.NamespaceKey(), c.LeafNodeName, err)
-			return err
+		if apierrors.IsNotFound(err) {
+			return nil
 		}
-		shouldDelete = true
+
+		klog.Errorf("Get %s in cluster %s failed, Error: %v", clusterWideKey.NamespaceKey(), c.LeafNodeName, err)
+		return err
 	}
 
 	// The serviceImport is being deleted, in which case we should clear endpointSlice.
-	if shouldDelete || !serviceImport.DeletionTimestamp.IsZero() {
+	if !serviceImport.DeletionTimestamp.IsZero() {
 		if err := c.cleanupServiceAndEndpointSlice(c.ctx, clusterWideKey.Namespace, clusterWideKey.Name); err != nil {
 			return err
 		}
-		return nil
+		return c.removeFinalizer(c.ctx, serviceImport)
 	}
 
 	err := c.syncServiceImport(c.ctx, serviceImport)
 	if err != nil {
 		return err
 	}
-	return nil
+	return c.ensureFinalizer(c.ctx, serviceImport)
 }
 
 func (c *ServiceImportController) cleanupServiceAndEndpointSlice(ctx context.Context, namespace, name string) error {
@@ -509,6 +510,34 @@ func (c *ServiceImportController) checkServiceType(service *corev1.Service) erro
 	return nil
 }
 
+func (c *ServiceImportController) removeFinalizer(ctx context.Context, serviceImport *mcsv1alpha1.ServiceImport) error {
+	if !controllerutil.ContainsFinalizer(serviceImport, utils.MCSFinalizer) {
+		return nil
+	}
+
+	controllerutil.RemoveFinalizer(serviceImport, utils.MCSFinalizer)
+	err := c.LeafClient.Update(ctx, serviceImport)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (c *ServiceImportController) ensureFinalizer(ctx context.Context, serviceImport *mcsv1alpha1.ServiceImport) error {
+	if controllerutil.ContainsFinalizer(serviceImport, utils.MCSFinalizer) {
+		return nil
+	}
+
+	controllerutil.AddFinalizer(serviceImport, utils.MCSFinalizer)
+	err := c.LeafClient.Update(ctx, serviceImport)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
 func isServiceIPSet(service *corev1.Service) bool {
 	return service.Spec.ClusterIP != corev1.ClusterIPNone && service.Spec.ClusterIP != ""
 }

pkg/utils/constants.go

@@ -83,8 +83,6 @@ const (
 	EnvNodeName    = "NODE_NAME"
 )
 
-const ClusterStartControllerFinalizer = "kosmos.io/cluster-start-finazlizer"
-
 // mcs
 const (
 	ServiceKey               = "kubernetes.io/service-name"
@@ -162,6 +160,12 @@ const (
 	MasterRooTCAName    = "master-root-ca.crt"
 )
 
+// finalizers
+const (
+	ClusterStartControllerFinalizer = "kosmos.io/cluster-start-finalizer"
+	MCSFinalizer                    = "kosmos.io/multi-cluster-service-finalizer"
+)
+
 var GVR_CONFIGMAP = schema.GroupVersionResource{
 	Group:    "",
 	Version:  "v1",