Skip to main content

Control Plane

Deprecation notice

Support for K0s and K3s is deprecated in vCluster v0.25. K0s support is removed in v0.26.
Migration to a supported Kubernetes distribution is recommended.

Config reference​

controlPlane required object ​

Configure vCluster's control plane components and deployment.

endpoint required string ​

Endpoint is the endpoint of the virtual cluster. This is used to connect to the virtual cluster.

distro required object ​

Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed, with one exception: starting with vCluster 0.25.0, migration from K3s to K8s is supported. For more details, see the K3s to K8s migration guide.

k8s required object ​

K8S holds K8s relevant configuration.

enabled required boolean false ​

Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.

version required string ​

Version is the Kubernetes version to use.

apiServer required object ​

APIServer holds configuration specific to starting the api server.

enabled required boolean true ​

Enabled signals this container should be enabled.

command required string[] [] ​

Command is the command to start the distro binary. This will override the existing command.

extraArgs required string[] [] ​

ExtraArgs are additional arguments to pass to the distro binary.

controllerManager required object ​

ControllerManager holds configuration specific to starting the controller manager.

enabled required boolean true ​

Enabled signals this container should be enabled.

command required string[] [] ​

Command is the command to start the distro binary. This will override the existing command.

extraArgs required string[] [] ​

ExtraArgs are additional arguments to pass to the distro binary.

scheduler required object ​

Scheduler holds configuration specific to starting the scheduler.

enabled required boolean false ​

Enabled signals this container should be enabled.

command required string[] [] ​

Command is the command to start the distro binary. This will override the existing command.

extraArgs required string[] [] ​

ExtraArgs are additional arguments to pass to the distro binary.

image required object ​

Image is the distro image

registry required string ghcr.io ​

Registry is the registry of the container image, e.g. my-registry.com or ghcr.io. This setting can be globally overridden via the controlPlane.advanced.defaultImageRegistry option. Empty means docker hub.

repository required string loft-sh/kubernetes ​

Repository is the repository of the container image, e.g. my-repo/my-image

tag required string v1.35.0 ​

Tag is the tag of the container image, and is the default version.

imagePullPolicy required string ​

ImagePullPolicy is the pull policy for the distro image

env required object[] [] ​

Env are extra environment variables to use for the main container and NOT the init container.

resources required object map[limits:map[cpu:100m memory:256Mi] requests:map[cpu:40m memory:64Mi]] ​

Resources for the distro init container

securityContext required object {} ​

Security options can be used for the distro init container

k3s required object ​

[Deprecated] K3S holds K3s relevant configuration.

enabled required boolean false ​

Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.

token required string ​

Token is the K3s token to use. If empty, vCluster will choose one.

image required object ​

Image is the distro image

registry required string ​

Registry is the registry of the container image, e.g. my-registry.com or ghcr.io. This setting can be globally overridden via the controlPlane.advanced.defaultImageRegistry option. Empty means docker hub.

repository required string rancher/k3s ​

Repository is the repository of the container image, e.g. my-repo/my-image

tag required string v1.35.0-k3s1 ​

Tag is the tag of the container image, and is the default version.

imagePullPolicy required string ​

ImagePullPolicy is the pull policy for the distro image

env required object[] ​

Env are extra environment variables to use for the main container and NOT the init container.

resources required object map[limits:map[cpu:100m memory:256Mi] requests:map[cpu:40m memory:64Mi]] ​

Resources for the distro init container

securityContext required object {} ​

Security options can be used for the distro init container

command required string[] [] ​

Command is the command to start the distro binary. This will override the existing command.

extraArgs required string[] [] ​

ExtraArgs are additional arguments to pass to the distro binary.

standalone required object ​

Standalone holds configuration for standalone mode. Standalone mode is set automatically when no container is detected and also implies privateNodes.enabled.

enabled required boolean ​

Enabled defines if standalone mode should be enabled.

dataDir required string /var/lib/vcluster ​

DataDir defines the data directory for the standalone mode.

autoNodes required object ​

AutoNodes automatically deploys nodes for standalone mode.

provider required string ​

