Available in editions:  Ultimate/EE, SE+

Included in extensions: On-prem IaaS

The module lifecycle stage: General Availability

The cloud-provider-vsphere module integrates Deckhouse Platform with VMware vSphere. It allows the node-manager module to use vSphere resources when provisioning nodes for a NodeGroup.

Features of the cloud-provider-vsphere module:

  • Managing vSphere resources via cloud-controller-manager:
    • creates network routes for the PodNetwork network on the vSphere side;
    • updates virtual machine and Kubernetes node metadata and removes from Kubernetes nodes that no longer exist in vSphere.
  • Provisioning disks via CSI on datastore. By default, CNS volumes with online resize are used. First-Class Disk (FCD) mode is available as legacy and is configured with the compatibilityFlag parameter.
  • Provisioning base infrastructure and CloudPermanent nodes using the Terraform/OpenTofu provider terraform-provider-vsphere.
  • Provisioning CloudEphemeral nodes via Machine Controller Manager (MCM). Virtual machine parameters are set in the VsphereInstanceClass resource.
  • Registering with node-manager so that VsphereInstanceClass can be used when describing a NodeGroup.
  • Enabling CNI for new clusters automatically. By default, cni-cilium is used.

The module is moving CloudEphemeral node management from Machine Controller Manager (MCM) to Cluster API (CAPI). Existing NodeGroups keep running on MCM, new ones are created on CAPI by default. The procedure for moving existing groups is described in How to migrate node groups to Cluster API (CAPI).

Nodes managed by CAPI

vSphere requirement

The vSphere cluster that hosts CAPI-managed nodes must have DRS enabled. The module does not pick a specific host when cloning a virtual machine, so vSphere chooses the host within the cluster. Without DRS the choice is not made, and the nodes of the group are not created.

The same requirement applies to master nodes and CloudPermanent nodes created by Terraform. Node groups managed by MCM also worked in a cluster without DRS.

The remaining environment requirements are listed in Connecting to and authenticating with VMware vSphere.

vCenter tags

The module assigns the deckhouse-cluster-name/<CLUSTER_UUID> tag to every virtual machine it creates, the same way MCM did. The deckhouse-node-role/<NODE_GROUP>-<ZONE> tag that MCM assigned as well is not assigned under CAPI. To select the nodes of a single group, use the node.deckhouse.io/group label.

Virtual machine placement

The module honors both placement parameters of the VsphereInstanceClass resource, resourcePool and datastore. When at least one of them is set in the instance class, the virtual machines of the group are created in the specified resource pool and on the specified datastore in every zone the group spans. A parameter left unset takes the default value defined for the cluster at installation.

Third-party components

List of third-party software used in the cloud-provider-vsphere module: