karmada/pkg/karmadactl/cordon.go

package karmadactl

import (
	"context"
	"encoding/json"
	"errors"
	"io"

	"github.com/spf13/cobra"
	"github.com/spf13/pflag"
	corev1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/types"
	utilerrors "k8s.io/apimachinery/pkg/util/errors"
	"k8s.io/apimachinery/pkg/util/strategicpatch"
	"k8s.io/klog/v2"

	clusterv1alpha1 "github.com/karmada-io/karmada/pkg/apis/cluster/v1alpha1"
	karmadaclientset "github.com/karmada-io/karmada/pkg/generated/clientset/versioned"
)

var (
	cordonLong = `Mark cluster as unschedulable.`

	cordonExample = `
# Mark cluster "foo" as unschedulable.
karmadactl cordon foo
`

	uncordonLong = `Mark cluster as schedulable.`

	uncordonExample = `
# Mark cluster "foo" as schedulable.
karmadactl uncordon foo
`
)

const (
	desiredCordon = iota
	desiredUnCordon
)

// NewCmdCordon defines the `cordon` command that mark cluster as unschedulable.
func NewCmdCordon(cmdOut io.Writer, karmadaConfig KarmadaConfig) *cobra.Command {
	opts := CommandCordonOption{}
	cmd := &cobra.Command{
		Use:     "cordon CLUSTER",
		Short:   "Mark cluster as unschedulable",
		Long:    cordonLong,
		Example: cordonExample,
		Run: func(cmd *cobra.Command, args []string) {
			err := opts.Complete(args)
			if err != nil {
				klog.Errorf("Error: %v", err)
				return
			}

			if errs := opts.Validate(); len(errs) != 0 {
				klog.Error(utilerrors.NewAggregate(errs).Error())
				return
			}

			err = RunCordonOrUncordon(cmdOut, desiredCordon, karmadaConfig, opts)
			if err != nil {
				klog.Errorf("Error: %v", err)
				return
			}
		},
	}

	return cmd
}

// NewCmdUncordon defines the `cordon` command that mark cluster as schedulable.
func NewCmdUncordon(cmdOut io.Writer, karmadaConfig KarmadaConfig) *cobra.Command {
	opts := CommandCordonOption{}
	cmd := &cobra.Command{
		Use:     "uncordon CLUSTER",
		Short:   "Mark cluster as schedulable",
		Long:    uncordonLong,
		Example: uncordonExample,
		Run: func(cmd *cobra.Command, args []string) {
			// Set default values
			err := opts.Complete(args)
			if err != nil {
				klog.Errorf("Error: %v", err)
				return
			}

			if errs := opts.Validate(); len(errs) != 0 {
				klog.Error(utilerrors.NewAggregate(errs).Error())
				return
			}

			err = RunCordonOrUncordon(cmdOut, desiredUnCordon, karmadaConfig, opts)
			if err != nil {
				klog.Errorf("Error: %v", err)
				return
			}
		},
	}

	return cmd
}

// CommandCordonOption holds all command options for cordon and uncordon
type CommandCordonOption struct {
	// KubeConfig holds the control plane KUBECONFIG file path.
	KubeConfig string

	// ClusterContext is the name of the cluster context in control plane KUBECONFIG file.
	// Default value is the current-context.
	KarmadaContext string

	// DryRun tells if run the command in dry-run mode, without making any server requests.
	DryRun bool

	// ClusterName is the cluster's name that we are going to join with.
	ClusterName string
}

// Complete ensures that options are valid and marshals them if necessary.
func (o *CommandCordonOption) Complete(args []string) error {
	// Get cluster name from the command args.
	if len(args) == 0 {
		return errors.New("cluster name is required")
	}
	o.ClusterName = args[0]
	return nil
}

// Validate checks option and return a slice of found errs.
func (o *CommandCordonOption) Validate() []error {
	var errs []error
	return errs
}

// AddFlags adds flags to the specified FlagSet.
func (o *CommandCordonOption) AddFlags(flags *pflag.FlagSet) {
	flags.StringVar(&o.KubeConfig, "kubeconfig", "", "Path to the control plane kubeconfig file.")
	flags.StringVar(&o.KarmadaContext, "karmada-context", "", "Name of the cluster context in control plane kubeconfig file.")
	flags.BoolVar(&o.DryRun, "dry-run", false, "Run the command in dry-run mode, without making any server requests.")
}

// CordonHelper wraps functionality to cordon/uncordon cluster
type CordonHelper struct {
	cluster *clusterv1alpha1.Cluster
	desired int
}

// NewCordonHelper returns a new CordonHelper that help execute
// the cordon and uncordon commands
func NewCordonHelper(cluster *clusterv1alpha1.Cluster) *CordonHelper {
	return &CordonHelper{
		cluster: cluster,
	}
}

