Last modified December 16, 2024
cluster-cloud-director chart reference
The cluster-cloud-director chart templates all the VMware infrastructure resources that are necessary to create a Cluster API VCD cluster.
Chart Configuration Reference
Admission plugins
array
List of admission plugins to be passed to the API server via the --enable-admission-plugins flag.
Feature gates
array
API server feature gate activation/deactivation.
CiliumNetworkPolicies
object
Enable CiliumNetworkPolicies
boolean
Installs the network-policies-app (deny all by default) if set to true
Feature gates
array
Controller manager feature gate activation/deactivation.
Management cluster UID
string
If set, create the cluster from a specific management cluster associated with this UID.
Runtime defined entity (RDE) identifier
string
This cluster's RDE ID in the VCD API.
Sandbox Container image (pause container)
object
Skip RDE
boolean
Set to true if the API schema extension is installed in the correct version in VCD to create CAPVCD entities in the API. Set to false otherwise.
Display as management cluster
boolean
Connectivity
Configurations related to cluster connectivity such as container registries.
Container registries
object
Endpoints and credentials configuration for container registries.
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.
Control plane endpoint
object
Kubernetes API endpoint.
Extra OVDC networks
array
OVDC networks to attach VMs to, additionally.
Virtual IP subnet
string
Virtual IP CIDR for the external network.
string
IPv4 address range, in CIDR notation.
string
IPv4 address range, in CIDR notation.
Destination
string
IPv4 address range in CIDR notation.
Time synchronization (NTP)
object
Servers/pools to synchronize this cluster's clocks with.
Proxy
object
Whether/how outgoing traffic is routed through proxy servers.
Secret name
string
Name of a secret resource used by containerd to obtain the HTTP_PROXY, HTTPS_PROXY, and NO_PROXY environment variables. If empty the value will be defaulted to -cluster-values.
OS Users
array
Configuration for OS users in cluster nodes.
Name
string
Username of the user.
Sudoers configuration
string
Permissions string to add to /etc/sudoers for this user.
Trusted SSH cert issuers
array
CA certificates of issuers that are trusted to sign SSH user certificates.
Control plane
Catalog
string
Name of the VCD catalog in which the VM template is stored.
Subject alternative names (SAN)
array
Alternative names to encode in the API server's certificate.
DNS container image
object
Etcd container image
object
Node container image
object
OIDC authentication
object
Certificate authority file
string
Path to identity provider's CA certificate in PEM format.
Client ID
string
OIDC client identifier to identify with.
Groups claim
string
Name of the identity token claim bearing the user's group memberships.
Groups prefix
string
Prefix prepended to groups values to prevent clashes with existing names.
Issuer URL
string
URL of the provider which allows the API server to discover public signing keys, not including any path. Discovery URL without the '/.well-known/openid-configuration' part.
Username claim
string
Name of the identity token claim bearing the unique user identifier.
Username prefix
string
Prefix prepended to username values to prevent clashes with existing names.
VM placement policy
string
Name of the VCD VM placement policy to use.
Number of nodes
integer
Number of control plane instances to create. Must be an odd number.
Resource ratio
integer
Ratio between node resources and apiserver resource requests.
Sizing policy
string
Name of the VCD sizing policy to use.
Storage profile
string
Name of the VCD storage profile to use.
Template
string
Name of the template used to create the node VMs.
Kubectl image
Used by cluster-shared library chart to configure coredns in-cluster.
Metadata
Cluster description
string
User-friendly description of the cluster's purpose.
Labels
object
These labels are added to the Kubernetes resources defining this cluster.
Prevent cluster deletion
boolean
Service priority
string
The relative importance of this cluster.
Node pools
Groups of worker nodes with identical configuration.
Node class
string
A valid node class name, as specified in VMware Cloud Director (VCD) settings > Node classes.
VMware Cloud Director (VCD) settings
Cloud provider interface (CPI)
object
Share IPs in virtual services
boolean
If enabled, multiple virtual services can share the same virtual IP address.
One-arm
object
If enabled, use an internal IP for the virtual service with a NAT rule to expose the external IP. Otherwise the virtual service will be exposed directly with the external IP.
Container storage interface (CSI)
object
Pre-create storage class
object
Pre-create storage class for the VCD CSI.
Pre-create delete storage class
object
Default storage class
boolean
Name of storage profile in VCD
string
Pre-create retain storage class
object
Default storage class
boolean
Name of storage profile in VCD
string
Node classes
object
Re-usable node configuration.
Catalog
string
Name of the VCD catalog in which the VM template is stored.
string
One of NoSchedule, PreferNoSchedule or NoExecute
string
Name of the label on a node
string
value of the label identified by the key
VM placement policy
string
Name of the VCD VM placement policy to use.
Sizing policy
string
Name of the VCD sizing policy to use.
Storage profile
string
Name of the VCD storage profile to use.
Template
string
Name of the template used to create the node VMs.
Organization
string
VCD organization name.
OvDC name
string
Name of the organization virtual datacenter (OvDC) to create this cluster in.
OvDC network
string
VCD network to connect VMs.
Endpoint
string
VCD endpoint URL in the format https://VCD_HOST, without trailing slash.
VCD API access token
object
Name
string
Name of the secret containing the VCD API token.
VM naming template
string
Go template to specify the VM naming convention.
Other
Management cluster name
string
The Cluster API management cluster that manages this cluster.
Cluster API provider name
string
Further reading
