feat: create kubectl-fleet plugin

Signed-off-by: Wantong Jiang <[email protected]>

Author: jwtty

CLAUDE.md

@@ -154,4 +154,8 @@ All controllers follow standard Kubernetes controller patterns:
 - Controllers should be thoroughly tested with integration tests
 - New scheduler plugins should implement both Filter and Score interfaces
 - Use existing patterns from similar controllers when adding new functionality
-- Property providers should implement the `PropertyProvider` interface
+- Property providers should implement the `PropertyProvider` interface
+
+## Coding Style
+- When writing comments, capitalize the first character (unless it starts with the function name) and end with a period
+_ When writing tests, use keyword `want` instead of `expected`

hack/Azure/property-based-scheduling.md

@@ -103,7 +103,7 @@ To set up Fleet using the clusters you just created, you will need to install Fl
 First, clone the Fleet source code repository, which contains the Helm charts used for Fleet agent installation:
 
 ```sh
-git clone https://github.com/Azure/fleet.git
+git clone https://github.com/kubefleet-dev/kubefleet.git
 cd fleet
 git checkout demo
 ```
@@ -407,7 +407,7 @@ spec:
 EOF
 ```
 
-The CRP API enables great flexibility; you can set up different requirements/preferences in combination, such as finding all clusters with at least 5 nodes and 10 available CPU cores, or 4 of all the clusters with the cheapest memory cost and the most amount of available memory. [Read Fleet's API definition to learn more](https://github.com/Azure/fleet/blob/main/apis/placement/v1beta1/clusterresourceplacement_types.go).
+The CRP API enables great flexibility; you can set up different requirements/preferences in combination, such as finding all clusters with at least 5 nodes and 10 available CPU cores, or 4 of all the clusters with the cheapest memory cost and the most amount of available memory. [Read Fleet's API definition to learn more](https://github.com/kubefleet-dev/kubefleet/blob/main/apis/placement/v1beta1/clusterresourceplacement_types.go).
 
 ## Clean things up
 
@@ -421,9 +421,9 @@ All the AKS clusters in the resource group will be removed.
 
 ## What's next
 
-Congrats! We hope that property-based scheduling (preview) has improved your overall Fleet experience. If you have any questions, feedback, or concerns, please raise [a GitHub issue](https://github.com/Azure/fleet/issues).
+Congrats! We hope that property-based scheduling (preview) has improved your overall Fleet experience. If you have any questions, feedback, or concerns, please raise [a GitHub issue](https://github.com/kubefleet-dev/kubefleet/issues).
 
 Aside from property-based scheduling, Fleet offers many other scheduling features that are useful in a
-multi-cluster environment; check out the [How-to Guide: Using the Fleet `ClusterResourcePlacement` API](https://github.com/Azure/fleet/tree/main/docs/howtos/crp.md) for more information.
+multi-cluster environment; check out the [How-to Guide: Using the Fleet `ClusterResourcePlacement` API](https://kubefleet.dev/docs/how-tos/crp/) for more information.
 
-You can also review Fleet's [source code](https://github.com/Azure/fleet) or review its [documentation](https://github.com/Azure/fleet/tree/main/docs) on GitHub.
+You can also review Fleet's [source code](https://github.com/kubefleet-dev/kubefleet) or review its [documentation](https://kubefleet.dev/docs/) on GitHub.

test/e2e/drain_tool_test.go

@@ -359,7 +359,7 @@ var _ = Describe("Drain is allowed on one cluster, blocked on others - ClusterRe
 
 func runDrainClusterBinary(hubClusterName, memberClusterName string) {
 	By(fmt.Sprintf("draining cluster %s", memberClusterName))
-	cmd := exec.Command(drainBinaryPath,
+	cmd := exec.Command(fleetBinaryPath, "draincluster",
 		"--hubClusterContext", hubClusterName,
 		"--clusterName", memberClusterName)
 	_, err := cmd.CombinedOutput()
@@ -368,7 +368,7 @@ func runDrainClusterBinary(hubClusterName, memberClusterName string) {
 
 func runUncordonClusterBinary(hubClusterName, memberClusterName string) {
 	By(fmt.Sprintf("uncordoning cluster %s", memberClusterName))
-	cmd := exec.Command(uncordonBinaryPath,
+	cmd := exec.Command(fleetBinaryPath, "uncordoncluster",
 		"--hubClusterContext", hubClusterName,
 		"--clusterName", memberClusterName)
 	_, err := cmd.CombinedOutput()

test/e2e/setup.sh

@@ -215,10 +215,6 @@ done
 # Create tools directory if it doesn't exist
 mkdir -p ../../hack/tools/bin
 
-# Build drain binary
-echo "Building drain binary..."
-go build -o ../../hack/tools/bin/kubectl-draincluster ../../tools/draincluster
-
-# Build uncordon binary
-echo "Building uncordon binary..."
-go build -o ../../hack/tools/bin/kubectl-uncordoncluster ../../tools/uncordoncluster
+# Build fleet plugin binary
+echo "Building fleet kubectl-plugin binary..."
+go build -o ../../hack/tools/bin/kubectl-fleet ../../tools/fleet

test/e2e/setup_test.go

@@ -173,8 +173,7 @@ var (
 )
 
 var (
-	drainBinaryPath    = filepath.Join("../../", "hack", "tools", "bin", "kubectl-draincluster")
-	uncordonBinaryPath = filepath.Join("../../", "hack", "tools", "bin", "kubectl-uncordoncluster")
+	fleetBinaryPath = filepath.Join("../../", "hack", "tools", "bin", "kubectl-fleet")
 )
 
 var (
@@ -376,11 +375,9 @@ func beforeSuiteForAllProcesses() {
 			allMemberClusterNames = append(allMemberClusterNames, allMemberClusters[i].ClusterName)
 		}
 
-		// Check if drain cluster and uncordon cluster binaries exist.
-		_, err := os.Stat(drainBinaryPath)
-		Expect(os.IsNotExist(err)).To(BeFalse(), fmt.Sprintf("drain binary not found at %s", drainBinaryPath))
-		_, err = os.Stat(uncordonBinaryPath)
-		Expect(os.IsNotExist(err)).To(BeFalse(), fmt.Sprintf("uncordon binary not found at %s", uncordonBinaryPath))
+		// Check if kubectl-fleet binary exists.
+		_, err := os.Stat(fleetBinaryPath)
+		Expect(os.IsNotExist(err)).To(BeFalse(), fmt.Sprintf("kubectl-fleet binary not found at %s", fleetBinaryPath))
 	})
 }
 

test/e2e/updaterun_test.go

@@ -18,6 +18,7 @@ package e2e
 
 import (
 	"fmt"
+	"os/exec"
 	"time"
 
 	. "github.com/onsi/ginkgo/v2"
@@ -1033,6 +1034,127 @@ var _ = Describe("test CRP rollout with staged update run", func() {
 		})
 	})
 
+	Context("Test kubectl-fleet approve plugin with cluster approval requests", Ordered, func() {
+		var strategy *placementv1beta1.ClusterStagedUpdateStrategy
+		updateRunName := fmt.Sprintf(updateRunNameWithSubIndexTemplate, GinkgoParallelProcess(), 0)
+
+		BeforeAll(func() {
+			// Create a test namespace and a configMap inside it on the hub cluster.
+			createWorkResources()
+
+			// Create the CRP with external rollout strategy.
+			crp := &placementv1beta1.ClusterResourcePlacement{
+				ObjectMeta: metav1.ObjectMeta{
+					Name: crpName,
+					// Add a custom finalizer; this would allow us to better observe
+					// the behavior of the controllers.
+					Finalizers: []string{customDeletionBlockerFinalizer},
+				},
+				Spec: placementv1beta1.PlacementSpec{
+					ResourceSelectors: workResourceSelector(),
+					Strategy: placementv1beta1.RolloutStrategy{
+						Type: placementv1beta1.ExternalRolloutStrategyType,
+					},
+				},
+			}
+			Expect(hubClient.Create(ctx, crp)).To(Succeed(), "Failed to create CRP")
+
+			// Create the clusterStagedUpdateStrategy.
+			strategy = createStagedUpdateStrategySucceed(strategyName)
+		})
+
+		AfterAll(func() {
+			// Remove the custom deletion blocker finalizer from the CRP.
+			ensureCRPAndRelatedResourcesDeleted(crpName, allMemberClusters)
+
+			// Delete the clusterStagedUpdateRun.
+			ensureUpdateRunDeletion(updateRunName)
+
+			// Delete the clusterStagedUpdateStrategy.
+			ensureUpdateRunStrategyDeletion(strategyName)
+		})
+
+		It("Should create a staged update run and verify cluster approval request is created", func() {
+			validateLatestResourceSnapshot(crpName, resourceSnapshotIndex1st)
+			validateLatestPolicySnapshot(crpName, policySnapshotIndex1st, 3)
+			createStagedUpdateRunSucceed(updateRunName, crpName, resourceSnapshotIndex1st, strategyName)
+
+			// Verify that cluster approval request is created for canary stage.
+			Eventually(func() error {
+				appReqList := &placementv1beta1.ClusterApprovalRequestList{}
+				if err := hubClient.List(ctx, appReqList, client.MatchingLabels{
+					placementv1beta1.TargetUpdatingStageNameLabel: envCanary,
+					placementv1beta1.TargetUpdateRunLabel:         updateRunName,
+				}); err != nil {
+					return fmt.Errorf("failed to list approval requests: %w", err)
+				}
+
+				if len(appReqList.Items) != 1 {
+					return fmt.Errorf("want 1 approval request, got %d", len(appReqList.Items))
+				}
+				return nil
+			}, updateRunEventuallyDuration, eventuallyInterval).Should(Succeed(), "Failed to find cluster approval request")
+		})
+
+		It("Should approve cluster approval request using kubectl-fleet approve plugin", func() {
+			var approvalRequestName string
+
+			// Get the cluster approval request name.
+			Eventually(func() error {
+				appReqList := &placementv1beta1.ClusterApprovalRequestList{}
+				if err := hubClient.List(ctx, appReqList, client.MatchingLabels{
+					placementv1beta1.TargetUpdatingStageNameLabel: envCanary,
+					placementv1beta1.TargetUpdateRunLabel:         updateRunName,
+				}); err != nil {
+					return fmt.Errorf("failed to list approval requests: %w", err)
+				}
+
+				if len(appReqList.Items) != 1 {
+					return fmt.Errorf("want 1 approval request, got %d", len(appReqList.Items))
+				}
+
+				approvalRequestName = appReqList.Items[0].Name
+				return nil
+			}, eventuallyDuration, eventuallyInterval).Should(Succeed(), "Failed to get approval request name")
+
+			// Use kubectl-fleet approve plugin to approve the request
+			cmd := exec.Command(fleetBinaryPath, "approve", "clusterapprovalrequest",
+				"--hubClusterContext", "kind-hub",
+				"--name", approvalRequestName)
+			output, err := cmd.CombinedOutput()
+			Expect(err).ToNot(HaveOccurred(), "kubectl-fleet approve failed: %s", string(output))
+
+			// Verify the approval request is approved
+			Eventually(func() error {
+				var appReq placementv1beta1.ClusterApprovalRequest
+				if err := hubClient.Get(ctx, client.ObjectKey{Name: approvalRequestName}, &appReq); err != nil {
+					return fmt.Errorf("failed to get approval request: %w", err)
+				}
+
+				approvedCondition := meta.FindStatusCondition(appReq.Status.Conditions, string(placementv1beta1.ApprovalRequestConditionApproved))
+				if approvedCondition == nil {
+					return fmt.Errorf("approved condition not found")
+				}
+				if approvedCondition.Status != metav1.ConditionTrue {
+					return fmt.Errorf("approved condition status is %s, want True", approvedCondition.Status)
+				}
+				return nil
+			}, eventuallyDuration, eventuallyInterval).Should(Succeed(), "Failed to verify approval request is approved")
+		})
+
+		It("Should complete the staged update run after approval", func() {
+			updateRunSucceededActual := updateRunStatusSucceededActual(updateRunName, policySnapshotIndex1st, len(allMemberClusters), defaultApplyStrategy, &strategy.Spec, [][]string{{allMemberClusterNames[1]}, {allMemberClusterNames[0], allMemberClusterNames[2]}}, nil, nil, nil)
+			Eventually(updateRunSucceededActual, updateRunEventuallyDuration, eventuallyInterval).Should(Succeed(), "Failed to validate updateRun %s succeeded", updateRunName)
+			checkIfPlacedWorkResourcesOnMemberClustersInUpdateRun(allMemberClusters)
+		})
+
+		It("Should update crp status as completed", func() {
+			crpStatusUpdatedActual := crpStatusWithExternalStrategyActual(workResourceIdentifiers(), resourceSnapshotIndex1st, true, allMemberClusterNames,
+				[]string{resourceSnapshotIndex1st, resourceSnapshotIndex1st, resourceSnapshotIndex1st}, []bool{true, true, true}, nil, nil)
+			Eventually(crpStatusUpdatedActual, eventuallyDuration, eventuallyInterval).Should(Succeed(), "Failed to update CRP %s status as expected", crpName)
+		})
+	})
+
 	Context("Test CRP rollout strategy transition from external to rollingUpdate", Ordered, func() {
 		var strategy *placementv1beta1.ClusterStagedUpdateStrategy
 		updateRunName := fmt.Sprintf(updateRunNameWithSubIndexTemplate, GinkgoParallelProcess(), 0)