Provider is the node provider of the nodes in this pool.

quantity required integer ​

Quantity is the number of nodes to deploy for standalone mode.

nodeTypeSelector required object[] ​

NodeTypeSelector filters the types of nodes that can be provisioned by this pool. All requirements must be met for a node type to be eligible.

property required string ​

Property is the property on the node type to select.

operator required string ​

Operator is the comparison operator, such as "In", "NotIn", "Exists". If empty, defaults to "In".

values required string[] ​

Values is the list of values to use for comparison. This is mutually exclusive with value.

value required string ​

Value is the value to use for comparison. This is mutually exclusive with values.

joinNode required object ​

JoinNode holds configuration for the standalone control plane node.

enabled required boolean true ​

Enabled defines if the standalone node should be joined into the cluster. If false, only the control plane binaries will be executed and no node will show up in the actual cluster.

preInstallCommands required string[] ​

PreInstallCommands are commands that will be executed before containerd, kubelet etc. is installed.

preJoinCommands required string[] ​

PreJoinCommands are commands that will be executed before kubeadm join is executed.

postJoinCommands required string[] ​

PostJoinCommands are commands that will be executed after kubeadm join is executed.

containerd required object ​

Containerd holds configuration for the containerd join process.

enabled required boolean true ​

Enabled defines if containerd should be installed and configured by vCluster.

registry required object ​

Registry holds configuration for how containerd should be configured to use a registries.

configPath required string ​

ConfigPath is the path to the containerd registry config.

mirrors required {key: object} ​

Mirrors holds configuration for the containerd registry mirrors. E.g. myregistry.io:5000 or docker.io. See https://github.com/containerd/containerd/blob/main/docs/hosts.md for more details.

server required string ​

Server is the fallback server to use for the containerd registry mirror. E.g. https://registry-1.docker.io. See https://github.com/containerd/containerd/blob/main/docs/hosts.md for more details.

caCert required string[] ​

CACert are paths to CA certificates to use for the containerd registry mirror.

skipVerify required boolean ​

SkipVerify is a boolean to skip the certificate verification for the containerd registry mirror and allows http connections.

capabilities required string[] ​

Capabilities is a list of capabilities to enable for the containerd registry mirror. If empty, will use pull and resolve capabilities.

overridePath required boolean ​

OverridePath is a boolean to override the path for the containerd registry mirror.

hosts required object[] ​

Hosts holds configuration for the containerd registry mirror hosts. See https://github.com/containerd/containerd/blob/main/docs/hosts.md for more details.

server required string ​

Server is the server to use for the containerd registry mirror host. E.g. http://192.168.31.250:5000.

caCert required string[] ​

CACert are paths to CA certificates to use for the containerd registry mirror host.

skipVerify required boolean ​

SkipVerify is a boolean to skip the certificate verification for the containerd registry mirror and allows http connections.

capabilities required string[] ​

Capabilities is a list of capabilities to enable for the containerd registry mirror. If empty, will use pull and resolve capabilities.

overridePath required boolean ​

OverridePath is a boolean to override the path for the containerd registry mirror.

auth required {key: object} ​

Auth holds configuration for the containerd registry auth. See https://github.com/containerd/containerd/blob/main/docs/cri/registry.md#configure-registry-credentials for more details.

username required string ​

Username is the username for the containerd registry.

password required string ​

Password is the password for the containerd registry.

identityToken required string ​

IdentityToken is the token for the containerd registry.

auth required string ​

Auth is the auth config for the containerd registry.

pauseImage required string ​

PauseImage is the image for the pause container.

caCertPath required string ​

CACertPath is the path to the SSL certificate authority used to secure communications between node and control-plane. Defaults to "/etc/kubernetes/pki/ca.crt".

skipPhases required string[] ​

SkipPhases is a list of phases to skip during command execution. The list of phases can be obtained with the "kubeadm join --help" command.

nodeRegistration required object ​

NodeRegistration holds configuration for the node registration similar to the kubeadm node registration.

criSocket required string ​

CRI socket is the socket for the CRI.

kubeletExtraArgs required object[] ​

KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. An argument name in this list is the flag name as it appears on the command line except without leading dash(es). Extra arguments will override existing default arguments. Duplicate extra arguments are allowed.

name required string ​

Name is the name of the argument.

value required string ​

Value is the value of the argument.

taints required object[] ​

Taints are additional taints to set for the kubelet.

key required string ​

Required. The taint key to be applied to a node.

value required string ​

The taint value corresponding to the taint key.

effect required string ​

Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.

ignorePreflightErrors required string[] ​

IgnorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered, e.g. 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.

imagePullPolicy required string ​

ImagePullPolicy specifies the policy for image pulling during kubeadm "init" and "join" operations. The value of this field must be one of "Always", "IfNotPresent" or "Never". If this field is unset kubeadm will default it to "IfNotPresent", or pull the required images if not present on the host.

backingStore required object ​

BackingStore defines which backing store to use for virtual cluster. If not defined will use embedded database as a default backing store.

etcd required object ​

Etcd defines that etcd should be used as the backend for the virtual cluster

embedded required object ​

Embedded defines to use embedded etcd as a storage backend for the virtual cluster

enabled required boolean false ​

Enabled defines if the embedded etcd should be used.

migrateFromDeployedEtcd required boolean false ​

MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd.

snapshotCount required integer ​

SnapshotCount defines the number of snapshots to keep for the embedded etcd. Defaults to 10000 if less than 1.

extraArgs required string[] [] ​

ExtraArgs are additional arguments to pass to the embedded etcd.

deploy required object ​

Deploy defines to use an external etcd that is deployed by the helm chart

enabled required boolean false ​

Enabled defines that an external etcd should be deployed.

statefulSet required object ​

StatefulSet holds options for the external etcd statefulSet.

enabled required boolean true ​

Enabled defines if the statefulSet should be deployed

EnableServiceLinks for the StatefulSet pod

image required object ​

Image is the image to use for the external etcd statefulSet

registry required string registry.k8s.io ​

Registry is the registry of the container image, e.g. my-registry.com or ghcr.io. This setting can be globally overridden via the controlPlane.advanced.defaultImageRegistry option. Empty means docker hub.

repository required string etcd ​

Repository is the repository of the container image, e.g. my-repo/my-image

tag required string 3.6.4-0 ​

Tag is the tag of the container image, and is the default version.

imagePullPolicy required string ​

ImagePullPolicy is the pull policy for the external etcd image

env required object[] [] ​

Env are extra environment variables

extraArgs required string[] [] ​

ExtraArgs are appended to the etcd command.

resources required object ​

Resources the etcd can consume

limits required object ​

Limits are resource limits for the container

requests required object map[cpu:20m memory:150Mi] ​

Requests are minimal resources that will be consumed by the container

pods required object ​

Pods defines extra metadata for the etcd pods.

annotations required object {} ​

Annotations are extra annotations for this resource.

labels required object {} ​

Labels are extra labels for this resource.

highAvailability required object ​

HighAvailability are high availability options

replicas required integer 1 ​

Replicas are the amount of pods to use.

scheduling required object ​

Scheduling options for the etcd pods.

nodeSelector required object {} ​

NodeSelector is the node selector to apply to the pod.

affinity required object {} ​

Affinity is the affinity to apply to the pod.

tolerations required object[] [] ​

Tolerations are the tolerations to apply to the pod.

priorityClassName required string ​

PriorityClassName is the priority class name for the the pod.

podManagementPolicy required string Parallel ​

PodManagementPolicy is the statefulSet pod management policy.

topologySpreadConstraints required object[] [] ​

TopologySpreadConstraints are the topology spread constraints for the pod.

security required object ​

Security options for the etcd pods.

podSecurityContext required object {} ​

PodSecurityContext specifies security context options on the pod level.

containerSecurityContext required object {} ​

ContainerSecurityContext specifies security context options on the container level.

persistence required object ​

Persistence options for the etcd pods.

volumeClaim required object ​

VolumeClaim can be used to configure the persistent volume claim.

enabled required boolean true ​

