Help Center/ Ubiquitous Cloud Native Service/ User Guide/ UCS Clusters/ On-Premises Clusters/ Installing an On-Premises Cluster/ Installation and Verification
Updated on 2024-10-25 GMT+08:00
View PDF
Share

Installation and Verification

After an on-premises cluster is registered with UCS, its status is Pending installation and connection. This means UCS does not install Kubernetes for the cluster, and there is no network connection established between the cluster and UCS. In this case, you need to configure a network agent in the cluster for network connectivity and cluster installation.

Connect the cluster to UCS within 24 hours after the cluster is registered. You can click in the upper right corner to view the detailed network connection process. If the cluster is not connected to UCS within 24 hours, it will fail to be registered. In this case, click in the upper right corner to register it again. If the cluster is connected to UCS but its status is not updated, wait for 2 minutes and refresh the cluster.

Uploading the Configuration File

  1. Log in to the UCS console and click Click to connect in the card view of the cluster.
  2. Select an access mode and download the agent configuration file.

    If you select Public access, click Download to download agent-{Cluster name}.yaml.

    If you select Private access, select a project and then the VPC endpoint created in Preparing for Installation (Private Network Access) and click Download to download agent-{Cluster name}.yaml.

    The agent configuration file contains keys and can be downloaded only once for each cluster. Keep the file secure.

  3. Set the parameters required for cluster installation and download the cluster configuration file cluster-{Cluster name}.yaml.

    If the cluster version is 1.28.5 or later, set the cluster architecture to x86 or Arm.

    • Cluster nodes do not support heterogeneous architectures.
    • You can select cluster architectures for clusters v1.28.5 or later.

  4. Use the remote file transfer tool to upload the agent-{Cluster name}.yaml and cluster-{Cluster name}.yaml files to the /root/ directory on the executor as root.

    • If you want to use load balancing at Layer 4 or Layer 7, set the cluster network type to BGP. For details, see Cilium.
    • If the SSH connection times out on the executor, rectify the fault by referring to How Do I Do If VM SSH Connection Times Out?
    • After selecting the cluster architecture, ensure that the executor of ucs-ctl uses the same architecture as the cluster.

(Optional) Verifying the Integrity of ucs-ctl

ucs-ctl is a command-line tool for managing UCS on-premises clusters. Before installing an on-premises cluster and using ucs-ctl, verify the integrity of ucs-ctl to prevent it from being tampered with. For details about ucs-ctl, see Using ucs-ctl to Manage On-Premises Clusters.

In an on-premises cluster, you can use the SHA256 verification file to verify the integrity of the ucsctl file.

  1. Click Install Cluster, copy the the installation address of ucs-ctl shown in Figure 1.

    Figure 1 ucs-ctl installation address

  2. Replace the download address in the following command with the address recorded in 1 and run the command to download the SHA256 verification file: 

    curl {download_address}.sha256 -o ucs-ctl.sha256 #

  3. Save the verification file to the ucs-ctl directory and run the following command to verify the integrity of ucs-ctl: 

    sha256sum -c <(grep ucs-ctl ucs-ctl.sha256)

  4. If "OK" is displayed in the command output, the verification is successful. If "FAILED" is displayed in the command output, the verification fails. In this case, submit a service ticket and contact technical support personnel.

Installing an On-Premises Cluster

  1. Click Install Cluster, copy the installation command, and run the command in the /root directory (or another available directory).

    Figure 2 Installing an on-premises cluster

  2. Go to the UCS console and refresh the cluster status. The cluster is in the Running state.
  3. Click the name of the on-premises cluster to access its details page. Perform operations on resources such as cluster nodes and workloads. If the operations can be performed without errors, the on-premises cluster has been successfully connected.