Skip to content

3.2. Clusters (Cluster Management)

Overview

The Clusters page manages every member cluster registered with the MCM control plane. You can check a cluster's status, resource usage, and node information, and add a new cluster or edit or delete an existing one.

What it is for:

  • Registering and managing member clusters
  • Monitoring the status and resource usage of each cluster
  • Checking cluster node information
  • Jumping quickly to a cluster console

How the Screen Is Laid Out

The cluster management page comes in two forms, a grid view and a table view.

1. Grid View (Cards)

The default form, showing each cluster as a card.

The cluster grid view

The Elements at the Top of the Page

ElementDescription
View switch buttonsSwitch between grid view and table view
Refresh buttonRefreshes the cluster list
Add Cluster buttonOpens the dialog for registering a new cluster
Search boxSearches by cluster name

How a Cluster Card Is Laid Out

Each cluster card shows:

ElementDescription
Cluster NameThe name that identifies the registered cluster
Status badgeReady (green) / Not Ready (red)
Cluster Console buttonGoes to that cluster's management console
Sync ModeShows Push or Pull mode
Kubernetes VersionThe cluster's Kubernetes version
GPU badgeShows the GPU count when the cluster has GPU nodes
Node statusReady / total nodes
CPU UsageUsed / requested / allocatable cores (usage% / request%)
Memory UsageUsed / requested / allocatable GB (usage% / request%)
PodsCurrent pods + multi-cluster pods / maximum pods (usage%)
LabelsThe labels applied to the cluster (can be copied)
Edit buttonEdits the cluster settings

2. Table View

Shows the cluster list as a table so they can be compared at a glance.

The cluster table view

Table Columns

ColumnDescriptionSortable
Cluster NameThe name that identifies the cluster
StatusReady / Not Ready
Cluster ConsoleThe console shortcut button-
Sync ModePush / Pull mode
Kubernetes VersionThe Kubernetes version
NodesReady / total nodes
CPUUsed / requested / allocatable-
MemoryUsed / requested / allocatable-
PodsCurrent + Karmada / maximum-
GPUThe GPU count
ActionsThe view and edit buttons-

Table Features

  • Sorting: click a column header to sort ascending or descending
  • Filter: filter by condition with the filter button
  • Hide columns: choose which columns to show

Cluster Detail

Clicking a cluster card or a table row opens the detail panel.

Cluster detail

The Detail Panel Header

ElementDescription
Cluster NameThe name of the chosen cluster
Status badgeReady / Not Ready
Sync ModeShows Push or Pull
Cluster Console buttonGoes to that cluster's console

The Action Buttons

ButtonWhat it does
RefreshRefreshes the cluster information
EditOpens the YAML edit mode
Edit clusterOpens the cluster settings dialog
DeleteUnregisters the cluster

The Tabs

The Overview Tab

Shows the cluster's basic information and a resource summary.

Basic information:

ItemDescription
Cluster NameThe name of the registered cluster
StatusThe cluster's current status
Cluster ConsoleThe console URL and shortcut
Sync ModePush or Pull
Kubernetes VersionThe cluster's Kubernetes version
API EndpointThe cluster API server address
CreatedWhen the cluster was registered

Node summary:

  • The not-ready node count
  • The ready node count
  • The total node count

Resource summary:

  • CPU: used / requested / allocatable (usage% / request%)
  • Memory: used / requested / allocatable (usage% / request%)
  • Pods: current + Karmada pods / maximum (usage%)
  • GPU: the GPU count

The Labels Tab

Shows the list of Kubernetes labels applied to the cluster.

The Annotations Tab

Shows the list of annotations applied to the cluster.

The Taints Tab

Shows the taints configured on the cluster.

The Conditions Tab

Shows the cluster's status conditions.

The Nodes Tab

Shows the detail of every node in the cluster as a table.

The Nodes tab
ColumnDescription
NameThe node name
StatusReady / Not Ready
Rolesmaster, worker, etcd, control-plane and so on
TaintsThe number of taints set on the node
Internal IPThe node's internal IP address
CPUCPU usage (with a progress bar)
MemoryMemory usage (with a progress bar)
PodsCurrent / maximum pods
GPUGPU information (where present)
AgeThe time since the node was created

The Namespaces Tab

Shows the list of namespaces in the cluster.

The Events Tab

Shows the Kubernetes events related to the cluster.

Adding a Cluster

Registers a new member cluster with the MCM control plane.

The add cluster dialog

Required Fields

FieldDescription
Cluster NameA unique name identifying the cluster (lowercase letters, numbers, '-' or '.')
Sync ModeChoose Push or Pull
Authentication MethodKubeconfig or a ServiceAccount token
KubeconfigThe kubeconfig contents used to reach the cluster

Sync Modes

ModeDescription
PushMCM pushes resources to the member cluster directly (recommended)
PullThe member cluster's agent pulls resources from MCM

Authentication Methods

MethodDescription
KubeconfigUses the contents of the cluster's kubeconfig file
ServiceAccount TokenAuthenticates with a ServiceAccount token

Extra Options

OptionDescription
Skip TLS certificate verificationTick this when using a self-signed certificate
Advanced ConfigurationFurther cluster settings

Editing a Cluster

Changes the settings of a registered cluster.

Editing the YAML

Pressing the "Edit" button lets you edit the cluster resource's YAML directly.

The Edit Cluster Dialog

Pressing the "Edit cluster" button opens a dialog for changing the main settings:

  • The cluster console URL
  • Labels
  • Annotations
  • Taints

Deleting a Cluster

⚠️ Caution: deleting a cluster unregisters it from the MCM control plane. Workloads deployed on that cluster are handled according to the deletion policy.

  1. Choose the cluster to delete
  2. Press the "Delete" button in the detail panel
  3. Type the cluster name in the confirmation dialog
  4. Press the "Delete" button

Worked Examples

Scenario 1: Registering a New Cluster

  1. Press the "Add Cluster" button
  2. Enter the cluster name (production-cluster, for example)
  3. Choose the sync mode (Push is generally recommended)
  4. Paste in the kubeconfig contents
  5. Tick "Skip TLS certificate verification" if needed
  6. Press the "Confirm" button

Scenario 2: Checking Cluster Status

  1. Check the status badges in the cluster list
  2. Click the card of a not-ready cluster
  3. Check the detailed conditions on the Conditions tab
  4. Check the related events on the Events tab

Scenario 3: Diagnosing a Node Problem

  1. Check the "Not Ready Nodes" count on the cluster card
  2. Click the cluster to open the detail panel
  3. Click the Nodes tab
  4. Find the nodes that are not ready
  5. Check that node's CPU and memory usage and its taints

Scenario 4: Monitoring Resource Usage

  1. Check the CPU, memory, and pod usage of each cluster in the grid view
  2. Identify the clusters with high usage
  3. Consider growing the cluster or redistributing workloads if needed

The Sync Modes in Detail

Push mode:

  • The MCM control plane connects to the member cluster directly
  • Resources synchronise in real time
  • Network reachability is required

Pull mode:

  • The Karmada agent has to be installed on the member cluster
  • The agent checks the control plane for changes periodically
  • Suited to clusters behind a firewall

Next Steps