Enabled enables deploying a persistent volume claim.

accessModes required string[] [ReadWriteOnce] ​

AccessModes are the persistent volume claim access modes.

retentionPolicy required string Retain ​

RetentionPolicy is the persistent volume claim retention policy.

size required string 5Gi ​

Size is the persistent volume claim storage size.

storageClass required string ​

StorageClass is the persistent volume claim storage class.

volumeClaimTemplates required object[] [] ​

VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet

addVolumes required object[] [] ​

AddVolumes defines extra volumes for the pod

addVolumeMounts required object[] ​

AddVolumeMounts defines extra volume mounts for the container

name required string ​

This must match the Name of a Volume.

readOnly required boolean ​

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

mountPath required string ​

Path within the container at which the volume should be mounted. Must not contain ':'.

subPath required string ​

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

mountPropagation required string ​

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

subPathExpr required string ​

Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

annotations required object {} ​

Annotations are extra annotations for this resource.

labels required object {} ​

Labels are extra labels for this resource.

service required object ​

Service holds options for the external etcd service.

enabled required boolean true ​

Enabled defines if the etcd service should be deployed

annotations required object {} ​

Annotations are extra annotations for the external etcd service

headlessService required object ​

HeadlessService holds options for the external etcd headless service.

annotations required object {} ​

Annotations are extra annotations for the external etcd headless service

external required object ​

External defines to use a self-hosted external etcd that is not deployed by the helm chart

enabled required boolean false ​

Enabled defines if the external etcd should be used.

endpoint required string ​

Endpoint holds the endpoint of the external etcd server, e.g. my-example-service:2379

tls required object ​

TLS defines the tls configuration for the external etcd server

caFile required string ​

CaFile is the path to the ca file

certFile required string ​

CertFile is the path to the cert file

keyFile required string ​

KeyFile is the path to the key file

database required object ​

Database defines that a database backend should be used as the backend for the virtual cluster. This uses a project called kine under the hood which is a shim for bridging Kubernetes and relational databases.

embedded required object ​

Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster

enabled required boolean false ​

Enabled defines if the database should be used.

dataSource required string ​

DataSource is the kine dataSource to use for the database. This depends on the database format. This is optional for the external database. Examples:

  • mysql: mysql://username:password@tcp(hostname:3306)/k3s
  • postgres: postgres://username:password@hostname:5432/k3s
identityProvider required string ​

IdentityProvider is the kine identity provider to use when generating temporary authentication tokens for enhanced security. This is optional for the external database. Examples:

  • aws: RDS IAM Authentication
keyFile required string ​

KeyFile is the key file to use for the database. This is optional.

certFile required string ​

CertFile is the cert file to use for the database. This is optional.

caFile required string ​

CaFile is the ca file to use for the database. This is optional.

extraArgs required string[] [] ​

ExtraArgs are additional arguments to pass to Kine.

external required object ​

External defines that an external database should be used as the backend for the virtual cluster

enabled required boolean false ​

Enabled defines if the database should be used.

dataSource required string ​

DataSource is the kine dataSource to use for the database. This depends on the database format. This is optional for the external database. Examples:

  • mysql: mysql://username:password@tcp(hostname:3306)/k3s
  • postgres: postgres://username:password@hostname:5432/k3s
identityProvider required string ​

IdentityProvider is the kine identity provider to use when generating temporary authentication tokens for enhanced security. This is optional for the external database. Examples:

  • aws: RDS IAM Authentication
keyFile required string ​

KeyFile is the key file to use for the database. This is optional.

certFile required string ​

CertFile is the cert file to use for the database. This is optional.

caFile required string ​

CaFile is the ca file to use for the database. This is optional.

extraArgs required string[] [] ​

ExtraArgs are additional arguments to pass to Kine.

connector required string ​

Connector specifies a secret located in a connected vCluster Platform that contains database server connection information to be used by Platform to create a database and database user for the vCluster. and non-privileged user. A kine endpoint should be created using the database and user on Platform registration. This is optional.

coredns required object ​

CoreDNS defines everything related to the coredns that is deployed and used within the vCluster.

