Add flag --force to implement force deletion by FAUST-BENCHOU · Pull Request #7085 · karmada-io/karmada

FAUST-BENCHOU · 2026-01-05T13:46:20Z

What type of PR is this?

What this PR does / why we need it:

need of "TODO:add flag --force to implement force deletion"

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

karmada-bot · 2026-01-05T13:46:23Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign chaunceyjiang for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

pkg/karmadactl/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

gemini-code-assist · 2026-01-05T13:46:33Z

Summary of Changes

Hello @FAUST-BENCHOU, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a previously identified need by implementing a --force flag for the karmadactl unregister command. This enhancement provides users with an option to forcefully remove cluster objects from the Karmada control plane, particularly useful in situations where standard deletion might hang due to finalizers. The change integrates this new functionality into the command's options and updates its usage documentation.

Highlights

New --force flag: Introduced a new --force flag for the karmadactl unregister command, allowing for force deletion of cluster objects.
Force Deletion Logic: The --force flag enables the unregister command to attempt force deletion by removing finalizers if the normal deletion process times out, though this may leave some resources behind.
Documentation Update: The help message for the unregister command has been updated to include an example demonstrating the use of the --force flag.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request correctly implements the --force flag for the unregister command, enabling force deletion of clusters. The implementation is straightforward and passes the flag to the underlying deletion logic. However, since this introduces a new CLI flag, it is a user-facing change and should have a release note. I've also included a minor suggestion to improve the command's example usage for better clarity and consistency.

gemini-code-assist · 2026-01-05T13:50:32Z

pkg/karmadactl/unregister/unregister.go

 		%[1]s unregister CLUSTER_NAME --karmada-config=<KARMADA_CONFIG> [--karmada-context=<KARMADA_CONTEXT>] --cluster-kubeconfig=<CLUSTER_KUBECONFIG> [--cluster-context=<CLUSTER_CONTEXT>]
+
+		# Force unregister cluster from karmada control plane
+		%[1]s unregister CLUSTER_NAME --cluster-kubeconfig=<CLUSTER_KUBECONFIG> --force


The new example for the --force flag is good, but it could be more comprehensive. To improve consistency with other examples and better illustrate its usage, consider including optional flags like [--cluster-context=<CLUSTER_CONTEXT>]. This shows users that --force can be combined with other existing options.

Suggested change

%[1]s unregister CLUSTER_NAME --cluster-kubeconfig=<CLUSTER_KUBECONFIG> --force

%[1]s unregister CLUSTER_NAME --cluster-kubeconfig=<CLUSTER_KUBECONFIG> [--cluster-context=<CLUSTER_CONTEXT>] --force

codecov-commenter · 2026-01-05T14:03:29Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 42.04%. Comparing base (050a7d9) to head (e308b62).

Files with missing lines	Patch %	Lines
pkg/karmadactl/unregister/unregister.go	0.00%	1 Missing and 1 partial ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #7085   +/-   ##
=======================================
  Coverage   42.03%   42.04%           
=======================================
  Files         874      874           
  Lines       53454    53455    +1     
=======================================
+ Hits        22471    22474    +3     
+ Misses      29294    29293    -1     
+ Partials     1689     1688    -1