// UpdateIfRequired returns true if unscheduler taint isn't already set,
// or false when no change is needed
func (c *CordonHelper) UpdateIfRequired(desired int) bool {
	c.desired = desired

	if desired == desiredCordon && !c.hasUnschedulerTaint() {
		return true
	}

	if desired == desiredUnCordon && c.hasUnschedulerTaint() {
		return true
	}

	return false
}

func (c *CordonHelper) hasUnschedulerTaint() bool {
	unschedulerTaint := corev1.Taint{
		Key:    clusterv1alpha1.TaintClusterUnscheduler,
		Effect: corev1.TaintEffectNoSchedule,
	}

	for _, taint := range c.cluster.Spec.Taints {
		if taint.MatchTaint(&unschedulerTaint) {
			return true
		}
	}

	return false
}

// PatchOrReplace uses given karmada clientset to update the cluster unschedulable scheduler, either by patching or
// updating the given cluster object; it may return error if the object cannot be encoded as
// JSON, or if either patch or update calls fail; it will also return a second error
// whenever creating a patch has failed
func (c *CordonHelper) PatchOrReplace(controlPlaneClient *karmadaclientset.Clientset) (error, error) {
	client := controlPlaneClient.ClusterV1alpha1().Clusters()
	oldData, err := json.Marshal(c.cluster)
	if err != nil {
		return err, nil
	}

	unschedulerTaint := corev1.Taint{
		Key:    clusterv1alpha1.TaintClusterUnscheduler,
		Effect: corev1.TaintEffectNoSchedule,
	}

	if c.desired == desiredCordon {
		c.cluster.Spec.Taints = append(c.cluster.Spec.Taints, unschedulerTaint)
	}

	if c.desired == desiredUnCordon {
		for i, n := 0, len(c.cluster.Spec.Taints); i < n; i++ {
			if c.cluster.Spec.Taints[i].MatchTaint(&unschedulerTaint) {
				c.cluster.Spec.Taints[i] = c.cluster.Spec.Taints[n-1]
				c.cluster.Spec.Taints = c.cluster.Spec.Taints[:n-1]
				break
			}
		}
	}

	newData, err := json.Marshal(c.cluster)
	if err != nil {
		return err, nil
	}

	patchBytes, patchErr := strategicpatch.CreateTwoWayMergePatch(oldData, newData, c.cluster)
	if patchErr == nil {
		_, err = client.Patch(context.TODO(), c.cluster.Name, types.MergePatchType, patchBytes, metav1.PatchOptions{})
	} else {
		_, err = client.Update(context.TODO(), c.cluster, metav1.UpdateOptions{})
	}
	return err, patchErr
}

// RunCordonOrUncordon exec marks the cluster unschedulable or schedulable according to desired.
// if true cordon cluster otherwise uncordon cluster.
func RunCordonOrUncordon(_ io.Writer, desired int, karmadaConfig KarmadaConfig, opts CommandCordonOption) error {
	cordonOrUncordon := "cordon"
	if desired == desiredUnCordon {
		cordonOrUncordon = "un" + cordonOrUncordon
	}

	// Get control plane kube-apiserver client
	controlPlaneRestConfig, err := karmadaConfig.GetRestConfig(opts.KarmadaContext, opts.KubeConfig)
	if err != nil {
		klog.Errorf("Failed to get control plane rest config. context: %s, kube-config: %s, error: %v",
			opts.KarmadaContext, opts.KubeConfig, err)
		return err
	}

	controlPlaneKarmadaClient := karmadaclientset.NewForConfigOrDie(controlPlaneRestConfig)

	cluster, err := controlPlaneKarmadaClient.ClusterV1alpha1().Clusters().Get(context.TODO(), opts.ClusterName, metav1.GetOptions{})
	if err != nil {
		klog.Errorf("Failed to %s cluster. error: %v", cordonOrUncordon, err)
	}

	cordonHelper := NewCordonHelper(cluster)
	if !cordonHelper.UpdateIfRequired(desired) {
		klog.Infof("%s cluster %s", cluster.Name, alreadyStr(desired))
		return nil
	}

	if !opts.DryRun {
		err, patchErr := cordonHelper.PatchOrReplace(controlPlaneKarmadaClient)
		if patchErr != nil {
			klog.Errorf("Failed to %s cluster. error: %v", cordonOrUncordon, patchErr)
			return patchErr
		}
		if err != nil {
			klog.Errorf("Failed to %s cluster. error: %v", cordonOrUncordon, err)
			return err
		}
	}

	klog.Infof("%s cluster %sed", cluster.Name, cordonOrUncordon)
	return nil
}

func alreadyStr(desired int) string {
	if desired == desiredCordon {
		return "already cordoned"
	}
	return "already uncordoned"
}