enabled required boolean true ​

Enabled defines if coredns is enabled

embedded required boolean false ​

Embedded defines if vCluster will start the embedded coredns service within the control-plane and not as a separate deployment. This is a PRO feature.

security required object ​

Security defines pod or container security context.

podSecurityContext required object {} ​

PodSecurityContext specifies security context options on the pod level.

containerSecurityContext required object {} ​

ContainerSecurityContext specifies security context options on the container level.

service required object ​

Service holds extra options for the coredns service deployed within the virtual cluster

spec required object map[type:ClusterIP] ​

Spec holds extra options for the coredns service

annotations required object {} ​

Annotations are extra annotations for this resource.

labels required object {} ​

Labels are extra labels for this resource.

deployment required object ​

Deployment holds extra options for the coredns deployment deployed within the virtual cluster

image required string ​

Image is the coredns image to use

replicas required integer 1 ​

Replicas is the amount of coredns pods to run.

nodeSelector required object {} ​

NodeSelector is the node selector to use for coredns.

affinity required object {} ​

Affinity is the affinity to apply to the pod.

tolerations required object[] [] ​

Tolerations are the tolerations to apply to the pod.

resources required object ​

Resources are the desired resources for coredns.

limits required object map[cpu:1000m memory:170Mi] ​

Limits are resource limits for the container

requests required object map[cpu:20m memory:64Mi] ​

Requests are minimal resources that will be consumed by the container

pods required object ​

Pods is additional metadata for the coredns pods.

annotations required object {} ​

Annotations are extra annotations for this resource.

labels required object {} ​

Labels are extra labels for this resource.

annotations required object {} ​

Annotations are extra annotations for this resource.

labels required object {} ​

Labels are extra labels for this resource.

topologySpreadConstraints required object[] [map[labelSelector:map[matchLabels:map[k8s-app:vcluster-kube-dns]] maxSkew:1 topologyKey:kubernetes.io/hostname whenUnsatisfiable:DoNotSchedule]] ​

TopologySpreadConstraints are the topology spread constraints for the CoreDNS pod.

overwriteConfig required string ​

OverwriteConfig can be used to overwrite the coredns config

overwriteManifests required string ​

OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns

priorityClassName required string ​

PriorityClassName specifies the priority class name for the CoreDNS pods.

proxy required object ​

Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests.

bindAddress required string 0.0.0.0 ​

BindAddress under which vCluster will expose the proxy.

port required integer 8443 ​

Port under which vCluster will expose the proxy. Changing port is currently not supported.

extraSANs required string[] [] ​

ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.

hostPathMapper required object ​

HostPathMapper defines if vCluster should rewrite host paths.

enabled required boolean ​

Enabled specifies if the host path mapper will be used

central required boolean ​

Central specifies if the central host path mapper will be used

ingress required object ​

Ingress defines options for vCluster ingress deployed by Helm.

enabled required boolean false ​

Enabled defines if the control plane ingress should be enabled

host required string my-host.com ​

Host is the host where vCluster will be reachable

pathType required string ImplementationSpecific ​

PathType is the path type of the ingress

spec required object map[tls:[]] ​

Spec allows you to configure extra ingress options.

annotations required object map[nginx.ingress.kubernetes.io/backend-protocol:HTTPS nginx.ingress.kubernetes.io/ssl-passthrough:true nginx.ingress.kubernetes.io/ssl-redirect:true] ​

Annotations are extra annotations for this resource.

labels required object {} ​

Labels are extra labels for this resource.

service required object ​

Service defines options for vCluster service deployed by Helm.

enabled required boolean true ​

Enabled defines if the control plane service should be enabled

spec required object map[type:ClusterIP] ​

Spec allows you to configure extra service options.

kubeletNodePort required integer 0 ​

KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.

httpsNodePort required integer 0 ​

HTTPSNodePort is the node port where https is exposed. Defaults to 0.

annotations required object {} ​

Annotations are extra annotations for this resource.

labels required object {} ​

Labels are extra labels for this resource.

statefulSet required object ​

StatefulSet defines options for vCluster statefulSet deployed by Helm.