Flag	Coverage Δ
unittests	`42.04% <0.00%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

XiShanYongYe-Chang

Thanks @FAUST-BENCHOU

XiShanYongYe-Chang · 2026-02-12T02:10:53Z

pkg/karmadactl/unregister/unregister.go

 	flags.StringVar(&j.ClusterNamespace, "cluster-namespace", options.DefaultKarmadaClusterNamespace, "Namespace in the control plane where member cluster secrets are stored.")
 	flags.DurationVar(&j.Wait, "wait", 60*time.Second, "wait for the unjoin command execution process(default 60s), if there is no success after this time, timeout will be returned.")
 	flags.BoolVar(&j.DryRun, "dry-run", false, "Run the command in dry-run mode, without making any server requests.")
+	flags.BoolVar(&j.Force, "force", false, "When set, the unregister command will attempt to force delete the cluster object by removing finalizers if the normal deletion times out. This may leave some resources in the member cluster.")


Is the meaning of this parameter the same as that of the force parameter in the unjoin command, except for the difference in subcommands? If they are the same, the parameter description can be directly reused.

XiShanYongYe-Chang · 2026-02-12T02:13:25Z

pkg/karmadactl/unregister/unregister.go

 		%[1]s unregister CLUSTER_NAME --karmada-config=<KARMADA_CONFIG> [--karmada-context=<KARMADA_CONTEXT>] --cluster-kubeconfig=<CLUSTER_KUBECONFIG> [--cluster-context=<CLUSTER_CONTEXT>]
+
+		# Force unregister cluster from karmada control plane
+		%[1]s unregister CLUSTER_NAME --cluster-kubeconfig=<CLUSTER_KUBECONFIG> --force


Signed-off-by: zhoujinyu <2319109590@qq.com>

Copilot

Pull request overview

Adds a --force option to karmadactl unregister to support forced deletion behavior when unregistering pull-mode clusters.

Changes:

Extend unregister CLI examples to document --force usage.
Add Force option to CommandUnregisterOption and expose it as a --force flag.
Wire --force into cmdutil.DeleteClusterObject(...) during cluster deletion.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-16T06:24:41Z

pkg/karmadactl/unregister/unregister.go

 	flags.StringVar(&j.ClusterNamespace, "cluster-namespace", options.DefaultKarmadaClusterNamespace, "Namespace in the control plane where member cluster secrets are stored.")
 	flags.DurationVar(&j.Wait, "wait", 60*time.Second, "wait for the unjoin command execution process(default 60s), if there is no success after this time, timeout will be returned.")
 	flags.BoolVar(&j.DryRun, "dry-run", false, "Run the command in dry-run mode, without making any server requests.")
+	flags.BoolVar(&j.Force, "force", false, "When set, the unregister command will attempt to clean up resources in the member cluster before deleting the Cluster object. If the cleanup fails within the timeout period, the Cluster object will still be deleted, potentially leaving some resources behind in the member cluster.")


The --force flag help text doesn’t match what the code does. In this command, the Cluster is deleted first, and cmdutil.DeleteClusterObject(..., force) only triggers forced deletion by removing finalizers if the Cluster isn’t deleted within --wait; it does not “clean up resources in the member cluster before deleting the Cluster object”. Please reword the flag description (and/or adjust the implementation) so the user-facing behavior is accurately described, and clarify what parts are best-effort in force mode.

Suggested change

flags.BoolVar(&j.Force, "force", false, "When set, the unregister command will attempt to clean up resources in the member cluster before deleting the Cluster object. If the cleanup fails within the timeout period, the Cluster object will still be deleted, potentially leaving some resources behind in the member cluster.")

flags.BoolVar(&j.Force, "force", false, "When set, if the Cluster object is not deleted successfully within the --wait duration, the command will attempt a forced deletion by removing finalizers from the Cluster. This is a best-effort operation and may leave some resources behind in the member cluster.")

Copilot · 2026-02-16T06:24:42Z

pkg/karmadactl/unregister/unregister.go

 	flags.StringVar(&j.ClusterNamespace, "cluster-namespace", options.DefaultKarmadaClusterNamespace, "Namespace in the control plane where member cluster secrets are stored.")
 	flags.DurationVar(&j.Wait, "wait", 60*time.Second, "wait for the unjoin command execution process(default 60s), if there is no success after this time, timeout will be returned.")
 	flags.BoolVar(&j.DryRun, "dry-run", false, "Run the command in dry-run mode, without making any server requests.")
+	flags.BoolVar(&j.Force, "force", false, "When set, the unregister command will attempt to clean up resources in the member cluster before deleting the Cluster object. If the cleanup fails within the timeout period, the Cluster object will still be deleted, potentially leaving some resources behind in the member cluster.")


With --force, this command still returns an error if cleanupMemberClusterResources() fails (it is unconditional later in RunUnregisterCluster). That conflicts with the current flag description’s promise that the Cluster object “will still be deleted” even if cleanup fails. Either make member-cluster cleanup best-effort when --force is set (similar to unjoin’s force behavior), or adjust the flag text to avoid implying cleanup failures won’t fail the command.

Suggested change

flags.BoolVar(&j.Force, "force", false, "When set, the unregister command will attempt to clean up resources in the member cluster before deleting the Cluster object. If the cleanup fails within the timeout period, the Cluster object will still be deleted, potentially leaving some resources behind in the member cluster.")

flags.BoolVar(&j.Force, "force", false, "When set, the unregister command will attempt to clean up resources in the member cluster before deleting the Cluster object. Cleanup and deletion are performed on a best-effort basis and may still fail, potentially leaving resources behind in the member cluster or the Cluster object in the control plane.")

Copilot · 2026-02-16T06:24:42Z

pkg/karmadactl/unregister/unregister.go

 	flags.StringVar(&j.ClusterNamespace, "cluster-namespace", options.DefaultKarmadaClusterNamespace, "Namespace in the control plane where member cluster secrets are stored.")
 	flags.DurationVar(&j.Wait, "wait", 60*time.Second, "wait for the unjoin command execution process(default 60s), if there is no success after this time, timeout will be returned.")
 	flags.BoolVar(&j.DryRun, "dry-run", false, "Run the command in dry-run mode, without making any server requests.")
+	flags.BoolVar(&j.Force, "force", false, "When set, the unregister command will attempt to clean up resources in the member cluster before deleting the Cluster object. If the cleanup fails within the timeout period, the Cluster object will still be deleted, potentially leaving some resources behind in the member cluster.")


This PR introduces a new user-facing CLI flag (--force) but the PR description’s release-note block is NONE. Please add an appropriate release note entry describing the new flag/behavior so users learn about it from the changelog process.

Copilot · 2026-02-16T06:24:42Z

pkg/karmadactl/unregister/unregister.go

 	// 2. delete the cluster object from the Karmada control plane
-	//TODO: add flag --force to implement force deletion.
-	if err = cmdutil.DeleteClusterObject(j.ControlPlaneKubeClient, j.ControlPlaneClient, j.ClusterName, j.Wait, j.DryRun, false); err != nil {
+	if err = cmdutil.DeleteClusterObject(j.ControlPlaneKubeClient, j.ControlPlaneClient, j.ClusterName, j.Wait, j.DryRun, j.Force); err != nil {


There are existing unit tests for unregister (see unregister_test.go), but none cover the new --force path. Please add a test that sets Force=true and verifies the flag is wired through to cmdutil.DeleteClusterObject, ideally simulating a deletion timeout (e.g., via a fake client reactor) to exercise the forced-finalizer-removal behavior.

FAUST-BENCHOU · 2026-02-16T06:25:14Z

@XiShanYongYe-Chang Thanks for review!updated.

karmada-bot requested review from chaunceyjiang and zhzhuang-zju January 5, 2026 13:46

karmada-bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 5, 2026

gemini-code-assist bot reviewed Jan 5, 2026

View reviewed changes

XiShanYongYe-Chang reviewed Feb 12, 2026

View reviewed changes

add flag --force to implement force deletion

e308b62

Signed-off-by: zhoujinyu <2319109590@qq.com>

FAUST-BENCHOU force-pushed the fix/force-flag branch from f80f348 to e308b62 Compare February 16, 2026 06:21

Copilot AI review requested due to automatic review settings February 16, 2026 06:21

Copilot started reviewing on behalf of FAUST-BENCHOU February 16, 2026 06:21 View session

Copilot AI reviewed Feb 16, 2026

View reviewed changes

	%[1]s unregister CLUSTER_NAME --cluster-kubeconfig=<CLUSTER_KUBECONFIG> --force
	%[1]s unregister CLUSTER_NAME --cluster-kubeconfig=<CLUSTER_KUBECONFIG> [--cluster-context=<CLUSTER_CONTEXT>] --force

	flags.BoolVar(&j.Force, "force", false, "When set, the unregister command will attempt to clean up resources in the member cluster before deleting the Cluster object. If the cleanup fails within the timeout period, the Cluster object will still be deleted, potentially leaving some resources behind in the member cluster.")
	flags.BoolVar(&j.Force, "force", false, "When set, if the Cluster object is not deleted successfully within the --wait duration, the command will attempt a forced deletion by removing finalizers from the Cluster. This is a best-effort operation and may leave some resources behind in the member cluster.")

Comments

Conversation

FAUST-BENCHOU commented Jan 5, 2026

Uh oh!

karmada-bot commented Jan 5, 2026

Uh oh!

gemini-code-assist bot commented Jan 5, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

XiShanYongYe-Chang Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

FAUST-BENCHOU Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Jan 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

XiShanYongYe-Chang left a comment

Choose a reason for hiding this comment

Uh oh!

XiShanYongYe-Chang Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

FAUST-BENCHOU Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

XiShanYongYe-Chang Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

FAUST-BENCHOU commented Feb 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-commenter commented Jan 5, 2026 •

edited

Loading