operator pdb: fix the remaining issues

Signed-off-by: zhzhuang-zju <[email protected]>

Author: zhzhuang-zju

operator/pkg/controlplane/apiserver/apiserver.go

@@ -17,15 +17,13 @@ limitations under the License.
 package apiserver
 
 import (
-	"context"
 	"fmt"
 
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/labels"
 	kuberuntime "k8s.io/apimachinery/pkg/runtime"
-	"k8s.io/apimachinery/pkg/runtime/schema"
 	clientset "k8s.io/client-go/kubernetes"
 	clientsetscheme "k8s.io/client-go/kubernetes/scheme"
 
@@ -37,6 +35,9 @@ import (
 	"github.com/karmada-io/karmada/operator/pkg/util/patcher"
 )
 
+// DeploymentGVK represents the GroupVersionKind (GVK) for a Kubernetes Deployment resource.
+var DeploymentGVK = appsv1.SchemeGroupVersion.WithKind("Deployment")
+
 // EnsureKarmadaAPIServer creates karmada apiserver deployment and service resource
 func EnsureKarmadaAPIServer(client clientset.Interface, cfg *operatorv1alpha1.KarmadaComponents, name, namespace string, featureGates map[string]bool) error {
 	if err := installKarmadaAPIServer(client, cfg.KarmadaAPIServer, cfg.Etcd, name, namespace, featureGates); err != nil {
@@ -88,17 +89,11 @@ func installKarmadaAPIServer(client clientset.Interface, cfg *operatorv1alpha1.K
 		WithExtraArgs(cfg.ExtraArgs).WithExtraVolumeMounts(cfg.ExtraVolumeMounts).
 		WithExtraVolumes(cfg.ExtraVolumes).WithSidecarContainers(cfg.SidecarContainers).WithResources(cfg.Resources).ForDeployment(apiserverDeployment)
 
-	if err := apiclient.CreateOrUpdateDeployment(client, apiserverDeployment); err != nil {
+	if apiserverDeployment, err = apiclient.CreateOrUpdateDeployment(client, apiserverDeployment); err != nil {
 		return fmt.Errorf("error when creating deployment for %s, err: %w", apiserverDeployment.Name, err)
 	}
 
-	// Fetch persisted Deployment to get real UID
-	persisted, err := client.AppsV1().Deployments(namespace).Get(context.TODO(), apiserverDeployment.GetName(), metav1.GetOptions{})
-	if err != nil {
-		return fmt.Errorf("failed to fetch Deployment %s/%s for PDB owner, err: %w", namespace, apiserverDeployment.GetName(), err)
-	}
-	gvk := schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "Deployment"}
-	ownerRef := *metav1.NewControllerRef(persisted, gvk)
+	ownerRef := *metav1.NewControllerRef(apiserverDeployment, DeploymentGVK)
 	if err := pdb.EnsurePodDisruptionBudget(client, util.KarmadaAPIServerName(name), namespace, cfg.CommonSettings.PodDisruptionBudgetConfig, apiserverDeployment.Spec.Template.Labels, []metav1.OwnerReference{ownerRef}); err != nil {
 		return fmt.Errorf("failed to ensure PDB for apiserver component %s, err: %w", util.KarmadaAPIServerName(name), err)
 	}
@@ -171,18 +166,12 @@ func installKarmadaAggregatedAPIServer(client clientset.Interface, cfg *operator
 		WithPriorityClassName(cfg.CommonSettings.PriorityClassName).
 		WithExtraArgs(cfg.ExtraArgs).WithFeatureGates(featureGates).WithResources(cfg.Resources).ForDeployment(aggregatedAPIServerDeployment)
 
-	if err := apiclient.CreateOrUpdateDeployment(client, aggregatedAPIServerDeployment); err != nil {
+	if aggregatedAPIServerDeployment, err = apiclient.CreateOrUpdateDeployment(client, aggregatedAPIServerDeployment); err != nil {
 		return fmt.Errorf("error when creating deployment for %s, err: %w", aggregatedAPIServerDeployment.Name, err)
 	}
 
-	// Fetch persisted Deployment to get real UID
-	persistedAgg, err := client.AppsV1().Deployments(namespace).Get(context.TODO(), aggregatedAPIServerDeployment.GetName(), metav1.GetOptions{})
-	if err != nil {
-		return fmt.Errorf("failed to fetch Deployment %s/%s for PDB owner, err: %w", namespace, aggregatedAPIServerDeployment.GetName(), err)
-	}
-	gvk2 := schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "Deployment"}
-	ownerRef2 := *metav1.NewControllerRef(persistedAgg, gvk2)
-	if err := pdb.EnsurePodDisruptionBudget(client, util.KarmadaAggregatedAPIServerName(name), namespace, cfg.CommonSettings.PodDisruptionBudgetConfig, aggregatedAPIServerDeployment.Spec.Template.Labels, []metav1.OwnerReference{ownerRef2}); err != nil {
+	ownerRef := *metav1.NewControllerRef(aggregatedAPIServerDeployment, DeploymentGVK)
+	if err := pdb.EnsurePodDisruptionBudget(client, util.KarmadaAggregatedAPIServerName(name), namespace, cfg.CommonSettings.PodDisruptionBudgetConfig, aggregatedAPIServerDeployment.Spec.Template.Labels, []metav1.OwnerReference{ownerRef}); err != nil {
 		return fmt.Errorf("failed to ensure PDB for aggregated apiserver component %s, err: %w", util.KarmadaAggregatedAPIServerName(name), err)
 	}
 

operator/pkg/controlplane/controlplane.go

@@ -17,19 +17,18 @@ limitations under the License.
 package controlplane
 
 import (
-	"context"
 	"fmt"
 
 	appsv1 "k8s.io/api/apps/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	kuberuntime "k8s.io/apimachinery/pkg/runtime"
-	"k8s.io/apimachinery/pkg/runtime/schema"
 	clientset "k8s.io/client-go/kubernetes"
 	clientsetscheme "k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/klog/v2"
 
 	operatorv1alpha1 "github.com/karmada-io/karmada/operator/pkg/apis/operator/v1alpha1"
 	"github.com/karmada-io/karmada/operator/pkg/constants"
+	"github.com/karmada-io/karmada/operator/pkg/controlplane/apiserver"
 	"github.com/karmada-io/karmada/operator/pkg/controlplane/pdb"
 	"github.com/karmada-io/karmada/operator/pkg/util"
 	"github.com/karmada-io/karmada/operator/pkg/util/apiclient"
@@ -49,7 +48,7 @@ func EnsureControlPlaneComponent(component, name, namespace string, featureGates
 		return nil
 	}
 
-	if err := apiclient.CreateOrUpdateDeployment(client, deployment); err != nil {
+	if deployment, err = apiclient.CreateOrUpdateDeployment(client, deployment); err != nil {
 		return fmt.Errorf("failed to create deployment resource for component %s, err: %w", component, err)
 	}
 
@@ -83,14 +82,7 @@ func EnsureControlPlaneComponent(component, name, namespace string, featureGates
 	}
 
 	if commonSettings != nil {
-		// Fetch the persisted Deployment to ensure UID is populated
-		persisted, err := client.AppsV1().Deployments(namespace).Get(context.TODO(), deployment.GetName(), metav1.GetOptions{})
-		if err != nil {
-			return fmt.Errorf("failed to fetch Deployment %s/%s for PDB owner, err: %w", namespace, deployment.GetName(), err)
-		}
-		// Build OwnerReference for controller with real UID
-		gvk := schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "Deployment"}
-		ownerRef := *metav1.NewControllerRef(persisted, gvk)
+		ownerRef := *metav1.NewControllerRef(deployment, apiserver.DeploymentGVK)
 		if err := pdb.EnsurePodDisruptionBudget(client, pdbName, namespace, commonSettings.PodDisruptionBudgetConfig, deployment.Spec.Template.Labels, []metav1.OwnerReference{ownerRef}); err != nil {
 			return fmt.Errorf("failed to ensure PDB for component %s (instance: %s), err: %w", component, pdbName, err)
 		}

operator/pkg/controlplane/etcd/etcd.go

@@ -17,15 +17,13 @@ limitations under the License.
 package etcd
 
 import (
-	"context"
 	"fmt"
 	"strings"
 
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	kuberuntime "k8s.io/apimachinery/pkg/runtime"
-	"k8s.io/apimachinery/pkg/runtime/schema"
 	clientset "k8s.io/client-go/kubernetes"
 	clientsetscheme "k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/component-base/cli/flag"
@@ -38,6 +36,9 @@ import (
 	"github.com/karmada-io/karmada/operator/pkg/util/patcher"
 )
 
+// StatefulSetGVK represents the GroupVersionKind (GVK) for a Kubernetes StatefulSet resource.
+var StatefulSetGVK = appsv1.SchemeGroupVersion.WithKind("StatefulSet")
+
 // EnsureKarmadaEtcd creates etcd StatefulSet and service resource.
 func EnsureKarmadaEtcd(client clientset.Interface, cfg *operatorv1alpha1.LocalEtcd, name, namespace string) error {
 	if err := installKarmadaEtcd(client, name, namespace, cfg); err != nil {
@@ -98,17 +99,11 @@ func installKarmadaEtcd(client clientset.Interface, name, namespace string, cfg
 		WithPriorityClassName(cfg.CommonSettings.PriorityClassName).
 		WithVolumeData(cfg.VolumeData).WithResources(cfg.Resources).ForStatefulSet(etcdStatefulSet)
 
-	if err := apiclient.CreateOrUpdateStatefulSet(client, etcdStatefulSet); err != nil {
+	if etcdStatefulSet, err = apiclient.CreateOrUpdateStatefulSet(client, etcdStatefulSet); err != nil {
 		return fmt.Errorf("error when creating Etcd statefulset, err: %w", err)
 	}
 
-	// Fetch persisted StatefulSet to get real UID
-	persisted, err := client.AppsV1().StatefulSets(namespace).Get(context.TODO(), etcdStatefulSet.GetName(), metav1.GetOptions{})
-	if err != nil {
-		return fmt.Errorf("failed to fetch StatefulSet %s/%s for PDB owner, err: %w", namespace, etcdStatefulSet.GetName(), err)
-	}
-	gvk := schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "StatefulSet"}
-	ownerRef := *metav1.NewControllerRef(persisted, gvk)
+	ownerRef := *metav1.NewControllerRef(etcdStatefulSet, StatefulSetGVK)
 	if err := pdb.EnsurePodDisruptionBudget(client, util.KarmadaEtcdName(name), namespace, cfg.CommonSettings.PodDisruptionBudgetConfig, etcdStatefulSet.Spec.Template.Labels, []metav1.OwnerReference{ownerRef}); err != nil {
 		return fmt.Errorf("failed to ensure PDB for etcd component %s, err: %w", util.KarmadaEtcdName(name), err)
 	}

operator/pkg/controlplane/metricsadapter/metricsadapter.go

@@ -17,18 +17,17 @@ limitations under the License.
 package metricsadapter
 
 import (
-	"context"
 	"fmt"
 
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	kuberuntime "k8s.io/apimachinery/pkg/runtime"
-	"k8s.io/apimachinery/pkg/runtime/schema"
 	clientset "k8s.io/client-go/kubernetes"
 	clientsetscheme "k8s.io/client-go/kubernetes/scheme"
 
 	operatorv1alpha1 "github.com/karmada-io/karmada/operator/pkg/apis/operator/v1alpha1"
+	"github.com/karmada-io/karmada/operator/pkg/controlplane/apiserver"
 	"github.com/karmada-io/karmada/operator/pkg/controlplane/pdb"
 	"github.com/karmada-io/karmada/operator/pkg/util"
 	"github.com/karmada-io/karmada/operator/pkg/util/apiclient"
@@ -71,18 +70,11 @@ func installKarmadaMetricAdapter(client clientset.Interface, cfg *operatorv1alph
 	patcher.NewPatcher().WithAnnotations(cfg.Annotations).WithLabels(cfg.Labels).WithPriorityClassName(cfg.CommonSettings.PriorityClassName).
 		WithResources(cfg.Resources).ForDeployment(metricAdapter)
 
-	if err := apiclient.CreateOrUpdateDeployment(client, metricAdapter); err != nil {
+	if metricAdapter, err = apiclient.CreateOrUpdateDeployment(client, metricAdapter); err != nil {
 		return fmt.Errorf("error when creating deployment for %s, err: %w", metricAdapter.Name, err)
 	}
 
-	// Fetch persisted Deployment to get real UID
-	persisted, err := client.AppsV1().Deployments(namespace).Get(context.TODO(), metricAdapter.GetName(), metav1.GetOptions{})
-	if err != nil {
-		return fmt.Errorf("failed to fetch Deployment %s/%s for PDB owner, err: %w", namespace, metricAdapter.GetName(), err)
-	}
-	// Ensure PDB for the metrics adapter component if configured
-	gvk := schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "Deployment"}
-	ownerRef := *metav1.NewControllerRef(persisted, gvk)
+	ownerRef := *metav1.NewControllerRef(metricAdapter, apiserver.DeploymentGVK)
 	if err := pdb.EnsurePodDisruptionBudget(client, util.KarmadaMetricsAdapterName(name), namespace, cfg.CommonSettings.PodDisruptionBudgetConfig, metricAdapter.Spec.Template.Labels, []metav1.OwnerReference{ownerRef}); err != nil {
 		return fmt.Errorf("failed to ensure PDB for metrics adapter component %s, err: %w", util.KarmadaMetricsAdapterName(name), err)
 	}

operator/pkg/controlplane/pdb/pdb.go

@@ -13,6 +13,7 @@ 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 pdb
 
 import (
@@ -40,11 +41,7 @@ func EnsurePodDisruptionBudget(client clientset.Interface, pdbName, namespace st
 		return nil
 	}
 
-	pdb, err := createPodDisruptionBudget(pdbName, namespace, pdbConfig, componentLabels, ownerRefs)
-	if err != nil {
-		return fmt.Errorf("failed to create PDB manifest for %s, err: %w", pdbName, err)
-	}
-
+	pdb := buildPodDisruptionBudget(pdbName, namespace, pdbConfig, componentLabels, ownerRefs)
 	if err := apiclient.CreateOrUpdatePodDisruptionBudget(client, pdb); err != nil {
 		return fmt.Errorf("failed to create PDB resource for %s, err: %w", pdbName, err)
 	}
@@ -53,8 +50,8 @@ func EnsurePodDisruptionBudget(client clientset.Interface, pdbName, namespace st
 	return nil
 }
 
-// createPodDisruptionBudget creates a PodDisruptionBudget manifest for the component
-func createPodDisruptionBudget(pdbName, namespace string, pdbConfig *operatorv1alpha1.PodDisruptionBudgetConfig, componentLabels map[string]string, ownerRefs []metav1.OwnerReference) (*policyv1.PodDisruptionBudget, error) {
+// buildPodDisruptionBudget returns a PodDisruptionBudget manifest for the component
+func buildPodDisruptionBudget(pdbName, namespace string, pdbConfig *operatorv1alpha1.PodDisruptionBudgetConfig, componentLabels map[string]string, ownerRefs []metav1.OwnerReference) *policyv1.PodDisruptionBudget {
 	blockOwnerDeletion := true
 	isController := true
 
@@ -84,7 +81,7 @@ func createPodDisruptionBudget(pdbName, namespace string, pdbConfig *operatorv1a
 		pdb.ObjectMeta.OwnerReferences[i].BlockOwnerDeletion = &blockOwnerDeletion
 	}
 
-	return pdb, nil
+	return pdb
 }
 
 // deletePodDisruptionBudget deletes a PodDisruptionBudget if it exists

operator/pkg/controlplane/search/search.go

@@ -17,18 +17,17 @@ limitations under the License.
 package search
 
 import (
-	"context"
 	"fmt"
 
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	kuberuntime "k8s.io/apimachinery/pkg/runtime"
-	"k8s.io/apimachinery/pkg/runtime/schema"
 	clientset "k8s.io/client-go/kubernetes"
 	clientsetscheme "k8s.io/client-go/kubernetes/scheme"
 
 	operatorv1alpha1 "github.com/karmada-io/karmada/operator/pkg/apis/operator/v1alpha1"
+	"github.com/karmada-io/karmada/operator/pkg/controlplane/apiserver"
 	"github.com/karmada-io/karmada/operator/pkg/controlplane/etcd"
 	"github.com/karmada-io/karmada/operator/pkg/controlplane/pdb"
 	"github.com/karmada-io/karmada/operator/pkg/util"
@@ -78,17 +77,11 @@ func installKarmadaSearch(client clientset.Interface, cfg *operatorv1alpha1.Karm
 		WithPriorityClassName(cfg.CommonSettings.PriorityClassName).
 		WithExtraArgs(cfg.ExtraArgs).WithResources(cfg.Resources).ForDeployment(searchDeployment)
 
-	if err := apiclient.CreateOrUpdateDeployment(client, searchDeployment); err != nil {
+	if searchDeployment, err = apiclient.CreateOrUpdateDeployment(client, searchDeployment); err != nil {
 		return fmt.Errorf("error when creating deployment for %s, err: %w", searchDeployment.Name, err)
 	}
 
-	// Fetch persisted Deployment to get real UID
-	persisted, err := client.AppsV1().Deployments(namespace).Get(context.TODO(), searchDeployment.GetName(), metav1.GetOptions{})
-	if err != nil {
-		return fmt.Errorf("failed to fetch Deployment %s/%s for PDB owner, err: %w", namespace, searchDeployment.GetName(), err)
-	}
-	gvk := schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "Deployment"}
-	ownerRef := *metav1.NewControllerRef(persisted, gvk)
+	ownerRef := *metav1.NewControllerRef(searchDeployment, apiserver.DeploymentGVK)
 	if err := pdb.EnsurePodDisruptionBudget(client, util.KarmadaSearchName(name), namespace, cfg.CommonSettings.PodDisruptionBudgetConfig, searchDeployment.Spec.Template.Labels, []metav1.OwnerReference{ownerRef}); err != nil {
 		return fmt.Errorf("failed to ensure PDB for search component %s, err: %w", util.KarmadaSearchName(name), err)
 	}

operator/pkg/controlplane/webhook/webhook.go

@@ -17,18 +17,17 @@ limitations under the License.
 package webhook
 
 import (
-	"context"
 	"fmt"
 
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	kuberuntime "k8s.io/apimachinery/pkg/runtime"
-	"k8s.io/apimachinery/pkg/runtime/schema"
 	clientset "k8s.io/client-go/kubernetes"
 	clientsetscheme "k8s.io/client-go/kubernetes/scheme"
 
 	operatorv1alpha1 "github.com/karmada-io/karmada/operator/pkg/apis/operator/v1alpha1"
+	"github.com/karmada-io/karmada/operator/pkg/controlplane/apiserver"
 	"github.com/karmada-io/karmada/operator/pkg/controlplane/pdb"
 	"github.com/karmada-io/karmada/operator/pkg/util"
 	"github.com/karmada-io/karmada/operator/pkg/util/apiclient"
@@ -73,17 +72,11 @@ func installKarmadaWebhook(client clientset.Interface, cfg *operatorv1alpha1.Kar
 		WithPriorityClassName(cfg.CommonSettings.PriorityClassName).
 		WithExtraArgs(cfg.ExtraArgs).WithFeatureGates(featureGates).WithResources(cfg.Resources).ForDeployment(webhookDeployment)
 
-	if err := apiclient.CreateOrUpdateDeployment(client, webhookDeployment); err != nil {
+	if webhookDeployment, err = apiclient.CreateOrUpdateDeployment(client, webhookDeployment); err != nil {
 		return fmt.Errorf("error when creating deployment for %s, err: %w", webhookDeployment.Name, err)
 	}
 
-	// Fetch persisted Deployment to get real UID
-	persisted, err := client.AppsV1().Deployments(namespace).Get(context.TODO(), webhookDeployment.GetName(), metav1.GetOptions{})
-	if err != nil {
-		return fmt.Errorf("failed to fetch Deployment %s/%s for PDB owner, err: %w", namespace, webhookDeployment.GetName(), err)
-	}
-	gvk := schema.GroupVersionKind{Group: "apps", Version: "v1", Kind: "Deployment"}
-	ownerRef := *metav1.NewControllerRef(persisted, gvk)
+	ownerRef := *metav1.NewControllerRef(webhookDeployment, apiserver.DeploymentGVK)
 	if err := pdb.EnsurePodDisruptionBudget(client, util.KarmadaWebhookName(name), namespace, cfg.CommonSettings.PodDisruptionBudgetConfig, webhookDeployment.Spec.Template.Labels, []metav1.OwnerReference{ownerRef}); err != nil {
 		return fmt.Errorf("failed to ensure PDB for webhook component %s, err: %w", util.KarmadaWebhookName(name), err)
 	}

operator/pkg/tasks/deinit/component_test.go

@@ -109,7 +109,7 @@ func TestRunRemoveComponentSubTask(t *testing.T) {
 
 				// Create Karmada Controller Manager deployment with given labels.
 				d.Labels = constants.KarmadaOperatorLabel
-				if err := apiclient.CreateOrUpdateDeployment(client, d); err != nil {
+				if _, err := apiclient.CreateOrUpdateDeployment(client, d); err != nil {
 					return fmt.Errorf("failed to create deployment, got: %v", err)
 				}
 
@@ -201,7 +201,7 @@ func TestRunRemoveEtcd(t *testing.T) {
 
 				// Create Etcd statefulset with given labels.
 				staetfulset.Labels = constants.KarmadaOperatorLabel
-				if err := apiclient.CreateOrUpdateStatefulSet(client, staetfulset); err != nil {
+				if _, err := apiclient.CreateOrUpdateStatefulSet(client, staetfulset); err != nil {
 					return fmt.Errorf("failed to create statefulset, got: %v", err)
 				}