highAvailability required object ​

HighAvailability holds options related to high availability.

replicas required integer 1 ​

Replicas is the amount of replicas to use for the statefulSet.

leaseDuration required integer 60 ​

LeaseDuration is the time to lease for the leader.

renewDeadline required integer 40 ​

RenewDeadline is the deadline to renew a lease for the leader.

retryPeriod required integer 15 ​

RetryPeriod is the time until a replica will retry to get a lease.

resources required object ​

Resources are the resource requests and limits for the statefulSet container.

limits required object map[ephemeral-storage:10Gi memory:4Gi] ​

Limits are resource limits for the container

requests required object map[cpu:200m ephemeral-storage:1Gi memory:256Mi] ​

Requests are minimal resources that will be consumed by the container

scheduling required object ​

Scheduling holds options related to scheduling.

nodeSelector required object {} ​

NodeSelector is the node selector to apply to the pod.

affinity required object {} ​

Affinity is the affinity to apply to the pod.

tolerations required object[] [] ​

Tolerations are the tolerations to apply to the pod.

priorityClassName required string ​

PriorityClassName is the priority class name for the the pod.

podManagementPolicy required string Parallel ​

PodManagementPolicy is the statefulSet pod management policy.

topologySpreadConstraints required object[] [] ​

TopologySpreadConstraints are the topology spread constraints for the pod.

security required object ​

Security defines pod or container security context.

podSecurityContext required object {} ​

PodSecurityContext specifies security context options on the pod level.

containerSecurityContext required object map[allowPrivilegeEscalation:false runAsGroup:0 runAsUser:0] ​

ContainerSecurityContext specifies security context options on the container level.

probes required object ​

Probes enables or disables the main container probes.

livenessProbe required object ​

LivenessProbe specifies if the liveness probe for the container should be enabled

enabled required boolean true ​

Enabled defines if this option should be enabled.

failureThreshold required integer 60 ​

Number of consecutive failures for the probe to be considered failed

initialDelaySeconds required integer 60 ​

Time (in seconds) to wait before starting the liveness probe

timeoutSeconds required integer 3 ​

Maximum duration (in seconds) that the probe will wait for a response.

periodSeconds required integer 2 ​

Frequency (in seconds) to perform the probe

readinessProbe required object ​

ReadinessProbe specifies if the readiness probe for the container should be enabled

enabled required boolean true ​

Enabled defines if this option should be enabled.

failureThreshold required integer 60 ​

Number of consecutive failures for the probe to be considered failed

timeoutSeconds required integer 3 ​

Maximum duration (in seconds) that the probe will wait for a response.

periodSeconds required integer 2 ​

Frequency (in seconds) to perform the probe

startupProbe required object ​

StartupProbe specifies if the startup probe for the container should be enabled

enabled required boolean true ​

Enabled defines if this option should be enabled.

failureThreshold required integer 300 ​

Number of consecutive failures allowed before failing the pod

timeoutSeconds required integer 3 ​

Maximum duration (in seconds) that the probe will wait for a response.

periodSeconds required integer 6 ​

Frequency (in seconds) to perform the probe

persistence required object ​

Persistence defines options around persistence for the statefulSet.

volumeClaim required object ​

VolumeClaim can be used to configure the persistent volume claim.

enabled required string|boolean auto ​

Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine based on the chosen distro and other options if this is required.

accessModes required string[] [ReadWriteOnce] ​

AccessModes are the persistent volume claim access modes.

retentionPolicy required string Retain ​

RetentionPolicy is the persistent volume claim retention policy.

size required string 5Gi ​

Size is the persistent volume claim storage size.

storageClass required string ​

StorageClass is the persistent volume claim storage class.

volumeClaimTemplates required object[] [] ​

VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet

dataVolume required object[] [] ​

Allows you to override the dataVolume. Only works correctly if volumeClaim.enabled=false.

binariesVolume required object[] [map[emptyDir:map[] name:binaries]] ​

BinariesVolume defines a binaries volume that is used to retrieve distro specific executables to be run by the syncer controller. This volume doesn't need to be persistent.

