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.31.1 pro​
Tag is the tag of the container image, e.g. latest
tag
required string v1.31.1 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.31.1 pro​
Tag is the tag of the container image, e.g. latest
tag
required string v1.31.1 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.31.1 pro​
Tag is the tag of the container image, e.g. latest
tag
required string v1.31.1 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​env
required object[] [] pro​
Env are extra environment variables to use for the main container and NOT the init container.
env
required object[] [] pro​resources
required object map[limits:map[cpu:100m memory:256Mi] requests:map[cpu:40m memory:64Mi]] pro​
Resources for the distro init container
resources
required object map[limits:map[cpu:100m memory:256Mi] requests:map[cpu:40m memory:64Mi]] pro​securityContext
required object {} pro​
Security options can be used for the distro init container
securityContext
required object {} pro​k3s
required object pro​
K3S holds K3s relevant configuration.
k3s
required object pro​enabled
required boolean false pro​
Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time.
enabled
required boolean false pro​token
required string pro​
Token is the K3s token to use. If empty, vCluster will choose one.
token
required string pro​env
required object[] pro​
Env are extra environment variables to use for the main container and NOT the init container.
env
required object[] pro​resources
required object map[limits:map[cpu:100m memory:256Mi] requests:map[cpu:40m memory:64Mi]] pro​
Resources for the distro init container
resources
required object map[limits:map[cpu:100m memory:256Mi] requests:map[cpu:40m memory:64Mi]] pro​securityContext
required object {} pro​
Security options can be used for the distro init container
securityContext
required object {} pro​image
required object pro​
Image is the distro image
image
required object pro​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.
registry
required string pro​repository
required string rancher/k3s pro​
Repository is the repository of the container image, e.g. my-repo/my-image
repository
required string rancher/k3s pro​tag
required string v1.31.1-k3s1 pro​
Tag is the tag of the container image, e.g. latest
tag
required string v1.31.1-k3s1 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​k0s
required object pro​
K0S holds k0s relevant configuration.
k0s
required object pro​enabled
required boolean false pro​
Enabled specifies if the k0s distro should be enabled. Only one distro can be enabled at the same time.
enabled
required boolean false pro​config
required string pro​
Config allows you to override the k0s config passed to the k0s binary.
config
required string pro​env
required object[] pro​
Env are extra environment variables to use for the main container and NOT the init container.
env
required object[] pro​resources
required object map[limits:map[cpu:100m memory:256Mi] requests:map[cpu:40m memory:64Mi]] pro​
Resources for the distro init container
resources
required object map[limits:map[cpu:100m memory:256Mi] requests:map[cpu:40m memory:64Mi]] pro​securityContext
required object {} pro​
Security options can be used for the distro init container
securityContext
required object {} pro​image
required object pro​
Image is the distro image
image
required object pro​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.
registry
required string pro​repository
required string k0sproject/k0s pro​
Repository is the repository of the container image, e.g. my-repo/my-image
repository
required string k0sproject/k0s pro​tag
required string v1.30.2-k0s.0 pro​
Tag is the tag of the container image, e.g. latest
tag
required string v1.30.2-k0s.0 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​backingStore
required object pro​
BackingStore defines which backing store to use for virtual cluster. If not defined will use embedded database as a default backing store.
backingStore
required object pro​etcd
required object pro​
Etcd defines that etcd should be used as the backend for the virtual cluster
etcd
required object pro​embedded
required object pro​
Embedded defines to use embedded etcd as a storage backend for the virtual cluster
embedded
required object pro​deploy
required object pro​
Deploy defines to use an external etcd that is deployed by the helm chart
deploy
required object pro​enabled
required boolean false pro​
Enabled defines that an external etcd should be deployed.
enabled
required boolean false pro​statefulSet
required object pro​
StatefulSet holds options for the external etcd statefulSet.
statefulSet
required object pro​enabled
required boolean true pro​
Enabled defines if the statefulSet should be deployed
enabled
required boolean true pro​enableServiceLinks
required boolean true pro​
EnableServiceLinks for the StatefulSet pod
enableServiceLinks
required boolean true pro​image
required object pro​
Image is the image to use for the external etcd statefulSet
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 etcd pro​
Repository is the repository of the container image, e.g. my-repo/my-image
repository
required string etcd pro​tag
required string 3.5.15-0 pro​
Tag is the tag of the container image, e.g. latest
tag
required string 3.5.15-0 pro​imagePullPolicy
required string pro​
ImagePullPolicy is the pull policy for the external etcd image
imagePullPolicy
required string pro​env
required object[] [] pro​
Env are extra environment variables
env
required object[] [] pro​extraArgs
required string[] [] pro​
ExtraArgs are appended to the etcd command.
extraArgs
required string[] [] pro​resources
required object pro​
Resources the etcd can consume
resources
required object pro​pods
required object pro​
Pods defines extra metadata for the etcd pods.
pods
required object pro​highAvailability
required object pro​
HighAvailability are high availability options
highAvailability
required object pro​replicas
required integer 1 pro​
Replicas are the amount of pods to use.
replicas
required integer 1 pro​scheduling
required object pro​
Scheduling options for the etcd pods.
scheduling
required object pro​nodeSelector
required object {} pro​
NodeSelector is the node selector to apply to the pod.
nodeSelector
required object {} pro​affinity
required object {} pro​
Affinity is the affinity to apply to the pod.
affinity
required object {} pro​tolerations
required object[] [] pro​
Tolerations are the tolerations to apply to the pod.
tolerations
required object[] [] pro​priorityClassName
required string pro​
PriorityClassName is the priority class name for the the pod.
priorityClassName
required string pro​podManagementPolicy
required string Parallel pro​
PodManagementPolicy is the statefulSet pod management policy.
podManagementPolicy
required string Parallel pro​topologySpreadConstraints
required object[] [] pro​
TopologySpreadConstraints are the topology spread constraints for the pod.
topologySpreadConstraints
required object[] [] pro​security
required object pro​
Security options for the etcd pods.
security
required object pro​persistence
required object pro​
Persistence options for the etcd pods.
persistence
required object pro​volumeClaim
required object pro​
VolumeClaim can be used to configure the persistent volume claim.
volumeClaim
required object pro​enabled
required boolean true pro​
Enabled enables deploying a persistent volume claim.
enabled
required boolean true pro​accessModes
required string[] [ReadWriteOnce] pro​
AccessModes are the persistent volume claim access modes.
accessModes
required string[] [ReadWriteOnce] pro​retentionPolicy
required string Retain pro​
RetentionPolicy is the persistent volume claim retention policy.
retentionPolicy
required string Retain pro​size
required string 5Gi pro​
Size is the persistent volume claim storage size.
size
required string 5Gi pro​storageClass
required string pro​
StorageClass is the persistent volume claim storage class.
storageClass
required string pro​volumeClaimTemplates
required object[] [] pro​
VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet
volumeClaimTemplates
required object[] [] pro​addVolumes
required object[] [] pro​
AddVolumes defines extra volumes for the pod
addVolumes
required object[] [] pro​addVolumeMounts
required object[] pro​
AddVolumeMounts defines extra volume mounts for the container
addVolumeMounts
required object[] pro​name
required string pro​
This must match the Name of a Volume.
name
required string pro​readOnly
required boolean pro​
Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
readOnly
required boolean pro​mountPath
required string pro​
Path within the container at which the volume should be mounted. Must
not contain ':'.
mountPath
required string pro​subPath
required string pro​
Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
subPath
required string pro​mountPropagation
required string pro​
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.
mountPropagation
required string pro​subPathExpr
required string pro​
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.
subPathExpr
required string pro​annotations
required object {} pro​
Annotations are extra annotations for this resource.
annotations
required object {} pro​labels
required object {} pro​
Labels are extra labels for this resource.
labels
required object {} pro​service
required object pro​
Service holds options for the external etcd service.
service
required object pro​database
required object pro​
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.
database
required object pro​embedded
required object pro​
Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster
embedded
required object pro​enabled
required boolean false pro​
Enabled defines if the database should be used.
enabled
required boolean false pro​dataSource
required string pro​
DataSource is the kine dataSource to use for the database. This depends on the database format.
This is optional for the embedded database. Examples:
- mysql: mysql://username:password@tcp(hostname:3306)/k3s
- postgres: postgres://username:password@hostname:5432/k3s
dataSource
required string pro​keyFile
required string pro​
KeyFile is the key file to use for the database. This is optional.
keyFile
required string pro​certFile
required string pro​
CertFile is the cert file to use for the database. This is optional.
certFile
required string pro​caFile
required string pro​
CaFile is the ca file to use for the database. This is optional.
caFile
required string pro​external
required object pro​
External defines that an external database should be used as the backend for the virtual cluster
external
required object pro​enabled
required boolean false pro​
Enabled defines if the database should be used.
enabled
required boolean false pro​dataSource
required string pro​
DataSource is the kine dataSource to use for the database. This depends on the database format.
This is optional for the embedded database. Examples:
- mysql: mysql://username:password@tcp(hostname:3306)/k3s
- postgres: postgres://username:password@hostname:5432/k3s
dataSource
required string pro​keyFile
required string pro​
KeyFile is the key file to use for the database. This is optional.
keyFile
required string pro​certFile
required string pro​
CertFile is the cert file to use for the database. This is optional.
certFile
required string pro​caFile
required string pro​
CaFile is the ca file to use for the database. This is optional.
caFile
required string pro​connector
required string pro​
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.
connector
required string pro​coredns
required object pro​
CoreDNS defines everything related to the coredns that is deployed and used within the vCluster.
coredns
required object pro​enabled
required boolean true pro​
Enabled defines if coredns is enabled
enabled
required boolean true pro​embedded
required boolean false pro​
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.
embedded
required boolean false pro​service
required object pro​
Service holds extra options for the coredns service deployed within the virtual cluster
service
required object pro​deployment
required object pro​
Deployment holds extra options for the coredns deployment deployed within the virtual cluster
deployment
required object pro​image
required string pro​
Image is the coredns image to use
image
required string pro​replicas
required integer 1 pro​
Replicas is the amount of coredns pods to run.
replicas
required integer 1 pro​nodeSelector
required object {} pro​
NodeSelector is the node selector to use for coredns.
nodeSelector
required object {} pro​affinity
required object {} pro​
Affinity is the affinity to apply to the pod.
affinity
required object {} pro​tolerations
required object[] [] pro​
Tolerations are the tolerations to apply to the pod.
tolerations
required object[] [] pro​resources
required object pro​
Resources are the desired resources for coredns.
resources
required object pro​pods
required object pro​
Pods is additional metadata for the coredns pods.
pods
required object pro​annotations
required object {} pro​
Annotations are extra annotations for this resource.
annotations
required object {} pro​labels
required object {} pro​
Labels are extra labels for this resource.
labels
required object {} pro​topologySpreadConstraints
required object[] [map[labelSelector:map[matchLabels:map[k8s-app:vcluster-kube-dns]] maxSkew:1 topologyKey:kubernetes.io/hostname whenUnsatisfiable:DoNotSchedule]] pro​
TopologySpreadConstraints are the topology spread constraints for the CoreDNS pod.
topologySpreadConstraints
required object[] [map[labelSelector:map[matchLabels:map[k8s-app:vcluster-kube-dns]] maxSkew:1 topologyKey:kubernetes.io/hostname whenUnsatisfiable:DoNotSchedule]] pro​overwriteConfig
required string pro​
OverwriteConfig can be used to overwrite the coredns config
overwriteConfig
required string pro​overwriteManifests
required string pro​
OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns
overwriteManifests
required string pro​priorityClassName
required string pro​
PriorityClassName specifies the priority class name for the CoreDNS pods.
priorityClassName
required string pro​proxy
required object pro​
Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests.
proxy
required object pro​bindAddress
required string 0.0.0.0 pro​
BindAddress under which vCluster will expose the proxy.
bindAddress
required string 0.0.0.0 pro​port
required integer 8443 pro​
Port under which vCluster will expose the proxy. Changing port is currently not supported.
port
required integer 8443 pro​extraSANs
required string[] [] pro​
ExtraSANs are extra hostnames to sign the vCluster proxy certificate for.
extraSANs
required string[] [] pro​hostPathMapper
required object pro​
HostPathMapper defines if vCluster should rewrite host paths.
hostPathMapper
required object pro​ingress
required object pro​
Ingress defines options for vCluster ingress deployed by Helm.
ingress
required object pro​enabled
required boolean false pro​
Enabled defines if the control plane ingress should be enabled
enabled
required boolean false pro​host
required string my-host.com pro​
Host is the host where vCluster will be reachable
host
required string my-host.com pro​pathType
required string ImplementationSpecific pro​
PathType is the path type of the ingress
pathType
required string ImplementationSpecific pro​spec
required object map[tls:[]] pro​
Spec allows you to configure extra ingress options.
spec
required object map[tls:[]] pro​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] pro​
Annotations are extra annotations for this resource.
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] pro​labels
required object {} pro​
Labels are extra labels for this resource.
labels
required object {} pro​service
required object pro​
Service defines options for vCluster service deployed by Helm.
service
required object pro​enabled
required boolean true pro​
Enabled defines if the control plane service should be enabled
enabled
required boolean true pro​spec
required object map[type:ClusterIP] pro​
Spec allows you to configure extra service options.
spec
required object map[type:ClusterIP] pro​kubeletNodePort
required integer 0 pro​
KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0.
kubeletNodePort
required integer 0 pro​httpsNodePort
required integer 0 pro​
HTTPSNodePort is the node port where https is exposed. Defaults to 0.
httpsNodePort
required integer 0 pro​annotations
required object {} pro​
Annotations are extra annotations for this resource.
annotations
required object {} pro​labels
required object {} pro​
Labels are extra labels for this resource.
labels
required object {} pro​statefulSet
required object pro​
StatefulSet defines options for vCluster statefulSet deployed by Helm.
statefulSet
required object pro​highAvailability
required object pro​
HighAvailability holds options related to high availability.
highAvailability
required object pro​replicas
required integer 1 pro​
Replicas is the amount of replicas to use for the statefulSet.
replicas
required integer 1 pro​leaseDuration
required integer 60 pro​
LeaseDuration is the time to lease for the leader.
leaseDuration
required integer 60 pro​renewDeadline
required integer 40 pro​
RenewDeadline is the deadline to renew a lease for the leader.
renewDeadline
required integer 40 pro​retryPeriod
required integer 15 pro​
RetryPeriod is the time until a replica will retry to get a lease.
retryPeriod
required integer 15 pro​resources
required object pro​
Resources are the resource requests and limits for the statefulSet container.
resources
required object pro​scheduling
required object pro​
Scheduling holds options related to scheduling.
scheduling
required object pro​nodeSelector
required object {} pro​
NodeSelector is the node selector to apply to the pod.
nodeSelector
required object {} pro​affinity
required object {} pro​
Affinity is the affinity to apply to the pod.
affinity
required object {} pro​tolerations
required object[] [] pro​
Tolerations are the tolerations to apply to the pod.
tolerations
required object[] [] pro​priorityClassName
required string pro​
PriorityClassName is the priority class name for the the pod.
priorityClassName
required string pro​podManagementPolicy
required string Parallel pro​
PodManagementPolicy is the statefulSet pod management policy.
podManagementPolicy
required string Parallel pro​topologySpreadConstraints
required object[] [] pro​
TopologySpreadConstraints are the topology spread constraints for the pod.
topologySpreadConstraints
required object[] [] pro​security
required object pro​
Security defines pod or container security context.
security
required object pro​podSecurityContext
required object {} pro​
PodSecurityContext specifies security context options on the pod level.
podSecurityContext
required object {} pro​containerSecurityContext
required object map[allowPrivilegeEscalation:false runAsGroup:0 runAsUser:0] pro​
ContainerSecurityContext specifies security context options on the container level.
containerSecurityContext
required object map[allowPrivilegeEscalation:false runAsGroup:0 runAsUser:0] pro​probes
required object pro​
Probes enables or disables the main container probes.
probes
required object pro​livenessProbe
required object pro​
LivenessProbe specifies if the liveness probe for the container should be enabled
livenessProbe
required object pro​enabled
required boolean true pro​
Enabled defines if this option should be enabled.
enabled
required boolean true pro​persistence
required object pro​
Persistence defines options around persistence for the statefulSet.
persistence
required object pro​volumeClaim
required object pro​
VolumeClaim can be used to configure the persistent volume claim.
volumeClaim
required object pro​enabled
required string|boolean auto pro​
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.
enabled
required string|boolean auto pro​accessModes
required string[] [ReadWriteOnce] pro​
AccessModes are the persistent volume claim access modes.
accessModes
required string[] [ReadWriteOnce] pro​retentionPolicy
required string Retain pro​
RetentionPolicy is the persistent volume claim retention policy.
retentionPolicy
required string Retain pro​size
required string 5Gi pro​
Size is the persistent volume claim storage size.
size
required string 5Gi pro​storageClass
required string pro​
StorageClass is the persistent volume claim storage class.
storageClass
required string pro​volumeClaimTemplates
required object[] [] pro​
VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet
volumeClaimTemplates
required object[] [] pro​dataVolume
required object[] [] pro​
Allows you to override the dataVolume. Only works correctly if volumeClaim.enabled=false.
dataVolume
required object[] [] pro​binariesVolume
required object[] [map[emptyDir:map[] name:binaries]] pro​
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.
binariesVolume
required object[] [map[emptyDir:map[] name:binaries]] pro​addVolumes
required object[] [] pro​
AddVolumes defines extra volumes for the pod
addVolumes
required object[] [] pro​addVolumeMounts
required object[] pro​
AddVolumeMounts defines extra volume mounts for the container
addVolumeMounts
required object[] pro​name
required string pro​
This must match the Name of a Volume.
name
required string pro​readOnly
required boolean pro​
Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
readOnly
required boolean pro​mountPath
required string pro​
Path within the container at which the volume should be mounted. Must
not contain ':'.
mountPath
required string pro​subPath
required string pro​
Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
subPath
required string pro​mountPropagation
required string pro​
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.
mountPropagation
required string pro​subPathExpr
required string pro​
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.
subPathExpr
required string pro​enableServiceLinks
required boolean true pro​
EnableServiceLinks for the StatefulSet pod
enableServiceLinks
required boolean true pro​annotations
required object {} pro​
Annotations are extra annotations for this resource.
annotations
required object {} pro​labels
required object {} pro​
Labels are extra labels for this resource.
labels
required object {} pro​pods
required object pro​
Additional labels or annotations for the statefulSet pods.
pods
required object pro​image
required object pro​
Image is the image for the controlPlane statefulSet container
image
required object pro​registry
required string ghcr.io pro​
Configure the registry of the container image, e.g. my-registry.com or ghcr.io
It defaults to ghcr.io and can be overriding either by using this field or controlPlane.advanced.defaultImageRegistry
registry
required string ghcr.io pro​repository
required string loft-sh/vcluster-pro pro​
Configure the repository of the container image, e.g. my-repo/my-image.
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, use 'loft-sh/vcluster-oss' instead.
repository
required string loft-sh/vcluster-pro pro​tag
required string pro​
Tag is the tag of the container image, e.g. latest
tag
required string pro​imagePullPolicy
required string pro​
ImagePullPolicy is the policy how to pull the image.
imagePullPolicy
required string pro​workingDir
required string pro​
WorkingDir specifies in what folder the main process should get started.
workingDir
required string pro​command
required string[] [] pro​
Command allows you to override the main command.
command
required string[] [] pro​args
required string[] [] pro​
Args allows you to override the main arguments.
args
required string[] [] pro​env
required object[] [] pro​
Env are additional environment variables for the statefulSet container.
env
required object[] [] pro​dnsPolicy
required string pro​
Set DNS policy for the pod.
dnsPolicy
required string pro​dnsConfig
required object pro​
Specifies the DNS parameters of a pod.
dnsConfig
required object pro​nameservers
required string[] pro​
A list of DNS name server IP addresses.
This will be appended to the base nameservers generated from DNSPolicy.
Duplicated nameservers will be removed.
nameservers
required string[] pro​searches
required string[] pro​
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.
searches
required string[] pro​options
required object[] pro​
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.
options
required object[] pro​serviceMonitor
required object pro​
ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself.
serviceMonitor
required object pro​advanced
required object pro​
Advanced holds additional configuration for the vCluster control plane.
advanced
required object pro​defaultImageRegistry
required string pro​
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.
defaultImageRegistry
required string pro​virtualScheduler
required object pro​
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.
virtualScheduler
required object pro​enabled
required boolean false pro​
Enabled defines if this option should be enabled.
enabled
required boolean false pro​serviceAccount
required object pro​
ServiceAccount specifies options for the vCluster control plane service account.
serviceAccount
required object pro​enabled
required boolean true pro​
Enabled specifies if the service account should get deployed.
enabled
required boolean true pro​name
required string pro​
Name specifies what name to use for the service account.
name
required string pro​imagePullSecrets
required object[] pro​
ImagePullSecrets defines extra image pull secrets for the service account.
imagePullSecrets
required object[] pro​name
required string pro​
Name of the image pull secret to use.
name
required string pro​annotations
required object {} pro​
Annotations are extra annotations for this resource.
annotations
required object {} pro​labels
required object {} pro​
Labels are extra labels for this resource.
labels
required object {} pro​workloadServiceAccount
required object pro​
WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster.
workloadServiceAccount
required object pro​enabled
required boolean true pro​
Enabled specifies if the service account for the workloads should get deployed.
enabled
required boolean true pro​name
required string pro​
Name specifies what name to use for the service account for the virtual cluster workloads.
name
required string pro​imagePullSecrets
required object[] pro​
ImagePullSecrets defines extra image pull secrets for the workload service account.
imagePullSecrets
required object[] pro​name
required string pro​
Name of the image pull secret to use.
name
required string pro​annotations
required object {} pro​
Annotations are extra annotations for this resource.
annotations
required object {} pro​labels
required object {} pro​
Labels are extra labels for this resource.
labels
required object {} pro​headlessService
required object pro​
HeadlessService specifies options for the headless service used for the vCluster StatefulSet.
headlessService
required object pro​