Manage cluster federations

Create a cluster federation

Prerequisites

The following conditions must be met before you create a cluster federation:

• The target host cluster is created or imported in the KCE console.

• The Kubernetes version of the target host cluster is 1.13 or later.

• More than 2 CPU cores and 4 GB memory are reserved in the target host cluster.

• The cross-region access is enabled for a member cluster if the memory cluster and the host cluster reside in different regions.

Create a cluster federation

1. Log in to the KCE console.
2. In the left navigation pane, choose Multi-Cluster > Federation Management. The Federation Management page appears.
3. Select the region where the target host cluster resides, and click Create Cluster Federation.
4. Select the region and host cluster, and click Create to start deploying the control plane of the federation. You can view the status of control plane components on the Check Deployment Status page. If a component fails to be deployed, click Redeploy to reinstall the component in overwriting mode.

5. Go back to the Federation Management page. The cluster federation appears. You can view the federation status of the host cluster.

Note: If the status of the host cluster is displayed as Not added, the control plane is in normal status. The host cluster is deployed only as the control plane cluster and does not play the member role. In this case, federated resources are not deployed in the host cluster. To allow the host cluster to play the member role, choose More > Join Federation in the Operation column.

Add member clusters

1. After the host cluster is deployed, click Add Member Cluster in the Operation column of the host cluster. The Add Member Cluster dialog box appears. You can select clusters from different regions and add them to the federation. A maximum of five member clusters can be added at a time.

2. For the clusters that reside in regions different from that of the host cluster, select the clusters and manually enable cross-region access.

3. Click OK. The clusters that reside in the same region as that of the host cluster and the clusters that meet the cross-region access requirements are added to the federation. You can go back to the Federation Management page to view the federation status of the member clusters.

Manage a cluster federation

Exit a cluster federation

To remove a member cluster from the federation, find the member cluster and click Exit Federation in the Operation column. When a member cluster exits a federation, the resources related to the federation are deleted from the member cluster. If this cluster belongs to another federation, resources in the same namespace are also deleted. Therefore, we recommend that you do not add a cluster to multiple federations.

You can select the option for forcibly exiting the federation. In this case, a force exit is performed regardless of whether abnormal resources exist.

Delete a cluster federation

Find the cluster federation and choose More > Delete Federation. All resources related to the federation are deleted from the host cluster and member clusters.