addVolumes required object[] [] ​

AddVolumes defines extra volumes for the pod

addVolumeMounts required object[] ​

AddVolumeMounts defines extra volume mounts for the container

name required string ​

This must match the Name of a Volume.

readOnly required boolean ​

Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

mountPath required string ​

Path within the container at which the volume should be mounted. Must not contain ':'.

subPath required string ​

Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

mountPropagation required string ​

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

subPathExpr required string ​

Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.

EnableServiceLinks for the StatefulSet pod

annotations required object {} ​

Annotations are extra annotations for this resource.

labels required object {} ​

Labels are extra labels for this resource.

pods required object ​

Additional labels or annotations for the statefulSet pods.

annotations required object {} ​

Annotations are extra annotations for this resource.

labels required object {} ​

Labels are extra labels for this resource.

image required object ​

Image is the image for the controlPlane statefulSet container It defaults to the vCluster pro repository that includes the optional pro modules that are turned off by default. If you still want to use the pure OSS build, set the repository to 'loft-sh/vcluster-oss'.

registry required string ghcr.io ​

Registry is the registry of the container image, e.g. my-registry.com or ghcr.io. This setting can be globally overridden via the controlPlane.advanced.defaultImageRegistry option. Empty means docker hub.

repository required string loft-sh/vcluster-pro ​

Repository is the repository of the container image, e.g. my-repo/my-image

tag required string ​

Tag is the tag of the container image, and is the default version.

imagePullPolicy required string ​

ImagePullPolicy is the policy how to pull the image.

workingDir required string ​

WorkingDir specifies in what folder the main process should get started.

command required string[] [] ​

Command allows you to override the main command.

args required string[] [] ​

Args allows you to override the main arguments.

env required object[] [] ​

Env are additional environment variables for the statefulSet container.

dnsPolicy required string ​

Set DNS policy for the pod.

dnsConfig required object ​

Specifies the DNS parameters of a pod.

nameservers required string[] ​

A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

searches required string[] ​

A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

options required object[] ​

A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.

name required string ​

Required.

value required string ​

initContainers required object[] [] ​

InitContainers are additional init containers for the statefulSet.

sidecarContainers required object[] [] ​

SidecarContainers are additional sidecar containers for the statefulSet.

hostAliases required object[] ​

HostAliases allows you to add custom entries to the /etc/hosts file of each Pod created.

ip required string ​
hostnames required string[] ​

serviceMonitor required object ​

ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself.

enabled required boolean false ​

Enabled configures if Helm should create the service monitor.

labels required object {} ​

Labels are the extra labels to add to the service monitor.

annotations required object {} ​

Annotations are the extra annotations to add to the service monitor.

advanced required object ​

Advanced holds additional configuration for the vCluster control plane.

defaultImageRegistry required string ​

DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to upload all required vCluster images to a single private repository and set this value. Workload images are not affected by this.

virtualScheduler required object ​

VirtualScheduler defines if a scheduler should be used within the virtual cluster or the scheduling decision for workloads will be made by the host cluster. Deprecated: Use ControlPlane.Distro.K8S.Scheduler instead.

enabled required boolean false ​

Enabled defines if this option should be enabled.

serviceAccount required object ​

ServiceAccount specifies options for the vCluster control plane service account.

enabled required boolean true ​

Enabled specifies if the service account should get deployed.

name required string ​

Name specifies what name to use for the service account.

imagePullSecrets required object[] ​

ImagePullSecrets defines extra image pull secrets for the service account.

name required string ​

Name of the image pull secret to use.

annotations required object {} ​

Annotations are extra annotations for this resource.

labels required object {} ​

Labels are extra labels for this resource.

workloadServiceAccount required object ​

WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster.

enabled required boolean true ​

Enabled specifies if the service account for the workloads should get deployed.

name required string ​

Name specifies what name to use for the service account for the virtual cluster workloads.

imagePullSecrets required object[] ​

ImagePullSecrets defines extra image pull secrets for the workload service account.

name required string ​

Name of the image pull secret to use.

annotations required object {} ​

