karmada/docs/userguide/cluster-registration.md

Table of Contents generated with DocToc

• Cluster Registration
  • Overview of cluster mode
    • Push mode
    • Pull mode
  • Register cluster with 'Push' mode
    • Register cluster by CLI
    • Check cluster status
    • Unregister cluster by CLI
  • Register cluster with 'Pull' mode
    • Register cluster
    • Check cluster status
    • Unregister cluster

Cluster Registration

Overview of cluster mode

Karmada supports both Push and Pull modes to manage the member clusters. The main difference between Push and Pull modes is the way access to member clusters when deploying manifests.

Push mode

Karmada control plane will access member cluster's kube-apiserver directly to get cluster status and deploy manifests.

Pull mode

Karmada control plane will not access member cluster but delegate it to an extra component named karmada-agent.

Each karmada-agent serves for a cluster and take responsibility for:

• Register cluster to Karmada(creates the Cluster object)
• Maintains cluster status and reports to Karmada(updates the status of Cluster object)
• Watch manifests from Karmada execution space(namespace, karmada-es-<cluster name>) and deploy to the cluster which serves for.

Register cluster with 'Push' mode

You can use the kubectl-karmada CLI to join(register) and unjoin(unregister) clusters.

Register cluster by CLI

Join cluster with name member1 to Karmada by using the following command.

kubectl karmada join member1 --kubeconfig=<karmada kubeconfig> --cluster-kubeconfig=<member1 kubeconfig>

Repeat this step to join any additional clusters.

The --kubeconfig specifies the Karmada's kubeconfig file and the --cluster-kubeconfig specifies the registering cluster's kubeconfig file.

Maybe you have to specify the context if there are more than one contexts in kubeconfig file:

kubectl karmada join member1 --kubeconfig=<karmada kubeconfig> --karmada-context=karmada \
--cluster-kubeconfig=<member1 kubeconfig> --cluster-context=member1

Check cluster status

Check the status of the joined clusters by using the following command.

kubectl get clusters

NAME      VERSION   MODE   READY   AGE
member1   v1.20.7   Push   True    66s

Unregister cluster by CLI

You can unjoin clusters by using the following command.

kubectl karmada unjoin member1 --kubeconfig=<karmada kubeconfig> --cluster-kubeconfig=<member1 kubeconfig>

During unjoin process, the resources propagated to member1 by Karmada will be cleaned up. And the --cluster-kubeconfig is used to clean up the secret created at the join phase.

Repeat this step to unjoin any additional clusters.

Register cluster with 'Pull' mode

Register cluster

After karmada-agent be deployed, it will register cluster automatically at the start-up phase.

Check cluster status

Check the status of the registered clusters by using the same command above.

kubectl get clusters
NAME      VERSION   MODE   READY   AGE
member3   v1.20.7   Pull   True    66s

Unregister cluster

Undeploy the karmada-agent and then remove the cluster manually from Karmada.

kubectl delete cluster member3