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 pro

Configure vCluster's control plane components and deployment.

endpoint required string pro

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

distro required object pro

Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed.

k8s required object pro

K8S holds K8s relevant configuration.

enabled required boolean false pro

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

version required string pro

[Deprecated] Version field is deprecated. Use controlPlane.distro.k8s.image.tag to specify the Kubernetes version instead.

apiServer required object pro

APIServer holds configuration specific to starting the api server.

enabled required boolean true pro

Enabled signals this container should be enabled.

command required string[] [] pro

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

extraArgs required string[] [] pro

ExtraArgs are additional arguments to pass to the distro binary.

controllerManager required object pro

ControllerManager holds configuration specific to starting the controller manager.

enabled required boolean true pro

Enabled signals this container should be enabled.

command required string[] [] pro

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

extraArgs required string[] [] pro

ExtraArgs are additional arguments to pass to the distro binary.

scheduler required object pro

Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled

enabled required boolean false pro

Enabled signals this container should be enabled.

command required string[] [] pro

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

extraArgs required string[] [] pro

ExtraArgs are additional arguments to pass to the distro binary.

image required object pro

Image is the distro image

registry required string ghcr.io pro

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 pro

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

tag required string v1.32.1 pro

Tag is the tag of the container image, e.g. latest. If set to the default, it will use the host Kubernetes version.

imagePullPolicy required string pro

ImagePullPolicy is the pull policy for the distro image

env required object[] [] pro

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]] pro

Resources for the distro init container

securityContext required object {} pro

Security options can be used for the distro init container

k3s required object pro

[Deprecated] K3S holds K3s relevant configuration.

enabled required boolean false pro

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

token required string pro

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

image required object pro

Image is the distro image

registry required string pro

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 pro

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

tag required string v1.32.1-k3s1 pro

Tag is the tag of the container image, e.g. latest. If set to the default, it will use the host Kubernetes version.

imagePullPolicy required string pro

ImagePullPolicy is the pull policy for the distro image

env required object[] pro

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]] pro

Resources for the distro init container

securityContext required object {} pro

Security options can be used for the distro init container

command required string[] [] pro

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

extraArgs required string[] [] pro

ExtraArgs are additional arguments to pass to the distro binary.