Merge pull request #211 from limhawjia/feat-federate-controller-adoption

feat: allow adoption of orphaned federated objects

Author: mrlihanbo

.github/workflows/ci.yml

@@ -45,9 +45,9 @@ jobs:
           version: v1.53.3
           only-new-issues: true
           args: >
-            --timeout=5m
-            --max-issues-per-linter=0
-            --max-same-issues=0
+            --timeout=8m
+            --max-issues-per-linter=10
+            --max-same-issues=10
             --uniq-by-line=false
 
   verify-codegen:

.golangci.yml

@@ -256,7 +256,9 @@ linters-settings:
           Copyright {{ YEAR }} The KubeAdmiral Authors\.
 
           {{ MAIN }}
-        BOILERPLATE: "^({{ KUBERNETES_BOILERPLATE }}|{{ KUBEADMIRAL_BOILERPLATE }})$"
+        CREDIT_BOILERPLATE: |-
+          The design of (the )?[a-zA-z0-9 ]*is inspired by [a-zA-z0-9 '-]*\. Kudos!
+        BOILERPLATE: "^({{ KUBERNETES_BOILERPLATE }}|{{ KUBEADMIRAL_BOILERPLATE }}|{{ CREDIT_BOILERPLATE }})$"
     template: "{{ BOILERPLATE }}"
   forbidigo:
     # Forbid the following identifiers (list of regexp).

pkg/apis/core/v1alpha1/types_collectedstatus.go

@@ -5,7 +5,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-http://www.apache.org/licenses/LICENSE-2.0
+    http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,

pkg/controllers/federate/controller.go

@@ -306,18 +306,19 @@ func (c *FederateController) reconcile(ctx context.Context, key workerKey) (stat
 	}
 
 	if fedObject != nil {
-		// To account for the very small chance of name collision, we verify the owner reference before proceeding.
-		ownedbySource := false
-
-		for _, ref := range fedObject.GetOwnerReferences() {
-			if schema.FromAPIVersionAndKind(ref.APIVersion, ref.Kind) == key.gvk &&
-				sourceObject.GetName() == ref.Name {
-				ownedbySource = true
+		var owner *metav1.OwnerReference
+		ownerRefs := fedObject.GetOwnerReferences()
+		for i, ref := range ownerRefs {
+			if ref.Controller != nil && *ref.Controller {
+				owner = &ownerRefs[i]
 				break
 			}
 		}
 
-		if !ownedbySource {
+		// To account for the very small chance of name collision, we verify the owner reference before proceeding.
+		// Note that we allow the adoption of orphaned federated objects.
+		if owner != nil &&
+			(schema.FromAPIVersionAndKind(owner.APIVersion, owner.Kind) != key.gvk || owner.Name != sourceObject.GetName()) {
 			logger.Error(nil, "Federated object not owned by source object, possible name collision detected")
 			return worker.StatusErrorNoRetry
 		}

pkg/controllers/nsautoprop/controller.go

@@ -28,7 +28,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/labels"
-	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
 	corev1informers "k8s.io/client-go/informers/core/v1"
 	kubeclient "k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/tools/cache"
@@ -282,7 +281,7 @@ func (c *Controller) reconcile(ctx context.Context, qualifiedName common.Qualifi
 		string(adoption.ConflictResolutionAdopt),
 	)
 	if err != nil {
-		utilruntime.HandleError(err)
+		keyedLogger.Error(err, "Failed to ensure annotation")
 		return worker.StatusError
 	}
 	needsUpdate = needsUpdate || isDirty
@@ -294,7 +293,7 @@ func (c *Controller) reconcile(ctx context.Context, qualifiedName common.Qualifi
 		string(orphaning.OrphanManagedResourcesAdopted),
 	)
 	if err != nil {
-		utilruntime.HandleError(err)
+		keyedLogger.Error(err, "Failed to ensure annotation")
 		return worker.StatusError
 	}
 	needsUpdate = needsUpdate || isDirty
@@ -307,7 +306,7 @@ func (c *Controller) reconcile(ctx context.Context, qualifiedName common.Qualifi
 		typeConfig.GetControllers(),
 	)
 	if err != nil {
-		utilruntime.HandleError(err)
+		keyedLogger.Error(err, "Failed to update pending controllers")
 		return worker.StatusError
 	}
 	needsUpdate = needsUpdate || isDirty

pkg/controllers/scheduler/framework/plugins/apiresources/apiresources.go

@@ -1,4 +1,4 @@
-// The design of this plugin is heavily inspired by karmada-scheduler. Kudos!
+// The design of this plugin is inspired by karmada-scheduler. Kudos!
 
 package apiresources
 

pkg/controllers/scheduler/framework/plugins/apiresources/apiresources_test.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2023 The KubeAdmiral Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package apiresources
 
 import (

pkg/util/collectedstatusadapters/adapter.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2023 The KubeAdmiral Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package collectedstatusadapters
 
 import (

pkg/util/fedobjectadapters/adapters.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2023 The KubeAdmiral Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package fedobjectadapters
 
 import (
@@ -138,4 +154,3 @@ func Delete(
 		return fedv1a1Client.FederatedObjects(namespace).Delete(ctx, name, opts)
 	}
 }
-

pkg/util/informermanager/federatedinformermanager.go

@@ -105,10 +105,10 @@ func NewFederatedInformerManager(
 		queue: workqueue.NewRateLimitingQueue(
 			workqueue.NewItemExponentialFailureRateLimiter(100*time.Millisecond, 10*time.Second),
 		),
-		podListerSemaphore:     semaphore.NewWeighted(3), // TODO: make this configurable
-		initialClusters:        sets.New[string](),
-		podEventHandlers:       []*ResourceEventHandlerWithClusterFuncs{},
-		podEventRegistrations:  map[string]map[*ResourceEventHandlerWithClusterFuncs]cache.ResourceEventHandlerRegistration{},
+		podListerSemaphore:    semaphore.NewWeighted(3), // TODO: make this configurable
+		initialClusters:       sets.New[string](),
+		podEventHandlers:      []*ResourceEventHandlerWithClusterFuncs{},
+		podEventRegistrations: map[string]map[*ResourceEventHandlerWithClusterFuncs]cache.ResourceEventHandlerRegistration{},
 	}
 
 	clusterInformer.Informer().AddEventHandler(cache.FilteringResourceEventHandler{

pkg/util/signals/signal.go

@@ -25,9 +25,7 @@ import (
 	"k8s.io/klog/v2"
 )
 
-var (
-	gracefulShutdownSignals = []os.Signal{os.Interrupt, syscall.SIGTERM}
-)
+var gracefulShutdownSignals = []os.Signal{os.Interrupt, syscall.SIGTERM}
 
 // SetupSignalHandler configures the cancel func to be called when one of the gracefulShutdownSignals is received. A
 // subsequent gracefulShutdownSignal would trigger a forceful termination of the program.