vSphere CAPI Override Reference

This page provides examples and references for overriding Cluster API (CAPI) properties on VMware vSphere clusters using CAPV, the Cluster API provider implementation for vSphere.

vSphere

Cluster-level overrides target the VSphereCluster resource, and pool-level overrides target the VSphereMachineTemplate resource.

Level	CAPI Kind	API References
Cluster	VSphereCluster	v1.12.0 VSphereCluster API types
Pool	VSphereMachineTemplate	v1.12.0 VSphereMachineTemplate API types

warning

The top-level keys for both vSphere resources are all-lowercase (vsphereCluster and vsphereMachineTemplate). These keys do not follow the camelCase-of-Kind rule that most other providers use, so watch for the casing when constructing override YAML.

Examples

These examples demonstrate how to override CAPI properties using YAML directly targeting the underlying CAPV resources.

Cluster-Level

Disable Cluster Modules

vsphereCluster:
  spec:
    disableClusterModule: true

Pool-Level

VSphereMachineTemplate has an extra level of nesting. The spec wraps a template, which contains another spec field that holds the actual machine configuration. All pool-level vSphere overrides use this structure.

Set power-off mode and CPU count

vsphereMachineTemplate:
  spec:
    template:
      spec:
        powerOffMode: hard
        numCPUs: 4

Unsupported First-Class Properties

The following properties are not exposed as first-class properties in the supported interfaces for Palette but can be configured using override. To learn more about the difference between first-class properties and override properties, refer to the First-Class Support vs. Override section.

CAPV Resource Type	Properties
VSphereCluster	clusterModules, disableClusterModule, thumbprint
VSphereMachineTemplate	additionalDisksGiB, customVMXKeys, dataDisks, hardwareVersion, network, network.routes, numCoresPerSocket, os, pciDevices, preferredAPIServerCidr, server, snapshot, tagIDs, thumbprint