Control Plane
Config reference​
controlPlane
required object pro​
Configure vCluster's control plane components and deployment.
controlPlane
required object pro​distro
required object pro​
Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed.
distro
required object pro​k8s
required object pro​
K8S holds K8s relevant configuration.
k8s
required object pro​enabled
required boolean false pro​
Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time.
enabled
required boolean false pro​version
required string pro​
Version specifies k8s components (scheduler, kube-controller-manager & apiserver) version.
It is a shortcut for controlPlane.distro.k8s.apiServer.image.tag,
controlPlane.distro.k8s.controllerManager.image.tag and
controlPlane.distro.k8s.scheduler.image.tag
If e.g. controlPlane.distro.k8s.version is set to v1.30.1 and
controlPlane.distro.k8s.scheduler.image.tag
(or controlPlane.distro.k8s.controllerManager.image.tag or controlPlane.distro.k8s.apiServer.image.tag)
is set to v1.31.0,
value from controlPlane.distro.k8s.(controlPlane-component).image.tag will be used
(where (controlPlane-component is apiServer, controllerManager and scheduler).
version
required string pro​apiServer
required object pro​
APIServer holds configuration specific to starting the api server.
apiServer
required object pro​enabled
required boolean true pro​
Enabled signals this container should be enabled.
enabled
required boolean true pro​image
required object pro​
Image is the distro image
image
required object pro​registry
required string registry.k8s.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.
registry
required string registry.k8s.io pro​repository
required string kube-apiserver pro​
Repository is the repository of the container image, e.g. my-repo/my-image
repository
required string kube-apiserver pro​tag
required string v1.30.2 pro​
Tag is the tag of the container image, e.g. latest
tag
required string v1.30.2 pro​imagePullPolicy
required string pro​
ImagePullPolicy is the pull policy for the distro image
imagePullPolicy
required string pro​command
required string[] [] pro​
Command is the command to start the distro binary. This will override the existing command.
command
required string[] [] pro​extraArgs
required string[] [] pro​
ExtraArgs are additional arguments to pass to the distro binary.
extraArgs
required string[] [] pro​controllerManager
required object pro​
ControllerManager holds configuration specific to starting the controller manager.
controllerManager
required object pro​enabled
required boolean true pro​
Enabled signals this container should be enabled.
enabled
required boolean true pro​image
required object pro​
Image is the distro image
image
required object pro​registry
required string registry.k8s.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.
registry
required string registry.k8s.io pro​repository
required string kube-controller-manager pro​
Repository is the repository of the container image, e.g. my-repo/my-image
repository
required string kube-controller-manager pro​tag
required string v1.30.2 pro​
Tag is the tag of the container image, e.g. latest
tag
required string v1.30.2 pro​imagePullPolicy
required string pro​
ImagePullPolicy is the pull policy for the distro image
imagePullPolicy
required string pro​command
required string[] [] pro​
Command is the command to start the distro binary. This will override the existing command.
command
required string[] [] pro​extraArgs
required string[] [] pro​
ExtraArgs are additional arguments to pass to the distro binary.
extraArgs
required string[] [] pro​scheduler
required object pro​
Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled
scheduler
required object pro​image
required object pro​
Image is the distro image
image
required object pro​registry
required string registry.k8s.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.
registry
required string registry.k8s.io pro​repository
required string kube-scheduler pro​
Repository is the repository of the container image, e.g. my-repo/my-image
repository
required string kube-scheduler pro​tag
required string v1.30.2 pro​
Tag is the tag of the container image, e.g. latest
tag
required string v1.30.2 pro​imagePullPolicy
required string pro​
ImagePullPolicy is the pull policy for the distro image
imagePullPolicy
required string pro​