VMware vSphere Provider APIs

The VMware vSphere Infrastructure Provider defines custom resources for managing vSphere infrastructure through Cluster API.

Custom Resources

ResourceDescriptionDocumentation
VSphereClusterRepresents a Kubernetes cluster infrastructure on vSphereVSphereCluster
VSphereClusterIdentityCluster-scoped vCenter credential shared across namespaces via selectorsVSphereClusterIdentity
VSphereMachineRepresents a virtual machine in vSphereVSphereMachine
VSphereVMLow-level provider resource for the backing vCenter VM, reconciled by the controllerVSphereVM
VSphereMachineTemplateTemplate for creating vSphere machinesVSphereMachineTemplate
VSphereMachineConfigPoolPool of pre-defined node slots with hostnames, static IPs, and persistent disksVSphereMachineConfigPool
VSphereFailureDomainDescribes a datacenter, compute cluster, datastore, and network topology used as a failure domainVSphereFailureDomain
VSphereDeploymentZoneBinds a VSphereFailureDomain to a vCenter server and placement constraintsVSphereDeploymentZone

API Group

All VMware vSphere resources belong to the API group infrastructure.cluster.x-k8s.io/v1beta1.

Not Covered

The provider also ships VSphereClusterTemplate, which is consumed by Cluster API ClusterClass / managed-topology flows. This product provisions workload clusters from explicit Cluster, VSphereCluster, and KubeadmControlPlane manifests rather than through ClusterClass, so VSphereClusterTemplate is not documented here.