Skip to content

Add flag --force to implement force deletion #7085

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
FAUST-BENCHOU wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add flag --force to implement force deletion #7085

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions pkg/karmadactl/unregister/unregister.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ var (

# Unregister cluster from karmada control plane, manually specify the location of the karmada config
%[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
Copy link

@gemini-code-assist gemini-code-assist bot Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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

`)
)

Expand Down Expand Up @@ -128,6 +131,9 @@ type CommandUnregisterOption struct {
// DryRun tells if run the command in dry-run mode, without making any server requests.
DryRun bool

// Force tells if force deletion should be used when deleting the cluster object.
Force bool

// ControlPlaneClient control plane client set
ControlPlaneClient karmadaclientset.Interface

Expand All @@ -153,6 +159,7 @@ func (j *CommandUnregisterOption) AddFlags(flags *pflag.FlagSet) {
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.")
}

// Complete ensures that options are valid and marshals them if necessary.
Expand Down Expand Up @@ -339,8 +346,7 @@ func (j *CommandUnregisterOption) RunUnregisterCluster() error {
j.Wait = j.Wait - time.Since(start)

// 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 {
klog.Errorf("Failed to delete cluster object. cluster name: %s, error: %v", j.ClusterName, err)
return err
}
Expand Down