Last modified December 16, 2024

cluster-vsphere chart reference

The cluster-vsphere chart templates all the VMware infrastructure resources that are necessary to create a Cluster API vSphere cluster.

Sandbox Container image
object 
Repository
string 
Registry
string 
Tag
string 
Teleport
object 
Enable teleport
boolean 
Teleport proxy address
string 
Teleport version
string 
Kubernetes version
string 
Network
object 
Allow all egress
boolean 
Container registries
object 
Endpoints and credentials configuration for container registries.
array 
object 
Credentials
object 
Credentials for the endpoint.
Auth
string 
Base64-encoded string from the concatenation of the username, a colon, and the password.
Identity token
string 
Used to authenticate the user and obtain an access token for the registry.
Password
string 
Used to authenticate for the registry with username/password.
Username
string 
Used to authenticate for the registry with username/password.
Endpoint
string 
Endpoint for the container registry.
Endpoint
object 
Kubernetes API configuration.
Host
string 
IP for access to the Kubernetes API.
Ip Pool Name
string 
Ip for control plane will be drawn from this GlobalInClusterIPPool resource.
Port number
integer 
Port for access to the Kubernetes API.
Load balancers
object 
Pods
object 
array 
string 
IPv4 address range, in CIDR notation.
Services
object 
array 
string 
IPv4 address range, in CIDR notation.
Etcd
object 
Image repository
string 
Image tag
string 
Number of nodes
integer 
Users
array 
object 
Authorized keys
array 
Key
string 
Name
string 
string 
string 
string 
Subject alternative names (SAN)
array 
Alternative names to encode in the API server's certificate.
SAN
string 
Admission plugins
string 
Comma-separated list of admission plugins to enable.
Feature gates
string 
Enabled feature gates, as a comma-separated list.
Feature gates
string 
Enabled feature gates, as a comma-separated list.
Clone mode
string 
Method used to clone template image.
Disk size (GB)
integer 
Node disk size in GB. Must be at least as large as the source image.
Folder
string 
VSphere folder to deploy instances in. Must already exist.
Memory (MB)
integer 
Node memory allocation in MB.
Segment name
string 
Segment name to attach nodes to. Must already exist.
CPU cores
integer 
Number of CPUs to assign per node.
Resource pool
string 
Resource pool to allocate nodes from. Must already exist.
Storage policy
string 
Storage policy to use. If specified, it must already exist.
Name
string 
Image template name to use for nodes.
Datacenter
string 
Name of the datacenter to deploy nodes into.
Datastore
string 
Name of the datastore for node disk storage.
Password
string 
Password for the VSphere API.
Region
string 
Category name in VSphere for topology.kubernetes.io/region labels.
Server
string 
URL of the VSphere API.
Thumbprint
string 
TLS certificate signature of the VSphere API.
Username
string 
Username for the VSphere API.
Zone
string 
Category name in VSphere for topology.kubernetes.io/zone labels.
Number of nodes
integer 
Organization
string 

Further reading

This part of our documentation refers to our vintage product. The content may be not valid anymore for our current product. Please check our new documentation hub for the latest state of our docs.