Deploy a cluster using the Kubernetes cluster template.

Prerequisites

  • You require a role with Infrastructure Lifecycle Management privileges.

  • You must have uploaded the Virtual Machine template of the specific k8s version to VMware Telco Cloud Automation that the cluster will run. Refer to Import New BYOI Templates into vSphere.

  • You must have onboarded a vSphere VIM.

  • You must have created or uploaded a Management cluster template.

  • A network must be present with the DHCP range and the static IP address of the same subnet.

Procedure

  1. Log in to the VMware Telco Cloud Automation web interface.
  2. Go to Infrastructure > CaaS Infrastructure and click Deploy Cluster.
    Note:

    Depending on the VMware Telco Cloud Automation setup, internet accessed or air-gapped, the options available for the cluster may change.

  3. From the drop-down menu, select Management Cluster.

    • If you have saved a validated Management cluster configuration that you want to replicate on this cluster, click Upload on the top-right corner and upload the JSON file. The fields are then auto-populated with this configuration information and you can edit them as required. You can also use the Copy Spec function of VMware Telco Cloud automation instead of JSON file, for details, see #GUID-52A29497-D6CA-4942-BEEC-518289F4AE8E.

    • If you want to create a Management cluster configuration from the beginning, perform the next steps.

  4. Select a cloud on which you want to deploy the Kubernetes cluster.

    Under the Advanced Options, you can select the Infrastructure for Management Cluster LCM. The VMware Telco Cloud Automation uses this VIM and associated control planes for cluster LCM operations.

  5. Click Next.
  6. The Select Cluster Template tab displays the available Kubernetes cluster templates. Select the Management Kubernetes cluster template that you have created.
    Note:

    If the template displays as Not Compatible, edit the template and try again.

  7. Click Next.
  8. In the Kubernetes Cluster Details tab, provide the following details:
    • Name - Enter the cluster name. The cluster name must be compliant with DNS hostname requirements as outlined in RFC-952 and amended in RFC-1123.
      Note: Please add the following cluster name to deny list.
      • capi-kubeadm-bootstrap-system
      • capi-kubeadm-control-plane-system
      • capi-system
      • capv-system
      • cert-manager
      • default
      • fluent-system
      • istio-system
      • kube-node-lease
      • kube-public
      • kube-system
      • kube-node-lease
      • metallb-system
      • postgres-operator-system
      • tanzu-package-repo-global
      • tanzu-system
      • tca-services
      • tca-mgrtca-system
      • tkg-system
      • tkg-system-public
      • tkg-system-telemetry
      • tkr-system

    • Description (Optional) - Enter an optional description of the cluster.

    • Password - Create a password to log in to the Master and Worker nodes. The default user name is capv.

      Note:

      Ensure that the password meets the minimum requirements displayed in the UI.

    • Confirm Password - Confirm the password that you have entered.

    • OS Image With Kubernetes - The pop-up menu displays the OS image templates in your vSphere instance that meet the criteria to be used as a Tanzu Kubernetes Grid base OS image with the selected Kubernetes version. If there are no templates, ensure that you upload them to your vSphere environment.

    • IP Version - Whether to use the IPv4, IPv6, or 'IPv6 and IPv4' for cluster deployment. Select the value from the drop-down list.
      Note:

      'IPv6 and IPv4' is available for Kubernetes v1.28.7 or higher, and requires TCA as a dual-stack setup.

    • Virtual IP Address - VMware Tanzu Kubernetes Grid deploys a kube-vip pod that provides load-balancing services to the cluster API server. This kube-vip pod uses a static virtual IP address to load-balance API requests across multiple nodes. Assign an IP address that is not within your DHCP range, but in the same subnet as your DHCP range.
      Note: The IP version of Virtual IP Address of 'IPv6 and IPv4' cluster must be IPv6.

    • Syslog Servers - Add the syslog server IP address/FQDN for capturing the infrastructure logs of all the nodes in the cluster.

    • Variables - Configure the NTP server.

    • vSphere Cluster - Select the default vSphere cluster on which the Master and Worker nodes are deployed.

    • Resource Pool - Select the default resource pool on which the Master and Worker nodes are deployed.

    • VM Folder - Select the virtual machine folder on which the Master and Worker nodes are placed.

    • Datastore - Select the default datastore for the Master and Worker nodes to use.

    • MTU (Optional) - Select the maximum transmission unit (MTU) in bytes for management interfaces of control planes and node pools. If you do not select a value, the default value is 1500.

    • Domain Name Servers - Enter a valid DNS IP address. These DNS servers are configured in the guest operating system of each node in the cluster. You can override this option on the Master node and each node pool of the Worker node. To add a DNS, click Add.

    • Airgap & Proxy Settings - Use this option when you need to configure the Airgap or the Proxy environment for VMware Telco Cloud Automation. If you do not want to use the Airgap or Proxy, select None.

      Note:

      You must use either airgap or proxy in an IPv6 setup. Do not select none for an IPv6 setup.

      • In an air-gapped environment:

        • If you have added an air-gapped repository, select the repository using the Airgap Repository drop-down menu.

        • If you have not added an air-gapped repository yet and want to add one now, select Enter Repository Details:

          • FQDN - Enter the URL of your repository.

          • CA Certificate - If your air-gapped repository uses a self-signed certificate, paste the contents of the certificate in this text box. Ensure that you copy and paste the entire certificate, from ----BEGIN CERTIFICATE---- to ----END CERTIFICATE----.

      • In a proxy environment:

        • If you have added a proxy, select the proxy using the Proxy Repository drop-down menu.

        • If you have not added proxy yet and want to add one now, select Enter Proxy Details and provide the following details:

          • HTTP Proxy - To route the HTTP requests through proxy, enter the URL or full domain name of HTTP proxy. You must use the format FQDN:Port or IP:Port.

          • HTTPS Proxy - To route the HTTPs requests through proxy, enter the URL or full domain name of HTTPs proxy. You must use the format FQDN:Port or IP:Port.

          • (Optional)

            No Proxy - Enter the name of the local server.

            Note:

            You must add the cluster node network CIDR, vCenter FQDN(s), harbor FQDN(s) and any other host that you want to bypass the proxy in this list.

          • (Optional)

            CA Certificate - If your air-gapped repository uses a self-signed certificate, paste the contents of the certificate in this text box. Ensure that you copy and paste the entire certificate, from ----BEGIN CERTIFICATE---- to ----END CERTIFICATE----.

  9. In Harbor, If you have defined a Harbor repository as a part of your Partner system, click Add > Select Repository. To add a new repository, click Add > Enter Repository Detail.
    Note:

    You can add multiple Harbor repositories.

  10. CEIP Agreement - By default, Participate in the Customer Experience Improvement Program is enabled. However, if you don't want to participate in the VMware Customer Experience Improvement Program (CEIP), clear the check box.
  11. Click Next.
  12. In the Control Plane Node Configuration tab, provide the following details:
    Note:

    VMware Telco Cloud Automation displays the allocated CPU, Memory, and Storage details along with number of Replica details of the master node. These configurations depend on the Cluster template selected for Kubernetes Cluster deployment.

    • Network - Associate a management or a private network. Ensure that the management network connects to a network where DHCP is enabled, and can access the VMware Photon repository.

    • Domain Name Servers - You can override the DNS. To add a DNS, click Add.

  13. Click Next.
  14. In the Worker Node Configuration tab, provide the following details:
    Note:

    VMware Telco Cloud Automation displays the allocated CPU, Memory, and Storage details along with number of Replica details of the master node. These configurations depend on the Cluster template selected for Kubernetes Cluster deployment.

    • Network - Associate a management or a private network. Ensure that the management network can access the VMware Photon repository.

    • Domain Name Servers - You can override the DNS. To add a DNS, click Add.

  15. Click Next and review the configuration. You can download the configuration and reuse it for deploying a cluster with a similar configuration.
  16. Click Deploy.
    When deploying a management cluster, the certificate renewal of the cluster is automatically enabled and the number of days defaults to 90.

    If the operation is successful, the cluster is created and its status changes to Active. If the operation fails, the cluster status changes to Not Active. If the cluster fails to create, delete the cluster, upload the previously downloaded configuration, and recreate it.

Results

The Management cluster is deployed and VMware Telco Cloud Automation automatically pairs it with the cluster of the site.

Note:

You can deploy one Management cluster at a time. Parallel deployments are queued and deployed in sequence.

What to do next

  • You can view the Kubernetes clusters deployed through VMware Telco Cloud Automation from the Kubernetes Cluster tab.

  • To view more details of the Kubernetes cluster that you have deployed, change the password, or to add syslog servers, go to CaaS Infrastructure > Cluster Instances and click the cluster.