Advanced
Config reference
advanced required object
Advanced holds additional configuration for the vCluster control plane.
advanced required object 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.
defaultImageRegistry required string 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.
virtualScheduler required object enabled required boolean false
Enabled defines if this option should be enabled.
enabled required boolean false serviceAccount required object
ServiceAccount specifies options for the vCluster control plane service account.
serviceAccount required object enabled required boolean true
Enabled specifies if the service account should get deployed.
enabled required boolean true name required string
Name specifies what name to use for the service account.
name required string imagePullSecrets required object[]
ImagePullSecrets defines extra image pull secrets for the service account.
imagePullSecrets required object[] name required string
Name of the image pull secret to use.
name required string annotations required object {}
Annotations are extra annotations for this resource.
annotations required object {} labels required object {}
Labels are extra labels for this resource.
labels required object {} workloadServiceAccount required object
WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster.
workloadServiceAccount required object enabled required boolean true
Enabled specifies if the service account for the workloads should get deployed.
enabled required boolean true name required string
Name specifies what name to use for the service account for the virtual cluster workloads.
name required string imagePullSecrets required object[]
ImagePullSecrets defines extra image pull secrets for the workload service account.
imagePullSecrets required object[] name required string
Name of the image pull secret to use.
name required string annotations required object {}
Annotations are extra annotations for this resource.
annotations required object {} labels required object {}
Labels are extra labels for this resource.
labels required object {} headlessService required object
HeadlessService specifies options for the headless service used for the vCluster StatefulSet.
headlessService required object konnectivity required object
Konnectivity holds dedicated konnectivity configuration. This is only available when privateNodes.enabled is true.
konnectivity required object server required object
Server holds configuration for the konnectivity server.
server required object agent required object
Agent holds configuration for the konnectivity agent.
agent required object enabled required boolean true
Enabled defines if the konnectivity agent should be enabled.
enabled required boolean true replicas required integer 1
Replicas is the number of replicas for the konnectivity agent.
replicas required integer 1 image required string
Image is the image for the konnectivity agent.
image required string imagePullPolicy required string
ImagePullPolicy is the policy how to pull the image.
imagePullPolicy required string nodeSelector required object {}
NodeSelector is the node selector for the konnectivity agent.
nodeSelector required object {} priorityClassName required string
PriorityClassName is the priority class name for the konnectivity agent.
priorityClassName required string tolerations required object[] []
Tolerations is the tolerations for the konnectivity agent.
tolerations required object[] [] extraEnv required object[] []
ExtraEnv is the extra environment variables for the konnectivity agent.
extraEnv required object[] [] extraArgs required string[] []
ExtraArgs are additional arguments to pass to the konnectivity agent.
extraArgs required string[] [] 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.
registry required object enabled required boolean false
Enabled defines if the embedded registry should be enabled.
enabled required boolean false anonymousPull required boolean true
AnonymousPull allows enabling anonymous pull for the embedded registry. This allows anybody to pull images from the registry without authentication.
anonymousPull required boolean true config required object {}
Config is the regular docker registry config. See https://distribution.github.io/distribution/about/configuration/ for more details.
config required object {} 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.
cloudControllerManager required object 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.
enabled required boolean true globalMetadata required object
GlobalMetadata is metadata that will be added to all resources deployed by Helm.
globalMetadata required object annotations required object {}
Annotations are extra annotations for this resource.
annotations required object {} kubeVip required object
KubeVip holds configuration for embedded kube-vip that announces the virtual cluster endpoint IP on layer 2.
kubeVip required object enabled required boolean false
Enabled defines if embedded kube-vip should be enabled.
enabled required boolean false interface required string
Interface is the network interface on which the VIP is announced.
interface required string 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.
gateway required string 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.
podDisruptionBudget required object enabled required boolean false
Enabled defines if the pod disruption budget should be enabled.
enabled required boolean false minAvailable required object
MinAvailable describes the minimal number or percentage of available pods.
minAvailable required object maxUnavailable required object
MaxUnavailable describes the minimal number or percentage of unavailable pods.
maxUnavailable required object 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.
unhealthyPodEvictionPolicy required string