Deploy a VMware vSphere-based regional cluster¶
You can deploy an additional regional VMware vSphere-based cluster to create managed clusters of several provider types or with different configurations.
To deploy a vSphere-based regional cluster:
Log in to the node where you bootstrapped a management cluster.
Verify that the bootstrap directory is updated.
Select from the following options:
For clusters deployed using Container Cloud 2.11.0 or later:
./container-cloud bootstrap download --management-kubeconfig <pathToMgmtKubeconfig> \ --target-dir <pathToBootstrapDirectory>
For clusters deployed using the Container Cloud release earlier than 2.11.0 or if you deleted the
kaas-bootstrapfolder, download and run the Container Cloud bootstrap script:
wget https://binary.mirantis.com/releases/get_container_cloud.sh chmod 0755 get_container_cloud.sh ./get_container_cloud.sh
Verify access to the target vSphere cluster from Docker. For example:
docker run --rm alpine sh -c "apk add --no-cache curl; \ curl https://vsphere.server.com"
The system output must contain no error records. In case of issues, follow the steps provided in Troubleshooting.
Prepare deployment templates:
IP address or FQDN of the vCenter Server.
Port of the vCenter Server. For example,
port: "8443". Leave empty to use
vSphere data center name.
Flag that controls validation of the vSphere Server certificate. Must be
vSphere Cluster API provider user name that you added when preparing the deployment user setup and permissions.
vSphere Cluster API provider user password.
vSphere Cloud Provider deployment user name that you added when preparing the deployment user setup and permissions.
vSphere Cloud Provider deployment user password.
templates/vsphere/cluster.yaml.templateparameters to fit your deployment. For example, add the corresponding values for
IP address from the provided vSphere network for load balancer (Keepalived).
MetalLB range of IP addresses that can be assigned to load balancers for Kubernetes Services.
Name of the vSphere datastore. You can use different datastores for vSphere Cluster API and vSphere Cloud Provider.
Path to a folder where the cluster machines metadata will be stored.
Path to a network for cluster machines.
Path to a resource pool in which VMs will be created.
For either DHCP or non-DHCP vSphere network:
Determine the vSphere network parameters as described in VMware vSphere network objects and IPAM recommendations.
Provide the following additional parameters for a proper network setup on machines using embedded IP address management (IPAM) in
Enables IPAM. Recommended value is
truefor either DHCP or non-DHCP networks.
CIDR of the provided vSphere network. For example,
Gateway of the provided vSphere network.
IP range for the cluster machines. Specify the range of the provided CIDR. For example,
10.20.0.100-10.20.0.200. If the DHCP network is used, this range must not intersect with the DHCP range of the network.
Optional. IP ranges to be excluded from being assigned to the cluster machines. The MetalLB range and
SET_LB_HOSTshould not intersect with the addresses for IPAM. For example,
List of nameservers for the provided vSphere network.
For RHEL deployments, fill out
templates/vsphere/rhellicenses.yaml.templateusing one of the following set of parameters for RHEL machines subscription:
The user name and password of your RedHat Customer Portal account associated with your RHEL license for Virtual Datacenters.
Optionally, provide the subscription allocation pools to use for the RHEL subscriptions activation. If not needed, remove the
subscription-managerto automatically select the licenses for machines.
spec: username: <username> password: value: <password> poolIDs: - <pool1> - <pool2>
The activation key and organization ID associated with your RedHat account with RHEL license for Virtual Datacenters. The activation key can be created by the organization administrator on RedHat Customer Portal.
If you use the RedHat Satellite server for management of your RHEL infrastructure, you can provide a pre-generated activation key from that server. In this case:
Provide the URL to the RedHat Satellite RPM for installation of the CA certificate that belongs to that server.
squid-proxyon the management or regional cluster to allow access to your Satellite server. For details, see Configure squid-proxy.
spec: activationKey: value: <activation key> orgID: "<organization ID>" rpmUrl: <rpm url>
For RHEL 8.4 TechPreview, verify mirrors configuration for your activation key. For more details, see RHEL 8 mirrors configuration.
Provide only one set of parameters. Mixing of parameters from different activation methods will cause deployment failure.
For CentOS deployments, in
templates/vsphere/rhellicenses.yaml.template, remove all lines under
Optional if servers from the Ubuntu NTP pool (
*.ubuntu.pool.ntp.org) are accessible from the node where the regional cluster is being provisioned. Otherwise, this step is mandatory.
Configure the regional NTP server parameters to be applied to all machines of regional and managed clusters in the specified region.
templates/vsphere/cluster.yaml.template, add the
ntp:serverssection with the list of required servers names:
spec: ... providerSpec: value: kaas: ... regional: - helmReleases: - name: vsphere-provider values: config: lcm: ... ntp: servers: - 0.pool.ntp.org ... provider: vsphere ...
Prepare the OVF template as described in Prepare the OVF template.
SET_VSPHERE_TEMPLATE_PATHprepared in the previous step
Modify other parameters as required
spec: providerSpec: value: apiVersion: vsphere.cluster.k8s.io/v1alpha1 kind: VsphereMachineProviderSpec rhelLicense: <rhel-license-name> network: devices: - dhcp4: true dhcp6: false template: <SET_VSPHERE_TEMPLATE_PATH>
<rhel-license-name>value is the RHEL license name defined in
rhellicenses.yaml.tempalte, defaults to
kaas-mgmt-rhel-license. Remove or comment out this parameter for CentOS deployments.
Optional. If you require all Internet access to go through a proxy server, in
bootstrap.env, add the following environment variables to bootstrap the regional cluster using proxy:
export HTTP_PROXY=http://proxy.example.com:3128 export HTTPS_PROXY=http://user:email@example.com:3128 export NO_PROXY=172.18.10.0,registry.internal.lan export PROXY_CA_CERTIFICATE_PATH="/home/ubuntu/.mitmproxy/mitmproxy-ca-cert.cer"
The following formats of variables are accepted:
http://proxy.example.com:port- for anonymous access
http://user:firstname.lastname@example.org:port- for restricted access
Comma-separated list of IP addresses or domain names
PROXY_CA_CERTIFICATE_PATHAvailable since 2.20.0 as GA
Optional. Path to the proxy CA certificate for man-in-the-middle (MITM) proxies. Must be placed on the bootstrap node to be trusted. For details, see Install a CA certificate for a MITM proxy on a bootstrap node.
If you require Internet access to go through a MITM proxy, ensure that the proxy has streaming enabled as described in Enable streaming for MITM.
Since Container Cloud 2.20.0, this parameter is generally available for the OpenStack, bare metal, Equinix Metal with private networking, AWS, and vSphere providers
For MOSK-based deployments, the feature support is available since MOSK 22.4
Since Container Cloud 2.18.0, this parameter is available as TechPreview for the OpenStack and bare metal providers only
For Azure and Equinix Metal with public networking, the feature is not supported
For implementation details, see Proxy and cache support.
For the list of Mirantis resources and IP addresses to be accessible from the Container Cloud clusters, see Requirements for a VMware vSphere-based cluster.
Optional, Technology Preview in Container Cloud 2.18.0. Removed in Container Cloud 2.19.0 for compatibility reasons, currently not supported. Enables encryption for the Kubernetes workloads network using the following field to the
spec: providerSpec: value: secureOverlay: true
For more details, see MKE documentation: Kubernetes network encryption.
When the option is enabled, Calico networking is configured to use IP-in-IP overlay and BGP routing.
When the option is disabled, Calico networking is configured to use VXLAN overlay (no BGP).
Export the following parameters:
export KAAS_VSPHERE_ENABLED=true export KUBECONFIG=<pathToMgmtClusterKubeconfig> export REGIONAL_CLUSTER_NAME=<newRegionalClusterName> export REGION=<NewRegionName>
Substitute the parameters enclosed in angle brackets with the corresponding values of your cluster.
REGIONAL_CLUSTER_NAMEparameters values must contain only lowercase alphanumeric characters, hyphens, or periods.
If the bootstrap node for the regional cluster deployment is not the same where you bootstrapped the management cluster, also export
SSH_KEY_NAME. It is required for the management cluster to create a
publicKeyKubernetes CRD with the public part of your newly generated
ssh_keyfor the regional cluster.
Run the regional cluster bootstrap script:
When the bootstrap is complete, obtain and save in a secure location the
kubeconfig-<regionalClusterName>file located in the same directory as the bootstrap script. This file contains the admin credentials for the regional cluster.
If the bootstrap node for the regional cluster deployment is not the same where you bootstrapped the management cluster, a new regional
ssh_keywill be generated. Make sure to save this key in a secure location as well.
Prepare the bootstrap cluster for the new regional cluster.
Load the updated Container Cloud CRDs for
Machineswith information about the new regional cluster to the management cluster.
Connect to each machine of the management cluster through SSH.
Wait for the
Clusterobjects of the new regional cluster to be ready on the management cluster.
Load the following objects to the new regional cluster:
Secretwith the management cluster
ClusterRolefor the Container Cloud provider.
Forward the bootstrap cluster endpoint to
Wait for all CRDs to be available and verify the objects created using these CRDs.
Pivot the cluster API stack to the regional cluster.
Switch the LCM Agent from the bootstrap cluster to the regional one.
Wait for the Container Cloud components to start on the regional cluster.
Now, you can proceed with deploying the managed clusters of supported provider types as described in Create and operate managed clusters.