Annotations are extra annotations for this resource.

labels required object {} ​

Labels are extra labels for this resource.

headlessService required object ​

HeadlessService specifies options for the headless service used for the vCluster StatefulSet.

annotations required object {} ​

Annotations are extra annotations for this resource.

labels required object {} ​

Labels are extra labels for this resource.

konnectivity required object ​

Konnectivity holds dedicated konnectivity configuration. This is only available when privateNodes.enabled is true.

server required object ​

Server holds configuration for the konnectivity server.

enabled required boolean true ​

Enabled defines if the konnectivity server should be enabled.

extraArgs required string[] [] ​

ExtraArgs are additional arguments to pass to the konnectivity server.

agent required object ​

Agent holds configuration for the konnectivity agent.

enabled required boolean true ​

Enabled defines if the konnectivity agent should be enabled.

replicas required integer 1 ​

Replicas is the number of replicas for the konnectivity agent.

image required string ​

Image is the image for the konnectivity agent.

imagePullPolicy required string ​

ImagePullPolicy is the policy how to pull the image.

nodeSelector required object {} ​

NodeSelector is the node selector for the konnectivity agent.

priorityClassName required string ​

PriorityClassName is the priority class name for the konnectivity agent.

tolerations required object[] [] ​

Tolerations is the tolerations for the konnectivity agent.

extraEnv required object[] [] ​

ExtraEnv is the extra environment variables for the konnectivity agent.

extraArgs required string[] [] ​

ExtraArgs are additional arguments to pass to the konnectivity agent.

registry required object ​

Registry allows enabling an embedded docker image registry in vCluster. This is useful for air-gapped environments or when you don't have a public registry available to distribute images.

enabled required boolean false ​

Enabled defines if the embedded registry should be enabled.

anonymousPull required boolean true ​

AnonymousPull allows enabling anonymous pull for the embedded registry. This allows anybody to pull images from the registry without authentication.

config required object {} ​

Config is the regular docker registry config. See https://distribution.github.io/distribution/about/configuration/ for more details.

cloudControllerManager required object ​

CloudControllerManager holds configuration for the embedded cloud controller manager. This is only available when private nodes are enabled. The cloud controller manager is responsible for setting the node's ip addresses as well as the provider id for the node and other node metadata.

enabled required boolean true ​

Enabled defines if the embedded cloud controller manager should be enabled. This defaults to true, but can be disabled if you want to use an external cloud controller manager such as AWS or GCP. The cloud controller manager is responsible for setting the node's ip addresses as well as the provider id for the node and other node metadata.

globalMetadata required object ​

GlobalMetadata is metadata that will be added to all resources deployed by Helm.

annotations required object {} ​

Annotations are extra annotations for this resource.

kubeVip required object ​

KubeVip holds configuration for embedded kube-vip that announces the virtual cluster endpoint IP on layer 2.

enabled required boolean false ​

Enabled defines if embedded kube-vip should be enabled.

interface required string ​

Interface is the network interface on which the VIP is announced.

gateway required string ​

Gateway is the gateway address in CIDR notation (e.g., 10.100.0.1/24). This is used to configure policy-based routing for the VIP and must include the subnet prefix.

podDisruptionBudget required object ​

PodDisruptionBudget limits how many pods of an application can be voluntarily disrupted at once to ensure availability during maintenance or scaling operations.

enabled required boolean false ​

Enabled defines if the pod disruption budget should be enabled.

minAvailable required object ​

MinAvailable describes the minimal number or percentage of available pods.

maxUnavailable required object ​

MaxUnavailable describes the minimal number or percentage of unavailable pods.

unhealthyPodEvictionPolicy required string ​

UnhealthyPodEvictionPolicy defines the criteria when unhealthy pods should be considered for eviction. Currently supported values are:

  • IfHealthyBudget - pods that are in the Running phase but not yet healthy are considered disrupted and may be evicted even if the PodDisruptionBudget criteria are not met.
  • AlwaysAllow - pods that are in the Running phase but not yet healthy are considered disrupted and can be evicted regardless of whether the criteria in a PDB is met.