|
| 1 | +/* |
| 2 | +Copyright (c) Microsoft Corporation. |
| 3 | +Licensed under the MIT license. |
| 4 | +*/ |
| 5 | + |
| 6 | +// Package membercluster features the MemberCluster controller for watching |
| 7 | +// update/delete events to the MemberCluster object and removes finalizers |
| 8 | +// on all fleet networking resources in the fleet member cluster namespace. |
| 9 | +package membercluster |
| 10 | + |
| 11 | +import ( |
| 12 | + "context" |
| 13 | + "fmt" |
| 14 | + "time" |
| 15 | + |
| 16 | + "golang.org/x/sync/errgroup" |
| 17 | + "k8s.io/apimachinery/pkg/api/errors" |
| 18 | + "k8s.io/client-go/tools/record" |
| 19 | + "k8s.io/klog/v2" |
| 20 | + ctrl "sigs.k8s.io/controller-runtime" |
| 21 | + "sigs.k8s.io/controller-runtime/pkg/client" |
| 22 | + "sigs.k8s.io/controller-runtime/pkg/event" |
| 23 | + "sigs.k8s.io/controller-runtime/pkg/predicate" |
| 24 | + |
| 25 | + clusterv1beta1 "go.goms.io/fleet/apis/cluster/v1beta1" |
| 26 | + "go.goms.io/fleet/pkg/utils/controller" |
| 27 | + |
| 28 | + fleetnetv1alpha1 "go.goms.io/fleet-networking/api/v1alpha1" |
| 29 | + "go.goms.io/fleet-networking/pkg/common/hubconfig" |
| 30 | +) |
| 31 | + |
| 32 | +const ( |
| 33 | + ControllerName = "membercluster-controller" |
| 34 | +) |
| 35 | + |
| 36 | +// Reconciler reconciles a MemberCluster object. |
| 37 | +type Reconciler struct { |
| 38 | + client.Client |
| 39 | + Recorder record.EventRecorder |
| 40 | + // the wait time in minutes before we need to force delete a member cluster. |
| 41 | + ForceDeleteWaitTime time.Duration |
| 42 | +} |
| 43 | + |
| 44 | +// Reconcile watches the deletion of the member cluster and removes finalizers on fleet networking resources in the |
| 45 | +// member cluster namespace. |
| 46 | +func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) { |
| 47 | + mcObjRef := klog.KRef(req.Namespace, req.Name) |
| 48 | + startTime := time.Now() |
| 49 | + klog.V(2).InfoS("Reconciliation starts", "memberCluster", mcObjRef) |
| 50 | + defer func() { |
| 51 | + latency := time.Since(startTime).Milliseconds() |
| 52 | + klog.V(2).InfoS("Reconciliation ends", "memberCluster", mcObjRef, "latency", latency) |
| 53 | + }() |
| 54 | + var mc clusterv1beta1.MemberCluster |
| 55 | + if err := r.Client.Get(ctx, req.NamespacedName, &mc); err != nil { |
| 56 | + if errors.IsNotFound(err) { |
| 57 | + klog.V(4).InfoS("Ignoring NotFound memberCluster", "memberCluster", mcObjRef) |
| 58 | + return ctrl.Result{}, nil |
| 59 | + } |
| 60 | + klog.ErrorS(err, "Failed to get memberCluster", "memberCluster", mcObjRef) |
| 61 | + return ctrl.Result{}, err |
| 62 | + } |
| 63 | + if mc.DeletionTimestamp.IsZero() { |
| 64 | + klog.ErrorS(controller.NewUnexpectedBehaviorError(fmt.Errorf("member cluster %s is not being deleted", |
| 65 | + mc.Name)), "The member cluster should have deletionTimeStamp set to a non-zero/non-nil value") |
| 66 | + return ctrl.Result{}, nil // no need to retry. |
| 67 | + } |
| 68 | + |
| 69 | + // Handle deleting member cluster, removes finalizers on all the resources in the cluster namespace |
| 70 | + // after member cluster force delete wait time. |
| 71 | + if !mc.DeletionTimestamp.IsZero() && time.Since(mc.DeletionTimestamp.Time) >= r.ForceDeleteWaitTime { |
| 72 | + klog.V(2).InfoS("The member cluster deletion is stuck removing the "+ |
| 73 | + "finalizers from all the resources in member cluster namespace", "memberCluster", mcObjRef) |
| 74 | + return r.removeFinalizer(ctx, mc) |
| 75 | + } |
| 76 | + // we need to only wait for force delete wait time, if the update/delete member cluster event takes |
| 77 | + // longer to be reconciled we need to account for that time. |
| 78 | + return ctrl.Result{RequeueAfter: r.ForceDeleteWaitTime - time.Since(mc.DeletionTimestamp.Time)}, nil |
| 79 | +} |
| 80 | + |
| 81 | +// removeFinalizer removes finalizers on the resources in the member cluster namespace. |
| 82 | +// For EndpointSliceExport, InternalServiceImport & InternalServiceExport resources, the finalizers should be |
| 83 | +// removed by other hub networking controllers when leaving. So this MemberCluster controller only handles |
| 84 | +// EndpointSliceImports here. |
| 85 | +func (r *Reconciler) removeFinalizer(ctx context.Context, mc clusterv1beta1.MemberCluster) (ctrl.Result, error) { |
| 86 | + // Remove finalizer for EndpointSliceImport resources in the cluster namespace. |
| 87 | + mcObjRef := klog.KRef(mc.Namespace, mc.Name) |
| 88 | + mcNamespace := fmt.Sprintf(hubconfig.HubNamespaceNameFormat, mc.Name) |
| 89 | + var endpointSliceImportList fleetnetv1alpha1.EndpointSliceImportList |
| 90 | + if err := r.Client.List(ctx, &endpointSliceImportList, client.InNamespace(mcNamespace)); err != nil { |
| 91 | + klog.ErrorS(err, "Failed to list endpointSliceImports", "memberCluster", mcObjRef) |
| 92 | + return ctrl.Result{}, err |
| 93 | + } |
| 94 | + errs, ctx := errgroup.WithContext(ctx) |
| 95 | + for i := range endpointSliceImportList.Items { |
| 96 | + esi := &endpointSliceImportList.Items[i] |
| 97 | + errs.Go(func() error { |
| 98 | + esiObjRef := klog.KRef(esi.Namespace, esi.Name) |
| 99 | + esi.SetFinalizers(nil) |
| 100 | + if err := r.Client.Update(ctx, esi); err != nil { |
| 101 | + klog.ErrorS(err, "Failed to remove finalizers for endpointSliceImport", |
| 102 | + "memberCluster", mcObjRef, "endpointSliceImport", esiObjRef) |
| 103 | + return err |
| 104 | + } |
| 105 | + klog.V(2).InfoS("Removed finalizers for endpointSliceImport", |
| 106 | + "memberCluster", mcObjRef, "endpointSliceImport", esiObjRef) |
| 107 | + return nil |
| 108 | + }) |
| 109 | + } |
| 110 | + return ctrl.Result{}, errs.Wait() |
| 111 | +} |
| 112 | + |
| 113 | +// SetupWithManager sets up the controller with the Manager. |
| 114 | +func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error { |
| 115 | + customPredicate := predicate.Funcs{ |
| 116 | + CreateFunc: func(e event.CreateEvent) bool { |
| 117 | + // Ignore creation events. |
| 118 | + return false |
| 119 | + }, |
| 120 | + DeleteFunc: func(e event.DeleteEvent) bool { |
| 121 | + // trigger reconcile on delete event just in case update event is missed. |
| 122 | + return true |
| 123 | + }, |
| 124 | + UpdateFunc: func(e event.UpdateEvent) bool { |
| 125 | + // If new object is being deleted, trigger reconcile. |
| 126 | + return !e.ObjectNew.GetDeletionTimestamp().IsZero() |
| 127 | + }, |
| 128 | + } |
| 129 | + // Watch for changes to primary resource MemberCluster |
| 130 | + return ctrl.NewControllerManagedBy(mgr). |
| 131 | + For(&clusterv1beta1.MemberCluster{}). |
| 132 | + WithEventFilter(customPredicate). |
| 133 | + Complete(r) |
| 134 | +} |
0 commit comments