Skip to content

Latest commit

 

History

History
978 lines (973 loc) · 39 KB

cluster-vsphere.md

File metadata and controls

978 lines (973 loc) · 39 KB
title linkTitle description weight menu layout user_questions owner source_repository source_repository_ref
cluster-vsphere chart reference
cluster-vsphere
A helm chart for creating Cluster API clusters with the vSphere provider (CAPV).; Check here the different properties of the chart.
100
principal
identifier parent
cluster-vsphere
reference-cluster-apps
cluster-app
What properties can I configure for cluster-vsphere?
v0.9.8

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

Chart Configuration Reference

.internal.sandboxContainerImage

Sandbox Container image
object 

.internal.sandboxContainerImage.name

Repository
string 

.internal.sandboxContainerImage.registry

Registry
string 

.internal.sandboxContainerImage.tag

Tag
string 

.internal.teleport

Teleport
object 

.internal.teleport.enabled

Enable teleport
boolean 

.internal.teleport.proxyAddr

Teleport proxy address
string 

.internal.teleport.version

Teleport version
string 

Cluster

.cluster.kubernetesVersion

Kubernetes version
string 

Connectivity

.connectivity.network

Network
object 

.connectivity.network.allowAllEgress

Allow all egress
boolean 

.connectivity.network.containerRegistries

Container registries
object 
Endpoints and credentials configuration for container registries.

.connectivity.network.containerRegistries.*

array 

.connectivity.network.containerRegistries.*[*]

object 

.connectivity.network.containerRegistries.*[*].credentials

Credentials
object 
Credentials for the endpoint.

.connectivity.network.containerRegistries.*[*].credentials.auth

Auth
string 
Base64-encoded string from the concatenation of the username, a colon, and the password.

.connectivity.network.containerRegistries.*[*].credentials.identitytoken

Identity token
string 
Used to authenticate the user and obtain an access token for the registry.

.connectivity.network.containerRegistries.*[*].credentials.password

Password
string 
Used to authenticate for the registry with username/password.

.connectivity.network.containerRegistries.*[*].credentials.username

Username
string 
Used to authenticate for the registry with username/password.

.connectivity.network.containerRegistries.*[*].endpoint

Endpoint
string 
Endpoint for the container registry.

.connectivity.network.controlPlaneEndpoint

Endpoint
object 
Kubernetes API configuration.

.connectivity.network.controlPlaneEndpoint.host

Host
string 
IP for access to the Kubernetes API.

.connectivity.network.controlPlaneEndpoint.ipPoolName

Ip Pool Name
string 
Ip for control plane will be drawn from this GlobalInClusterIPPool resource.

.connectivity.network.controlPlaneEndpoint.port

Port number
integer 
Port for access to the Kubernetes API.

.connectivity.network.loadBalancers

Load balancers
object 

.connectivity.network.pods

Pods
object 

.connectivity.network.pods.cidrBlocks

array 

.connectivity.network.pods.cidrBlocks[*]

string 
IPv4 address range, in CIDR notation.

.connectivity.network.services

Services
object 

.connectivity.network.services.cidrBlocks

array 

.connectivity.network.services.cidrBlocks[*]

string 
IPv4 address range, in CIDR notation.

Control plane

.controlPlane.etcd

Etcd
object 

.controlPlane.etcd.imageRepository

Image repository
string 

.controlPlane.etcd.imageTag

Image tag
string 

.controlPlane.replicas

Number of nodes
integer 

Kubeadm

.kubeadm.users

Users
array 

.kubeadm.users[*]

object 

.kubeadm.users[*].authorizedKeys

Authorized keys
array 

.kubeadm.users[*].authorizedKeys[*]

Key
string 

.kubeadm.users[*].name

Name
string 

Kubectl image

Used by cluster-shared library chart to configure coredns in-cluster.

.kubectlImage.name

string 

.kubectlImage.registry

string 

.kubectlImage.tag

string 

Kubernetes API server

.apiServer.certSANs

Subject alternative names (SAN)
array 
Alternative names to encode in the API server's certificate.

.apiServer.certSANs[*]

SAN
string 

.apiServer.enableAdmissionPlugins

Admission plugins
string 
Comma-separated list of admission plugins to enable.

.apiServer.featureGates

Feature gates
string 
Enabled feature gates, as a comma-separated list.

Kubernetes Controller Manager

.controllerManager.featureGates

Feature gates
string 
Enabled feature gates, as a comma-separated list.

Node template

Provisioning options for node templates.

.template.cloneMode

Clone mode
string 
Method used to clone template image.

.template.diskGiB

Disk size (GB)
integer 
Node disk size in GB. Must be at least as large as the source image.

.template.folder

Folder
string 
VSphere folder to deploy instances in. Must already exist.

.template.memoryMiB

Memory (MB)
integer 
Node memory allocation in MB.

.template.networkName

Segment name
string 
Segment name to attach nodes to. Must already exist.

.template.numCPUs

CPU cores
integer 
Number of CPUs to assign per node.

.template.resourcePool

Resource pool
string 
Resource pool to allocate nodes from. Must already exist.

.template.storagePolicyName

Storage policy
string 
Storage policy to use. If specified, it must already exist.

.template.templateName

Name
string 
Image template name to use for nodes.

VCenter

Configuration for vSphere API access.

.vcenter.datacenter

Datacenter
string 
Name of the datacenter to deploy nodes into.

.vcenter.datastore

Datastore
string 
Name of the datastore for node disk storage.

.vcenter.password

Password
string 
Password for the VSphere API.

.vcenter.region

Region
string 
Category name in VSphere for topology.kubernetes.io/region labels.

.vcenter.server

Server
string 
URL of the VSphere API.

.vcenter.thumbprint

Thumbprint
string 
TLS certificate signature of the VSphere API.

.vcenter.username

Username
string 
Username for the VSphere API.

.vcenter.zone

Zone
string 
Category name in VSphere for topology.kubernetes.io/zone labels.

Worker

.worker.replicas

Number of nodes
integer 

Other

.organization

Organization
string 

Further reading