vSphere Provider (shturval-capvs)

About the service

ParameterDescription
GUI namevSphere Provider
System name (identifier)shturval-capvs
Cluster AssignmentIntegration with VMware vSphere: deployment of virtual machines for cluster nodes via the Cluster API. Does not integrate with VMware vCloud Director. Installed in the management cluster.
CriticalYes, if the management cluster is deployed with the VMware vSphere provider
Public repositoryCluster API Provider vSphere (CAPV)
Dependenciesshturval-capvs-crds, shturval-capi-crds
Namespacecapv-system

Purpose

shturval-capvs is the vSphere provider for the Cluster API. Enables the creation and management of virtual machines in VMware vSphere for use as nodes in Kubernetes clusters. Depends on shturval-capvs-crds.

Installing the service

shturval-capvs - infrastructure provider Cluster API for VMware vSphere. In the Shturval platform, the connection and life cycle of such a provider in the management cluster is ensured by cluster-manager; ShturvalServiceConfig (SSC) objects for provider charts are created and maintained as part of the platform configuration, rather than as an arbitrary manual installation of a service chart.

In the production environment, the provider is represented by two SSCs:

  • shturval-capvs — the main chart of the vSphere provider;
  • shturval-capvs-crds — CRD chart of the vSphere provider module.

For correct operation, the CRD of the main Cluster API (shturval-capi-crds and the associated component shturval-capi) must be available in the management cluster.

If the service was disabled during platform deployment, the provider’s SSCs could receive an absence mode (mode: absent). To ensure that the provider is available to work with virtualization, first change the shturval-capvs-crds mode to auto, then shturval-capvs to auto. You can change the mode in the platform GUI on the Providers page.

In the GUI, this action is performed by the service mode switch. The screenshot shows the selection of the Auto mode for the provider service.

Switching provider service mode

Customvalues parameters

The structure of the main chart values is described by the spec.customvalues field of the corresponding ShturvalServiceConfig and coincides with the helm/main/values.yaml of the shturval-capvs chart.

Recommendation: do not edit the ShturvalServiceConfig object manually to change limits, nodeSelector, vSphere connection parameters and other release settings - such an object belongs to the platform configuration and can be overwritten during updates. Make all changes to the behavior of the service through ShturvalServicePatch (SSP), which overlays spec.customvalues on top of the base SSC.

Where to configure

Services and repositories → Installed services → shturval-capvs → Manage. The service is hosted in the management cluster.

Configuring provider instances in the platform - VMware vSphere. General overview - How work with providers in the platform works.

Reference: For VMware vSphere infrastructure CRs, see Custom Node Lifecycle Resources - VMware vSphere.

To dynamically provision volumes in clusters on vSphere, use the shturval-capvs-csi module (CSI vSphere).