[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://vcluster.com/schemas/config","$defs":{"APIService":{"properties":{"service":{"$ref":"#/$defs/APIServiceService","description":"Service is a reference to the service for the API server."}},"additionalProperties":false,"type":"object","description":"APIService holds configuration related to the api server"},"APIServiceService":{"properties":{"name":{"type":"string","description":"Name is the name of the host service of the apiservice."},"namespace":{"type":"string","description":"Namespace is the name of the host service of the apiservice."},"port":{"type":"integer","description":"Port is the target port on the host service to connect to."}},"additionalProperties":false,"type":"object","description":"APIServiceService holds the service name and namespace of the host apiservice."},"AutoDelete":{"properties":{"afterInactivity":{"type":"integer","description":"AfterInactivity specifies after how many seconds of inactivity the virtual cluster be deleted\n+optional"}},"additionalProperties":false,"type":"object"},"AutoSleep":{"properties":{"afterInactivity":{"type":"integer","description":"AfterInactivity specifies after how many seconds of inactivity the virtual cluster should sleep\n+optional"},"schedule":{"type":"string","description":"Schedule specifies scheduled virtual cluster sleep in Cron format, see https://en.wikipedia.org/wiki/Cron.\nNote: timezone defined in the schedule string will be ignored. Use \".Timezone\" field instead.\n+optional"},"timezone":{"type":"string","description":"Timezone specifies time zone used for scheduled virtual cluster operations. Defaults to UTC.\nAccepts the same format as time.LoadLocation() in Go (https://pkg.go.dev/time#LoadLocation).\nThe value should be a location name corresponding to a file in the IANA Time Zone database, such as \"America/New_York\".\n+optional"},"autoWakeup":{"$ref":"#/$defs/PlatformAutoWakeup","description":"AutoSleep holds configuration for automatic wakeup\n+optional"}},"additionalProperties":false,"type":"object"},"AutoSleepExclusion":{"properties":{"selector":{"$ref":"#/$defs/LabelSelector"}},"additionalProperties":false,"type":"object","description":"AutoSleepExclusion holds conifiguration for excluding workloads from sleeping by label(s)"},"AutoUpgrade":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if auto upgrade should be enabled."},"image":{"type":"string","description":"Image is the image for the auto upgrade pod started by vCluster. If empty defaults to the controlPlane.statefulSet.image."},"imagePullPolicy":{"type":"string","description":"ImagePullPolicy is the policy how to pull the image."},"nodeSelector":{"additionalProperties":{"type":"string"},"type":"object","description":"NodeSelector is the node selector for the auto upgrade. If empty will select all worker nodes."},"bundleRepository":{"type":"string","description":"BundleRepository is the repository to use for downloading the Kubernetes bundle. Defaults to https://github.com/loft-sh/kubernetes/releases/download"},"binariesPath":{"type":"string","description":"BinariesPath is the base path for the kubeadm binaries. Defaults to /usr/local/bin"},"cniBinariesPath":{"type":"string","description":"CNIBinariesPath is the base path for the CNI binaries. Defaults to /opt/cni/bin"},"concurrency":{"type":"integer","description":"Concurrency is the number of nodes that can be upgraded at the same time."}},"additionalProperties":false,"type":"object"},"AutoWakeup":{"properties":{"schedule":{"type":"string"}},"additionalProperties":false,"type":"object","description":"AutoWakeup holds the cron schedule to wake workloads automatically"},"BackingStore":{"properties":{"etcd":{"$ref":"#/$defs/Etcd","description":"Etcd defines that etcd should be used as the backend for the virtual cluster"},"database":{"$ref":"#/$defs/Database","description":"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."}},"additionalProperties":false,"type":"object"},"CNI":{"properties":{"flannel":{"$ref":"#/$defs/CNIFlannel","description":"Flannel holds dedicated Flannel configuration."}},"additionalProperties":false,"type":"object"},"CNIFlannel":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if Flannel should be enabled."},"image":{"type":"string","description":"Image is the image for Flannel main container."},"initImage":{"type":"string","description":"InitImage is the image for Flannel init container."},"imagePullPolicy":{"type":"string","description":"ImagePullPolicy is the policy how to pull the image."}},"additionalProperties":false,"type":"object"},"CentralAdmission":{"properties":{"validatingWebhooks":{"items":{"$ref":"#/$defs/ValidatingWebhookConfiguration"},"type":"array","description":"ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster"},"mutatingWebhooks":{"items":{"$ref":"#/$defs/MutatingWebhookConfiguration"},"type":"array","description":"MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster"}},"additionalProperties":false,"type":"object"},"CertManager":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."},"sync":{"$ref":"#/$defs/CertManagerSync","description":"Sync contains advanced configuration for syncing cert-manager resources."}},"additionalProperties":false,"type":"object","description":"CertManager reuses a host cert-manager and makes its CRDs from it available inside the vCluster"},"CertManagerSync":{"properties":{"toHost":{"$ref":"#/$defs/CertManagerSyncToHost"},"fromHost":{"$ref":"#/$defs/CertManagerSyncFromHost"}},"additionalProperties":false,"type":"object"},"CertManagerSyncFromHost":{"properties":{"clusterIssuers":{"$ref":"#/$defs/ClusterIssuersSyncConfig","description":"ClusterIssuers defines if (and which) cluster issuers should get synced from the host cluster to the virtual cluster."}},"additionalProperties":false,"type":"object"},"CertManagerSyncToHost":{"properties":{"certificates":{"$ref":"#/$defs/EnableSwitch","description":"Certificates defines if certificates should get synced from the virtual cluster to the host cluster."},"issuers":{"$ref":"#/$defs/EnableSwitch","description":"Issuers defines if issuers should get synced from the virtual cluster to the host cluster."}},"additionalProperties":false,"type":"object"},"ClusterIssuersSyncConfig":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."},"selector":{"$ref":"#/$defs/LabelSelector","description":"Selector defines what cluster issuers should be imported."}},"additionalProperties":false,"type":"object"},"ClusterStoresSyncConfig":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."},"selector":{"$ref":"#/$defs/LabelSelector","description":"Selector defines what cluster stores should be synced"}},"additionalProperties":false,"type":"object"},"ContainerdJoin":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if containerd should be installed and configured by vCluster."},"registry":{"$ref":"#/$defs/ContainerdRegistry","description":"Registry holds configuration for how containerd should be configured to use a registries."},"importImages":{"items":{"type":"string"},"type":"array","description":"ImportImages is a list of images to import into the containerd registry from local files. If the path is a folder, all files that end with .tar or .tar.gz in the folder will be imported."},"pauseImage":{"type":"string","description":"PauseImage is the image for the pause container."}},"additionalProperties":false,"type":"object"},"ContainerdMirror":{"properties":{"server":{"type":"string","description":"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":{"items":{"type":"string"},"type":"array","description":"CACert are paths to CA certificates to use for the containerd registry mirror."},"skipVerify":{"type":"boolean","description":"SkipVerify is a boolean to skip the certificate verification for the containerd registry mirror and allows http connections."},"capabilities":{"items":{"type":"string"},"type":"array","description":"Capabilities is a list of capabilities to enable for the containerd registry mirror. If empty, will use pull and resolve capabilities."},"hosts":{"items":{"$ref":"#/$defs/ContainerdMirrorHost"},"type":"array","description":"Hosts holds configuration for the containerd registry mirror hosts. See https://github.com/containerd/containerd/blob/main/docs/hosts.md for more details."}},"additionalProperties":false,"type":"object"},"ContainerdMirrorHost":{"properties":{"server":{"type":"string","description":"Server is the server to use for the containerd registry mirror host. E.g. http://192.168.31.250:5000."},"caCert":{"items":{"type":"string"},"type":"array","description":"CACert are paths to CA certificates to use for the containerd registry mirror host."},"skipVerify":{"type":"boolean","description":"SkipVerify is a boolean to skip the certificate verification for the containerd registry mirror and allows http connections."},"capabilities":{"items":{"type":"string"},"type":"array","description":"Capabilities is a list of capabilities to enable for the containerd registry mirror. If empty, will use pull and resolve capabilities."}},"additionalProperties":false,"type":"object"},"ContainerdRegistry":{"properties":{"configPath":{"type":"string","description":"ConfigPath is the path to the containerd registry config."},"mirrors":{"additionalProperties":{"$ref":"#/$defs/ContainerdMirror"},"type":"object","description":"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."}},"additionalProperties":false,"type":"object"},"ControlPlane":{"properties":{"endpoint":{"type":"string","description":"Endpoint is the endpoint of the virtual cluster. This is used to connect to the virtual cluster."},"distro":{"$ref":"#/$defs/Distro","description":"Distro holds virtual cluster related distro options. A distro cannot be changed after vCluster is deployed."},"standalone":{"$ref":"#/$defs/Standalone","description":"Standalone holds configuration for standalone mode. Standalone mode is set automatically when no container is detected and\nalso implies privateNodes.enabled."},"backingStore":{"$ref":"#/$defs/BackingStore","description":"BackingStore defines which backing store to use for virtual cluster. If not defined will use embedded database as a default backing store."},"coredns":{"$ref":"#/$defs/CoreDNS","description":"CoreDNS defines everything related to the coredns that is deployed and used within the vCluster."},"proxy":{"$ref":"#/$defs/ControlPlaneProxy","description":"Proxy defines options for the virtual cluster control plane proxy that is used to do authentication and intercept requests."},"hostPathMapper":{"$ref":"#/$defs/HostPathMapper","description":"HostPathMapper defines if vCluster should rewrite host paths."},"ingress":{"$ref":"#/$defs/ControlPlaneIngress","description":"Ingress defines options for vCluster ingress deployed by Helm."},"service":{"$ref":"#/$defs/ControlPlaneService","description":"Service defines options for vCluster service deployed by Helm."},"statefulSet":{"$ref":"#/$defs/ControlPlaneStatefulSet","description":"StatefulSet defines options for vCluster statefulSet deployed by Helm."},"serviceMonitor":{"$ref":"#/$defs/ServiceMonitor","description":"ServiceMonitor can be used to automatically create a service monitor for vCluster deployment itself."},"advanced":{"$ref":"#/$defs/ControlPlaneAdvanced","description":"Advanced holds additional configuration for the vCluster control plane."}},"additionalProperties":false,"type":"object"},"ControlPlaneAdvanced":{"properties":{"defaultImageRegistry":{"type":"string","description":"DefaultImageRegistry will be used as a prefix for all internal images deployed by vCluster or Helm. This makes it easy to\nupload all required vCluster images to a single private repository and set this value. Workload images are not affected by this."},"virtualScheduler":{"$ref":"#/$defs/EnableSwitch","description":"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.\nDeprecated: Use ControlPlane.Distro.K8S.Scheduler instead."},"serviceAccount":{"$ref":"#/$defs/ControlPlaneServiceAccount","description":"ServiceAccount specifies options for the vCluster control plane service account."},"workloadServiceAccount":{"$ref":"#/$defs/ControlPlaneWorkloadServiceAccount","description":"WorkloadServiceAccount specifies options for the service account that will be used for the workloads that run within the virtual cluster."},"headlessService":{"$ref":"#/$defs/ControlPlaneHeadlessService","description":"HeadlessService specifies options for the headless service used for the vCluster StatefulSet."},"konnectivity":{"$ref":"#/$defs/Konnectivity","description":"Konnectivity holds dedicated konnectivity configuration. This is only available when privateNodes.enabled is true."},"registry":{"$ref":"#/$defs/Registry","description":"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."},"globalMetadata":{"$ref":"#/$defs/ControlPlaneGlobalMetadata","description":"GlobalMetadata is metadata that will be added to all resources deployed by Helm."}},"additionalProperties":false,"type":"object"},"ControlPlaneGlobalMetadata":{"properties":{"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for this resource."}},"additionalProperties":false,"type":"object"},"ControlPlaneHeadlessService":{"properties":{"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for this resource."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are extra labels for this resource."}},"additionalProperties":false,"type":"object"},"ControlPlaneHighAvailability":{"properties":{"replicas":{"type":"integer","description":"Replicas is the amount of replicas to use for the statefulSet."},"leaseDuration":{"type":"integer","description":"LeaseDuration is the time to lease for the leader."},"renewDeadline":{"type":"integer","description":"RenewDeadline is the deadline to renew a lease for the leader."},"retryPeriod":{"type":"integer","description":"RetryPeriod is the time until a replica will retry to get a lease."}},"additionalProperties":false,"type":"object"},"ControlPlaneIngress":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if the control plane ingress should be enabled"},"host":{"type":"string","description":"Host is the host where vCluster will be reachable"},"pathType":{"type":"string","description":"PathType is the path type of the ingress"},"spec":{"type":"object","description":"Spec allows you to configure extra ingress options."},"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for this resource."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are extra labels for this resource."}},"additionalProperties":false,"type":"object"},"ControlPlanePersistence":{"properties":{"volumeClaim":{"$ref":"#/$defs/VolumeClaim","description":"VolumeClaim can be used to configure the persistent volume claim."},"volumeClaimTemplates":{"items":{"type":"object"},"type":"array","description":"VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet"},"dataVolume":{"items":{"type":"object"},"type":"array","description":"Allows you to override the dataVolume. Only works correctly if volumeClaim.enabled=false."},"binariesVolume":{"items":{"type":"object"},"type":"array","description":"BinariesVolume defines a binaries volume that is used to retrieve\ndistro specific executables to be run by the syncer controller.\nThis volume doesn't need to be persistent."},"addVolumes":{"items":{"type":"object"},"type":"array","description":"AddVolumes defines extra volumes for the pod"},"addVolumeMounts":{"items":{"$ref":"#/$defs/VolumeMount"},"type":"array","description":"AddVolumeMounts defines extra volume mounts for the container"}},"additionalProperties":false,"type":"object"},"ControlPlaneProbes":{"properties":{"livenessProbe":{"$ref":"#/$defs/LivenessProbe","description":"LivenessProbe specifies if the liveness probe for the container should be enabled"},"readinessProbe":{"$ref":"#/$defs/ReadinessProbe","description":"ReadinessProbe specifies if the readiness probe for the container should be enabled"},"startupProbe":{"$ref":"#/$defs/StartupProbe","description":"StartupProbe specifies if the startup probe for the container should be enabled"}},"additionalProperties":false,"type":"object"},"ControlPlaneProxy":{"properties":{"bindAddress":{"type":"string","description":"BindAddress under which vCluster will expose the proxy."},"port":{"type":"integer","description":"Port under which vCluster will expose the proxy. Changing port is currently not supported."},"extraSANs":{"items":{"type":"string"},"type":"array","description":"ExtraSANs are extra hostnames to sign the vCluster proxy certificate for."}},"additionalProperties":false,"type":"object"},"ControlPlaneScheduling":{"properties":{"nodeSelector":{"type":"object","description":"NodeSelector is the node selector to apply to the pod."},"affinity":{"type":"object","description":"Affinity is the affinity to apply to the pod."},"tolerations":{"items":{"type":"object"},"type":"array","description":"Tolerations are the tolerations to apply to the pod."},"priorityClassName":{"type":"string","description":"PriorityClassName is the priority class name for the the pod."},"podManagementPolicy":{"type":"string","description":"PodManagementPolicy is the statefulSet pod management policy."},"topologySpreadConstraints":{"items":true,"type":"array","description":"TopologySpreadConstraints are the topology spread constraints for the pod."}},"additionalProperties":false,"type":"object"},"ControlPlaneSecurity":{"properties":{"podSecurityContext":{"type":"object","description":"PodSecurityContext specifies security context options on the pod level."},"containerSecurityContext":{"type":"object","description":"ContainerSecurityContext specifies security context options on the container level."}},"additionalProperties":false,"type":"object"},"ControlPlaneService":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if the control plane service should be enabled"},"spec":{"type":"object","description":"Spec allows you to configure extra service options."},"kubeletNodePort":{"type":"integer","description":"KubeletNodePort is the node port where the fake kubelet is exposed. Defaults to 0."},"httpsNodePort":{"type":"integer","description":"HTTPSNodePort is the node port where https is exposed. Defaults to 0."},"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for this resource."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are extra labels for this resource."}},"additionalProperties":false,"type":"object"},"ControlPlaneServiceAccount":{"properties":{"enabled":{"type":"boolean","description":"Enabled specifies if the service account should get deployed."},"name":{"type":"string","description":"Name specifies what name to use for the service account."},"imagePullSecrets":{"items":{"$ref":"#/$defs/ImagePullSecretName"},"type":"array","description":"ImagePullSecrets defines extra image pull secrets for the service account."},"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for this resource."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are extra labels for this resource."}},"additionalProperties":false,"type":"object"},"ControlPlaneStatefulSet":{"properties":{"highAvailability":{"$ref":"#/$defs/ControlPlaneHighAvailability","description":"HighAvailability holds options related to high availability."},"resources":{"$ref":"#/$defs/Resources","description":"Resources are the resource requests and limits for the statefulSet container."},"scheduling":{"$ref":"#/$defs/ControlPlaneScheduling","description":"Scheduling holds options related to scheduling."},"security":{"$ref":"#/$defs/ControlPlaneSecurity","description":"Security defines pod or container security context."},"probes":{"$ref":"#/$defs/ControlPlaneProbes","description":"Probes enables or disables the main container probes."},"persistence":{"$ref":"#/$defs/ControlPlanePersistence","description":"Persistence defines options around persistence for the statefulSet."},"enableServiceLinks":{"type":"boolean","description":"EnableServiceLinks for the StatefulSet pod"},"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for this resource."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are extra labels for this resource."},"pods":{"$ref":"#/$defs/LabelsAndAnnotations","description":"Additional labels or annotations for the statefulSet pods."},"image":{"$ref":"#/$defs/StatefulSetImage","description":"Image is the image for the controlPlane statefulSet container"},"imagePullPolicy":{"type":"string","description":"ImagePullPolicy is the policy how to pull the image."},"workingDir":{"type":"string","description":"WorkingDir specifies in what folder the main process should get started."},"command":{"items":{"type":"string"},"type":"array","description":"Command allows you to override the main command."},"args":{"items":{"type":"string"},"type":"array","description":"Args allows you to override the main arguments."},"env":{"items":{"type":"object"},"type":"array","description":"Env are additional environment variables for the statefulSet container."},"dnsPolicy":{"type":"string","description":"Set DNS policy for the pod."},"dnsConfig":{"$ref":"#/$defs/PodDNSConfig","description":"Specifies the DNS parameters of a pod."}},"additionalProperties":false,"type":"object"},"ControlPlaneWorkloadServiceAccount":{"properties":{"enabled":{"type":"boolean","description":"Enabled specifies if the service account for the workloads should get deployed."},"name":{"type":"string","description":"Name specifies what name to use for the service account for the virtual cluster workloads."},"imagePullSecrets":{"items":{"$ref":"#/$defs/ImagePullSecretName"},"type":"array","description":"ImagePullSecrets defines extra image pull secrets for the workload service account."},"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for this resource."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are extra labels for this resource."}},"additionalProperties":false,"type":"object"},"CoreDNS":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if coredns is enabled"},"embedded":{"type":"boolean","description":"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":{"$ref":"#/$defs/ControlPlaneSecurity","description":"Security defines pod or container security context."},"service":{"$ref":"#/$defs/CoreDNSService","description":"Service holds extra options for the coredns service deployed within the virtual cluster"},"deployment":{"$ref":"#/$defs/CoreDNSDeployment","description":"Deployment holds extra options for the coredns deployment deployed within the virtual cluster"},"overwriteConfig":{"type":"string","description":"OverwriteConfig can be used to overwrite the coredns config"},"overwriteManifests":{"type":"string","description":"OverwriteManifests can be used to overwrite the coredns manifests used to deploy coredns"},"priorityClassName":{"type":"string","description":"PriorityClassName specifies the priority class name for the CoreDNS pods."}},"additionalProperties":false,"type":"object"},"CoreDNSDeployment":{"properties":{"image":{"type":"string","description":"Image is the coredns image to use"},"replicas":{"type":"integer","description":"Replicas is the amount of coredns pods to run."},"nodeSelector":{"additionalProperties":{"type":"string"},"type":"object","description":"NodeSelector is the node selector to use for coredns."},"affinity":{"type":"object","description":"Affinity is the affinity to apply to the pod."},"tolerations":{"items":{"type":"object"},"type":"array","description":"Tolerations are the tolerations to apply to the pod."},"resources":{"$ref":"#/$defs/Resources","description":"Resources are the desired resources for coredns."},"pods":{"$ref":"#/$defs/LabelsAndAnnotations","description":"Pods is additional metadata for the coredns pods."},"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for this resource."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are extra labels for this resource."},"topologySpreadConstraints":{"items":true,"type":"array","description":"TopologySpreadConstraints are the topology spread constraints for the CoreDNS pod."}},"additionalProperties":false,"type":"object"},"CoreDNSService":{"properties":{"spec":{"type":"object","description":"Spec holds extra options for the coredns service"},"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for this resource."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are extra labels for this resource."}},"additionalProperties":false,"type":"object"},"Database":{"properties":{"embedded":{"$ref":"#/$defs/DatabaseKine","description":"Embedded defines that an embedded database (sqlite) should be used as the backend for the virtual cluster"},"external":{"$ref":"#/$defs/ExternalDatabaseKine","description":"External defines that an external database should be used as the backend for the virtual cluster"}},"additionalProperties":false,"type":"object"},"DatabaseKine":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if the database should be used."},"dataSource":{"type":"string","description":"DataSource is the kine dataSource to use for the database. This depends on the database format.\nThis is optional for the embedded database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/k3s\n* postgres: postgres://username:password@hostname:5432/k3s"},"keyFile":{"type":"string","description":"KeyFile is the key file to use for the database. This is optional."},"certFile":{"type":"string","description":"CertFile is the cert file to use for the database. This is optional."},"caFile":{"type":"string","description":"CaFile is the ca file to use for the database. This is optional."},"extraArgs":{"items":{"type":"string"},"type":"array","description":"ExtraArgs are additional arguments to pass to Kine."}},"additionalProperties":false,"type":"object"},"DenyRule":{"properties":{"name":{"type":"string","description":"The name of the check."},"namespaces":{"items":{"type":"string"},"type":"array","description":"Namespace describe a list of namespaces that will be affected by the check.\nAn empty list means that all namespaces will be affected.\nIn case of ClusterScoped rules, only the Namespace resource is affected."},"rules":{"items":{"$ref":"#/$defs/RuleWithVerbs"},"type":"array","description":"Rules describes on which verbs and on what resources/subresources the webhook is enforced.\nThe webhook is enforced if it matches any Rule.\nThe version of the request must match the rule version exactly. Equivalent matching is not supported."},"excludedUsers":{"items":{"type":"string"},"type":"array","description":"ExcludedUsers describe a list of users for which the checks will be skipped.\nImpersonation attempts on these users will still be subjected to the checks."}},"additionalProperties":false,"type":"object"},"Deploy":{"properties":{"kubeProxy":{"$ref":"#/$defs/KubeProxy","description":"KubeProxy holds dedicated kube proxy configuration."},"metallb":{"$ref":"#/$defs/Metallb","description":"Metallb holds dedicated metallb configuration."},"cni":{"$ref":"#/$defs/CNI","description":"CNI holds dedicated CNI configuration."},"localPathProvisioner":{"$ref":"#/$defs/LocalPathProvisioner","description":"LocalPathProvisioner holds dedicated local path provisioner configuration."},"ingressNginx":{"$ref":"#/$defs/IngressNginx","description":"IngressNginx holds dedicated ingress-nginx configuration."},"metricsServer":{"$ref":"#/$defs/DeployMetricsServer","description":"MetricsServer holds dedicated metrics server configuration."}},"additionalProperties":false,"type":"object"},"DeployMetricsServer":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if metrics server should be enabled."}},"additionalProperties":false,"type":"object"},"Distro":{"properties":{"k8s":{"$ref":"#/$defs/DistroK8s","description":"K8S holds K8s relevant configuration."},"k3s":{"$ref":"#/$defs/DistroK3s","description":"[Deprecated] K3S holds K3s relevant configuration."}},"additionalProperties":false,"type":"object"},"DistroContainerEnabled":{"properties":{"enabled":{"type":"boolean","description":"Enabled signals this container should be enabled."},"command":{"items":{"type":"string"},"type":"array","description":"Command is the command to start the distro binary. This will override the existing command."},"extraArgs":{"items":{"type":"string"},"type":"array","description":"ExtraArgs are additional arguments to pass to the distro binary."}},"additionalProperties":false,"type":"object"},"DistroK3s":{"properties":{"enabled":{"type":"boolean","description":"Enabled specifies if the K3s distro should be enabled. Only one distro can be enabled at the same time."},"token":{"type":"string","description":"Token is the K3s token to use. If empty, vCluster will choose one."},"image":{"$ref":"#/$defs/Image","description":"Image is the distro image"},"imagePullPolicy":{"type":"string","description":"ImagePullPolicy is the pull policy for the distro image"},"env":{"items":{"type":"object"},"type":"array","description":"Env are extra environment variables to use for the main container and NOT the init container."},"resources":{"type":"object","description":"Resources for the distro init container"},"securityContext":{"type":"object","description":"Security options can be used for the distro init container"},"command":{"items":{"type":"string"},"type":"array","description":"Command is the command to start the distro binary. This will override the existing command."},"extraArgs":{"items":{"type":"string"},"type":"array","description":"ExtraArgs are additional arguments to pass to the distro binary."}},"additionalProperties":false,"type":"object"},"DistroK8s":{"properties":{"enabled":{"type":"boolean","description":"Enabled specifies if the K8s distro should be enabled. Only one distro can be enabled at the same time."},"version":{"type":"string","description":"[Deprecated] Version field is deprecated.\nUse controlPlane.distro.k8s.image.tag to specify the Kubernetes version instead."},"apiServer":{"$ref":"#/$defs/DistroContainerEnabled","description":"APIServer holds configuration specific to starting the api server."},"controllerManager":{"$ref":"#/$defs/DistroContainerEnabled","description":"ControllerManager holds configuration specific to starting the controller manager."},"scheduler":{"$ref":"#/$defs/DistroContainerEnabled","description":"Scheduler holds configuration specific to starting the scheduler. Enable this via controlPlane.advanced.virtualScheduler.enabled"},"image":{"$ref":"#/$defs/Image","description":"Image is the distro image"},"imagePullPolicy":{"type":"string","description":"ImagePullPolicy is the pull policy for the distro image"},"env":{"items":{"type":"object"},"type":"array","description":"Env are extra environment variables to use for the main container and NOT the init container."},"resources":{"type":"object","description":"Resources for the distro init container"},"securityContext":{"type":"object","description":"Security options can be used for the distro init container"}},"additionalProperties":false,"type":"object"},"EnableAutoSwitchWithPatches":{"properties":{"enabled":{"oneOf":[{"type":"string"},{"type":"boolean"}],"description":"Enabled defines if this option should be enabled."},"patches":{"items":{"$ref":"#/$defs/TranslatePatch"},"type":"array","description":"Patches patch the resource according to the provided specification."}},"additionalProperties":false,"type":"object"},"EnableAutoSwitchWithPatchesAndSelector":{"properties":{"enabled":{"oneOf":[{"type":"string"},{"type":"boolean"}],"description":"Enabled defines if this option should be enabled."},"patches":{"items":{"$ref":"#/$defs/TranslatePatch"},"type":"array","description":"Patches patch the resource according to the provided specification."},"selector":{"$ref":"#/$defs/StandardLabelSelector","description":"Selector defines the selector to use for the resource. If not set, all resources of that type will be synced."}},"additionalProperties":false,"type":"object"},"EnableSwitch":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."}},"additionalProperties":false,"type":"object"},"EnableSwitchWithPatches":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."},"patches":{"items":{"$ref":"#/$defs/TranslatePatch"},"type":"array","description":"Patches patch the resource according to the provided specification."}},"additionalProperties":false,"type":"object"},"EnableSwitchWithPatchesAndSelector":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."},"patches":{"items":{"$ref":"#/$defs/TranslatePatch"},"type":"array","description":"Patches patch the resource according to the provided specification."},"selector":{"$ref":"#/$defs/StandardLabelSelector","description":"Selector defines the selector to use for the resource. If not set, all resources of that type will be synced."}},"additionalProperties":false,"type":"object"},"EnableSwitchWithResourcesMappings":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."},"patches":{"items":{"$ref":"#/$defs/TranslatePatch"},"type":"array","description":"Patches patch the resource according to the provided specification."},"mappings":{"$ref":"#/$defs/FromHostMappings","description":"Mappings for Namespace and Object"}},"additionalProperties":false,"type":"object"},"Etcd":{"properties":{"embedded":{"$ref":"#/$defs/EtcdEmbedded","description":"Embedded defines to use embedded etcd as a storage backend for the virtual cluster"},"deploy":{"$ref":"#/$defs/EtcdDeploy","description":"Deploy defines to use an external etcd that is deployed by the helm chart"},"external":{"$ref":"#/$defs/EtcdExternal","description":"External defines to use a self-hosted external etcd that is not deployed by the helm chart"}},"additionalProperties":false,"type":"object"},"EtcdDeploy":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines that an external etcd should be deployed."},"statefulSet":{"$ref":"#/$defs/EtcdDeployStatefulSet","description":"StatefulSet holds options for the external etcd statefulSet."},"service":{"$ref":"#/$defs/EtcdDeployService","description":"Service holds options for the external etcd service."},"headlessService":{"$ref":"#/$defs/EtcdDeployHeadlessService","description":"HeadlessService holds options for the external etcd headless service."}},"additionalProperties":false,"type":"object"},"EtcdDeployHeadlessService":{"properties":{"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for the external etcd headless service"}},"additionalProperties":false,"type":"object"},"EtcdDeployService":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if the etcd service should be deployed"},"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for the external etcd service"}},"additionalProperties":false,"type":"object"},"EtcdDeployStatefulSet":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if the statefulSet should be deployed"},"enableServiceLinks":{"type":"boolean","description":"EnableServiceLinks for the StatefulSet pod"},"image":{"$ref":"#/$defs/Image","description":"Image is the image to use for the external etcd statefulSet"},"imagePullPolicy":{"type":"string","description":"ImagePullPolicy is the pull policy for the external etcd image"},"env":{"items":{"type":"object"},"type":"array","description":"Env are extra environment variables"},"extraArgs":{"items":{"type":"string"},"type":"array","description":"ExtraArgs are appended to the etcd command."},"resources":{"$ref":"#/$defs/Resources","description":"Resources the etcd can consume"},"pods":{"$ref":"#/$defs/LabelsAndAnnotations","description":"Pods defines extra metadata for the etcd pods."},"highAvailability":{"$ref":"#/$defs/ExternalEtcdHighAvailability","description":"HighAvailability are high availability options"},"scheduling":{"$ref":"#/$defs/ControlPlaneScheduling","description":"Scheduling options for the etcd pods."},"security":{"$ref":"#/$defs/ControlPlaneSecurity","description":"Security options for the etcd pods."},"persistence":{"$ref":"#/$defs/ExternalEtcdPersistence","description":"Persistence options for the etcd pods."},"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for this resource."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are extra labels for this resource."}},"additionalProperties":false,"type":"object"},"EtcdEmbedded":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if the embedded etcd should be used."},"migrateFromDeployedEtcd":{"type":"boolean","description":"MigrateFromDeployedEtcd signals that vCluster should migrate from the deployed external etcd to embedded etcd."},"snapshotCount":{"type":"integer","description":"SnapshotCount defines the number of snapshots to keep for the embedded etcd. Defaults to 10000 if less than 1."},"extraArgs":{"items":{"type":"string"},"type":"array","description":"ExtraArgs are additional arguments to pass to the embedded etcd."}},"additionalProperties":false,"type":"object"},"EtcdExternal":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if the external etcd should be used."},"endpoint":{"type":"string","description":"Endpoint holds the endpoint of the external etcd server, e.g. my-example-service:2379"},"tls":{"$ref":"#/$defs/EtcdExternalTLS","description":"TLS defines the tls configuration for the external etcd server"}},"additionalProperties":false,"type":"object"},"EtcdExternalTLS":{"properties":{"caFile":{"type":"string","description":"CaFile is the path to the ca file"},"certFile":{"type":"string","description":"CertFile is the path to the cert file"},"keyFile":{"type":"string","description":"KeyFile is the path to the key file"}},"additionalProperties":false,"type":"object","description":"EtcdExternalTLS defines tls for external etcd server"},"Experimental":{"properties":{"deploy":{"$ref":"#/$defs/ExperimentalDeploy","description":"Deploy allows you to configure manifests and Helm charts to deploy within the host or virtual cluster."},"syncSettings":{"$ref":"#/$defs/ExperimentalSyncSettings","description":"SyncSettings are advanced settings for the syncer controller."},"genericSync":{"$ref":"#/$defs/ExperimentalGenericSync","description":"GenericSync holds options to generically sync resources from virtual cluster to host."},"isolatedControlPlane":{"$ref":"#/$defs/ExperimentalIsolatedControlPlane","description":"IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves."},"virtualClusterKubeConfig":{"$ref":"#/$defs/VirtualClusterKubeConfig","description":"VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config."},"denyProxyRequests":{"items":{"$ref":"#/$defs/DenyRule"},"type":"array","description":"DenyProxyRequests denies certain requests in the vCluster proxy."}},"additionalProperties":false,"type":"object"},"ExperimentalDeploy":{"properties":{"host":{"$ref":"#/$defs/ExperimentalDeployHost","description":"Host defines what manifests to deploy into the host cluster"},"vcluster":{"$ref":"#/$defs/ExperimentalDeployVCluster","description":"VCluster defines what manifests and charts to deploy into the vCluster"}},"additionalProperties":false,"type":"object"},"ExperimentalDeployHelm":{"properties":{"chart":{"$ref":"#/$defs/ExperimentalDeployHelmChart","description":"Chart defines what chart should get deployed."},"release":{"$ref":"#/$defs/ExperimentalDeployHelmRelease","description":"Release defines what release should get deployed."},"values":{"type":"string","description":"Values defines what values should get used."},"timeout":{"type":"string","description":"Timeout defines the timeout for Helm"},"bundle":{"type":"string","description":"Bundle allows to compress the Helm chart and specify this instead of an online chart"}},"additionalProperties":false,"type":"object"},"ExperimentalDeployHelmChart":{"properties":{"name":{"type":"string"},"repo":{"type":"string"},"insecure":{"type":"boolean"},"version":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}},"additionalProperties":false,"type":"object"},"ExperimentalDeployHelmRelease":{"properties":{"name":{"type":"string","description":"Name of the release"},"namespace":{"type":"string","description":"Namespace of the release"}},"additionalProperties":false,"type":"object"},"ExperimentalDeployHost":{"properties":{"manifests":{"type":"string","description":"Manifests are raw Kubernetes manifests that should get applied within the host cluster."},"manifestsTemplate":{"type":"string","description":"ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the host cluster."}},"additionalProperties":false,"type":"object"},"ExperimentalDeployVCluster":{"properties":{"manifests":{"type":"string","description":"Manifests are raw Kubernetes manifests that should get applied within the virtual cluster."},"manifestsTemplate":{"type":"string","description":"ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster."},"helm":{"items":{"$ref":"#/$defs/ExperimentalDeployHelm"},"type":"array","description":"Helm are Helm charts that should get deployed into the virtual cluster"}},"additionalProperties":false,"type":"object"},"ExperimentalGenericSync":{"properties":{"version":{"type":"string","description":"Version is the config version"},"export":{"items":{"$ref":"#/$defs/Export"},"type":"array","description":"Exports syncs a resource from the virtual cluster to the host"},"import":{"items":{"$ref":"#/$defs/Import"},"type":"array","description":"Imports syncs a resource from the host cluster to virtual cluster"},"hooks":{"$ref":"#/$defs/Hooks","description":"Hooks are hooks that can be used to inject custom patches before syncing"},"clusterRole":{"$ref":"#/$defs/ExperimentalGenericSyncExtraRules"},"role":{"$ref":"#/$defs/ExperimentalGenericSyncExtraRules"}},"additionalProperties":false,"type":"object"},"ExperimentalGenericSyncExtraRules":{"properties":{"extraRules":{"items":true,"type":"array"}},"additionalProperties":false,"type":"object"},"ExperimentalIsolatedControlPlane":{"properties":{"enabled":{"type":"boolean","description":"Enabled specifies if the isolated control plane feature should be enabled."},"headless":{"type":"boolean","description":"Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane."},"kubeConfig":{"type":"string","description":"KubeConfig is the path where to find the remote workload cluster kubeconfig."},"namespace":{"type":"string","description":"Namespace is the namespace where to sync the workloads into."},"service":{"type":"string","description":"Service is the vCluster service in the remote cluster."}},"additionalProperties":false,"type":"object"},"ExperimentalSyncSettings":{"properties":{"targetNamespace":{"type":"string","description":"TargetNamespace is the namespace where the workloads should get synced to."},"setOwner":{"type":"boolean","description":"SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection."},"hostMetricsBindAddress":{"type":"string","description":"HostMetricsBindAddress is the bind address for the local manager"},"virtualMetricsBindAddress":{"type":"string","description":"VirtualMetricsBindAddress is the bind address for the virtual manager"}},"additionalProperties":false,"type":"object"},"Export":{"properties":{"apiVersion":{"type":"string","description":"APIVersion of the object to sync"},"kind":{"type":"string","description":"Kind of the object to sync"},"optional":{"type":"boolean"},"replaceOnConflict":{"type":"boolean","description":"ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying"},"patches":{"items":{"$ref":"#/$defs/Patch"},"type":"array","description":"Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster"},"reversePatches":{"items":{"$ref":"#/$defs/Patch"},"type":"array","description":"ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster"},"selector":{"$ref":"#/$defs/Selector","description":"Selector is a label selector to select the synced objects in the virtual cluster.\nIf empty, all objects will be synced."}},"additionalProperties":false,"type":"object"},"ExportKubeConfig":{"properties":{"context":{"type":"string","description":"Context is the name of the context within the generated kubeconfig to use."},"server":{"type":"string","description":"Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig."},"insecure":{"type":"boolean","description":"If tls should get skipped for the server"},"serviceAccount":{"$ref":"#/$defs/ExportKubeConfigServiceAccount","description":"ServiceAccount can be used to generate a service account token instead of the default certificates."},"secret":{"$ref":"#/$defs/ExportKubeConfigSecretReference","description":"Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.\nIf this is not defined, vCluster will create it with `vc-NAME`. If you specify another name,\nvCluster creates the config in this other secret.\n\nDeprecated: Use AdditionalSecrets instead."},"additionalSecrets":{"items":{"$ref":"#/$defs/ExportKubeConfigAdditionalSecretReference"},"type":"array","description":"AdditionalSecrets specifies the additional host cluster secrets in which vCluster will store the\ngenerated virtual cluster kubeconfigs."}},"additionalProperties":false,"type":"object","description":"ExportKubeConfig describes how vCluster should export the vCluster kubeconfig."},"ExportKubeConfigAdditionalSecretReference":{"properties":{"context":{"type":"string","description":"Context is the name of the context within the generated kubeconfig to use."},"server":{"type":"string","description":"Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig."},"insecure":{"type":"boolean","description":"If tls should get skipped for the server"},"serviceAccount":{"$ref":"#/$defs/ExportKubeConfigServiceAccount","description":"ServiceAccount can be used to generate a service account token instead of the default certificates."},"name":{"type":"string","description":"Name is the name of the secret where the kubeconfig is stored."},"namespace":{"type":"string","description":"Namespace where vCluster stores the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace."}},"additionalProperties":false,"type":"object","description":"ExportKubeConfigAdditionalSecretReference defines the additional host cluster secret in which vCluster stores the generated virtual cluster kubeconfigs."},"ExportKubeConfigSecretReference":{"properties":{"name":{"type":"string","description":"Name is the name of the secret where the kubeconfig should get stored."},"namespace":{"type":"string","description":"Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace\nwhere you deployed vCluster, you need to make sure vCluster has access to this other namespace."}},"additionalProperties":false,"type":"object","description":"Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig."},"ExportKubeConfigServiceAccount":{"properties":{"name":{"type":"string","description":"Name of the service account to be used to generate a service account token instead of the default certificates."},"namespace":{"type":"string","description":"Namespace of the service account to be used to generate a service account token instead of the default certificates.\nIf omitted, will use the kube-system namespace."},"clusterRole":{"type":"string","description":"ClusterRole to assign to the service account."}},"additionalProperties":false,"type":"object"},"ExternalConfig":{"properties":{"platform":{"$ref":"#/$defs/PlatformConfig","type":"object","description":"platform holds platform configuration"}},"type":"object","description":"ExternalConfig holds external configuration"},"ExternalDatabaseKine":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if the database should be used."},"dataSource":{"type":"string","description":"DataSource is the kine dataSource to use for the database. This depends on the database format.\nThis is optional for the embedded database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/k3s\n* postgres: postgres://username:password@hostname:5432/k3s"},"keyFile":{"type":"string","description":"KeyFile is the key file to use for the database. This is optional."},"certFile":{"type":"string","description":"CertFile is the cert file to use for the database. This is optional."},"caFile":{"type":"string","description":"CaFile is the ca file to use for the database. This is optional."},"extraArgs":{"items":{"type":"string"},"type":"array","description":"ExtraArgs are additional arguments to pass to Kine."},"connector":{"type":"string","description":"Connector specifies a secret located in a connected vCluster Platform that contains database server connection information\nto be used by Platform to create a database and database user for the vCluster.\nand non-privileged user. A kine endpoint should be created using the database and user on Platform registration.\nThis is optional."}},"additionalProperties":false,"type":"object"},"ExternalEtcdHighAvailability":{"properties":{"replicas":{"type":"integer","description":"Replicas are the amount of pods to use."}},"additionalProperties":false,"type":"object"},"ExternalEtcdPersistence":{"properties":{"volumeClaim":{"$ref":"#/$defs/ExternalEtcdPersistenceVolumeClaim","description":"VolumeClaim can be used to configure the persistent volume claim."},"volumeClaimTemplates":{"items":{"type":"object"},"type":"array","description":"VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet"},"addVolumes":{"items":{"type":"object"},"type":"array","description":"AddVolumes defines extra volumes for the pod"},"addVolumeMounts":{"items":{"$ref":"#/$defs/VolumeMount"},"type":"array","description":"AddVolumeMounts defines extra volume mounts for the container"}},"additionalProperties":false,"type":"object"},"ExternalEtcdPersistenceVolumeClaim":{"properties":{"enabled":{"type":"boolean","description":"Enabled enables deploying a persistent volume claim."},"accessModes":{"items":{"type":"string"},"type":"array","description":"AccessModes are the persistent volume claim access modes."},"retentionPolicy":{"type":"string","description":"RetentionPolicy is the persistent volume claim retention policy."},"size":{"type":"string","description":"Size is the persistent volume claim storage size."},"storageClass":{"type":"string","description":"StorageClass is the persistent volume claim storage class."}},"additionalProperties":false,"type":"object"},"ExternalSecrets":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines whether the external secret integration is enabled or not"},"webhook":{"$ref":"#/$defs/EnableSwitch","description":"Webhook defines whether the host webhooks are reused or not"},"sync":{"$ref":"#/$defs/ExternalSecretsSync","description":"Sync defines the syncing behavior for the integration"}},"additionalProperties":false,"type":"object","description":"ExternalSecrets reuses a host external secret operator and makes certain CRDs from it available inside the vCluster"},"ExternalSecretsSync":{"properties":{"externalSecrets":{"$ref":"#/$defs/EnableSwitch","description":"ExternalSecrets defines if external secrets should get synced from the virtual cluster to the host cluster."},"stores":{"$ref":"#/$defs/EnableSwitch","description":"Stores defines if secret stores should get synced from the virtual cluster to the host cluster and then bi-directionally."},"clusterStores":{"$ref":"#/$defs/ClusterStoresSyncConfig","description":"ClusterStores defines if cluster secrets stores should get synced from the host cluster to the virtual cluster."}},"additionalProperties":false,"type":"object"},"FromHostMappings":{"properties":{"byName":{"additionalProperties":{"type":"string"},"type":"object","description":"ByName is a map of host-object-namespace/host-object-name: virtual-object-namespace/virtual-object-name.\nThere are several wildcards supported:\n1. To match all objects in host namespace and sync them to different namespace in vCluster:\nbyName:\n  \"foo/*\": \"foo-in-virtual/*\"\n2. To match specific object in the host namespace and sync it to the same namespace with the same name:\nbyName:\n  \"foo/my-object\": \"foo/my-object\"\n3. To match specific object in the host namespace and sync it to the same namespace with different name:\nbyName:\n  \"foo/my-object\": \"foo/my-virtual-object\"\n4. To match all objects in the vCluster host namespace and sync them to a different namespace in vCluster:\nbyName:\n  \"\": \"my-virtual-namespace/*\"\n5. To match specific objects in the vCluster host namespace and sync them to a different namespace in vCluster:\nbyName:\n  \"/my-object\": \"my-virtual-namespace/my-object\""}},"additionalProperties":false,"type":"object"},"Hook":{"properties":{"apiVersion":{"type":"string","description":"APIVersion of the object to sync"},"kind":{"type":"string","description":"Kind of the object to sync"},"verbs":{"items":{"type":"string"},"type":"array","description":"Verbs are the verbs that the hook should mutate"},"patches":{"items":{"$ref":"#/$defs/Patch"},"type":"array","description":"Patches are the patches to apply on the object to be synced"}},"additionalProperties":false,"type":"object"},"Hooks":{"properties":{"hostToVirtual":{"items":{"$ref":"#/$defs/Hook"},"type":"array","description":"HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster"},"virtualToHost":{"items":{"$ref":"#/$defs/Hook"},"type":"array","description":"VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster"}},"additionalProperties":false,"type":"object"},"HostPathMapper":{"properties":{"enabled":{"type":"boolean","description":"Enabled specifies if the host path mapper will be used"},"central":{"type":"boolean","description":"Central specifies if the central host path mapper will be used"}},"additionalProperties":false,"type":"object"},"HybridScheduling":{"properties":{"enabled":{"type":"boolean","description":"Enabled specifies if hybrid scheduling is enabled."},"hostSchedulers":{"items":{"type":"string"},"type":"array","description":"HostSchedulers is a list of schedulers that are deployed on the host cluster."}},"additionalProperties":false,"type":"object"},"IPBlock":{"properties":{"cidr":{"type":"string","description":"cidr is a string representing the IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\""},"except":{"items":{"type":"string"},"type":"array","description":"except is a slice of CIDRs that should not be included within an IPBlock\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"\nExcept values will be rejected if they are outside the cidr range\n+optional"}},"additionalProperties":false,"type":"object"},"Image":{"properties":{"registry":{"type":"string","description":"Registry is the registry of the container image, e.g. my-registry.com or ghcr.io. This setting can be globally\noverridden via the controlPlane.advanced.defaultImageRegistry option. Empty means docker hub."},"repository":{"type":"string","description":"Repository is the repository of the container image, e.g. my-repo/my-image"},"tag":{"type":"string","description":"Tag is the tag of the container image, e.g. latest. If set to the default, it will use the host Kubernetes version."}},"additionalProperties":false,"type":"object"},"ImagePullSecretName":{"properties":{"name":{"type":"string","description":"Name of the image pull secret to use."}},"additionalProperties":false,"type":"object"},"Import":{"properties":{"apiVersion":{"type":"string","description":"APIVersion of the object to sync"},"kind":{"type":"string","description":"Kind of the object to sync"},"optional":{"type":"boolean"},"replaceOnConflict":{"type":"boolean","description":"ReplaceWhenInvalid determines if the controller should try to recreate the object\nif there is a problem applying"},"patches":{"items":{"$ref":"#/$defs/Patch"},"type":"array","description":"Patches are the patches to apply on the virtual cluster objects\nwhen syncing them from the host cluster"},"reversePatches":{"items":{"$ref":"#/$defs/Patch"},"type":"array","description":"ReversePatches are the patches to apply to host cluster objects\nafter it has been synced to the virtual cluster"}},"additionalProperties":false,"type":"object"},"IngressNginx":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if ingress-nginx should be enabled."},"defaultIngressClass":{"type":"boolean","description":"DefaultIngressClass defines if the deployed ingress class should be the default ingress class."}},"additionalProperties":false,"type":"object"},"Integrations":{"properties":{"metricsServer":{"$ref":"#/$defs/MetricsServer","description":"MetricsServer reuses the metrics server from the host cluster within the vCluster."},"kubeVirt":{"$ref":"#/$defs/KubeVirt","description":"KubeVirt reuses a host kubevirt and makes certain CRDs from it available inside the vCluster"},"externalSecrets":{"$ref":"#/$defs/ExternalSecrets","description":"ExternalSecrets reuses a host external secret operator and makes certain CRDs from it available inside the vCluster.\n- ExternalSecrets will be synced from the virtual cluster to the host cluster.\n- SecretStores will be synced from the virtual cluster to the host cluster and then bi-directionally.\n- ClusterSecretStores will be synced from the host cluster to the virtual cluster."},"certManager":{"$ref":"#/$defs/CertManager","description":"CertManager reuses a host cert-manager and makes its CRDs from it available inside the vCluster.\n- Certificates and Issuers will be synced from the virtual cluster to the host cluster.\n- ClusterIssuers will be synced from the host cluster to the virtual cluster."},"istio":{"$ref":"#/$defs/Istio","description":"Istio syncs DestinationRules, Gateways and VirtualServices from virtual cluster to the host."}},"additionalProperties":false,"type":"object","description":"Integrations holds config for vCluster integrations with other operators or tools running on the host cluster"},"Istio":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."},"sync":{"$ref":"#/$defs/IstioSync"}},"additionalProperties":false,"type":"object"},"IstioSync":{"properties":{"toHost":{"$ref":"#/$defs/IstioSyncToHost"}},"additionalProperties":false,"type":"object"},"IstioSyncToHost":{"properties":{"destinationRules":{"$ref":"#/$defs/EnableSwitch"},"gateways":{"$ref":"#/$defs/EnableSwitch"},"virtualServices":{"$ref":"#/$defs/EnableSwitch"}},"additionalProperties":false,"type":"object"},"JoinConfiguration":{"properties":{"preJoinCommands":{"items":{"type":"string"},"type":"array","description":"PreJoinCommands are commands that will be executed before the join process starts."},"postJoinCommands":{"items":{"type":"string"},"type":"array","description":"PostJoinCommands are commands that will be executed after the join process starts."},"containerd":{"$ref":"#/$defs/ContainerdJoin","description":"Containerd holds configuration for the containerd join process."},"caCertPath":{"type":"string","description":"CACertPath is the path to the SSL certificate authority used to\nsecure communications between node and control-plane.\nDefaults to \"/etc/kubernetes/pki/ca.crt\"."},"skipPhases":{"items":{"type":"string"},"type":"array","description":"SkipPhases is a list of phases to skip during command execution.\nThe list of phases can be obtained with the \"kubeadm join --help\" command."},"nodeRegistration":{"$ref":"#/$defs/NodeRegistration","description":"NodeRegistration holds configuration for the node registration similar to the kubeadm node registration."}},"additionalProperties":false,"type":"object"},"Konnectivity":{"properties":{"server":{"$ref":"#/$defs/KonnectivityServer","description":"Server holds configuration for the konnectivity server."},"agent":{"$ref":"#/$defs/KonnectivityAgent","description":"Agent holds configuration for the konnectivity agent."}},"additionalProperties":false,"type":"object"},"KonnectivityAgent":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if the konnectivity agent should be enabled."},"replicas":{"type":"integer","description":"Replicas is the number of replicas for the konnectivity agent."},"image":{"type":"string","description":"Image is the image for the konnectivity agent."},"imagePullPolicy":{"type":"string","description":"ImagePullPolicy is the policy how to pull the image."},"nodeSelector":{"additionalProperties":{"type":"string"},"type":"object","description":"NodeSelector is the node selector for the konnectivity agent."},"priorityClassName":{"type":"string","description":"PriorityClassName is the priority class name for the konnectivity agent."},"tolerations":{"items":true,"type":"array","description":"Tolerations is the tolerations for the konnectivity agent."},"extraEnv":{"items":true,"type":"array","description":"ExtraEnv is the extra environment variables for the konnectivity agent."},"extraArgs":{"items":{"type":"string"},"type":"array","description":"ExtraArgs are additional arguments to pass to the konnectivity agent."}},"additionalProperties":false,"type":"object"},"KonnectivityServer":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if the konnectivity server should be enabled."},"extraArgs":{"items":{"type":"string"},"type":"array","description":"ExtraArgs are additional arguments to pass to the konnectivity server."}},"additionalProperties":false,"type":"object"},"KubeProxy":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if the kube proxy should be enabled."},"image":{"type":"string","description":"Image is the image for the kube-proxy."},"imagePullPolicy":{"type":"string","description":"ImagePullPolicy is the policy how to pull the image."},"nodeSelector":{"additionalProperties":{"type":"string"},"type":"object","description":"NodeSelector is the node selector for the kube-proxy."},"priorityClassName":{"type":"string","description":"PriorityClassName is the priority class name for the kube-proxy."},"tolerations":{"items":true,"type":"array","description":"Tolerations is the tolerations for the kube-proxy."},"extraEnv":{"items":true,"type":"array","description":"ExtraEnv is the extra environment variables for the kube-proxy."},"extraArgs":{"items":{"type":"string"},"type":"array","description":"ExtraArgs are additional arguments to pass to the kube-proxy."}},"additionalProperties":false,"type":"object"},"KubeVirt":{"properties":{"enabled":{"type":"boolean","description":"Enabled signals if the integration should be enabled"},"apiService":{"$ref":"#/$defs/APIService","description":"APIService holds information about where to find the virt-api service. Defaults to virt-api/kubevirt."},"webhook":{"$ref":"#/$defs/EnableSwitch","description":"Webhook holds configuration for enabling the webhook within the vCluster"},"sync":{"$ref":"#/$defs/KubeVirtSync","description":"Sync holds configuration on what resources to sync"}},"additionalProperties":false,"type":"object","description":"KubeVirt reuses a host kubevirt and makes certain CRDs from it available inside the vCluster"},"KubeVirtSync":{"properties":{"dataVolumes":{"$ref":"#/$defs/EnableSwitch","description":"If DataVolumes should get synced"},"virtualMachineInstanceMigrations":{"$ref":"#/$defs/EnableSwitch","description":"If VirtualMachineInstanceMigrations should get synced"},"virtualMachineInstances":{"$ref":"#/$defs/EnableSwitch","description":"If VirtualMachineInstances should get synced"},"virtualMachines":{"$ref":"#/$defs/EnableSwitch","description":"If VirtualMachines should get synced"},"virtualMachineClones":{"$ref":"#/$defs/EnableSwitch","description":"If VirtualMachineClones should get synced"},"virtualMachinePools":{"$ref":"#/$defs/EnableSwitch","description":"If VirtualMachinePools should get synced"}},"additionalProperties":false,"type":"object","description":"KubeVirtSync are the crds that are supported by this integration"},"Kubelet":{"properties":{"cgroupDriver":{"type":"string","description":"CgroupDriver defines the cgroup driver to use for the kubelet."}},"additionalProperties":false,"type":"object"},"KubeletExtraArg":{"properties":{"name":{"type":"string","description":"Name is the name of the argument."},"value":{"type":"string","description":"Value is the value of the argument."}},"additionalProperties":false,"type":"object","description":"KubeletExtraArg represents an argument with a name and a value."},"KubeletJoinTaint":{"properties":{"key":{"type":"string","description":"Required. The taint key to be applied to a node."},"value":{"type":"string","description":"The taint value corresponding to the taint key.\n+optional"},"effect":{"type":"string","description":"Required. The effect of the taint on pods\nthat do not tolerate the taint.\nValid effects are NoSchedule, PreferNoSchedule and NoExecute."}},"additionalProperties":false,"type":"object"},"LabelSelector":{"properties":{"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels defines what labels should be looked for"}},"additionalProperties":false,"type":"object"},"LabelSelectorRequirement":{"properties":{"key":{"type":"string"},"operator":{"type":"string"},"values":{"items":{"type":"string"},"type":"array"}},"additionalProperties":false,"type":"object"},"LabelsAndAnnotations":{"properties":{"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for this resource."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are extra labels for this resource."}},"additionalProperties":false,"type":"object"},"LimitRange":{"properties":{"enabled":{"oneOf":[{"type":"string"},{"type":"boolean"}],"description":"Enabled defines if the limit range should be deployed by vCluster. \"auto\" means that if resourceQuota is enabled,\nthe limitRange will be enabled as well."},"default":{"type":"object","description":"Default are the default limits for the limit range"},"defaultRequest":{"type":"object","description":"DefaultRequest are the default request options for the limit range"},"max":{"type":"object","description":"Max are the max limits for the limit range"},"min":{"type":"object","description":"Min are the min limits for the limit range"},"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for this resource."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are extra labels for this resource."}},"additionalProperties":false,"type":"object"},"LivenessProbe":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."},"failureThreshold":{"type":"integer","description":"Number of consecutive failures for the probe to be considered failed"},"initialDelaySeconds":{"type":"integer","description":"Time (in seconds) to wait before starting the liveness probe"},"timeoutSeconds":{"type":"integer","description":"Maximum duration (in seconds) that the probe will wait for a response."},"periodSeconds":{"type":"integer","description":"Frequency (in seconds) to perform the probe"}},"additionalProperties":false,"type":"object","description":"LivenessProbe defines the configuration for the liveness probe."},"LocalPathProvisioner":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if LocalPathProvisioner should be enabled."},"image":{"type":"string","description":"Image is the image for local path provisioner."},"imagePullPolicy":{"type":"string","description":"ImagePullPolicy is the policy how to pull the image."},"nodePath":{"type":"string","description":"NodePath is the path on the node where to create the persistent volume directories."}},"additionalProperties":false,"type":"object"},"Logging":{"properties":{"encoding":{"type":"string","description":"Encoding specifies the format of vCluster logs, it can either be json or console."}},"additionalProperties":false,"type":"object","description":"Logging holds the log encoding details"},"Metallb":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if metallb should be enabled."},"controllerImage":{"type":"string","description":"ControllerImage is the image for metallb controller."},"speakerImage":{"type":"string","description":"SpeakerImage is the image for metallb speaker."},"ipAddressPool":{"$ref":"#/$defs/MetallbIPAddressPool","description":"IPAddressPool is the IP address pool to use for metallb."}},"additionalProperties":false,"type":"object"},"MetallbIPAddressPool":{"properties":{"addresses":{"items":{"type":"string"},"type":"array","description":"Addresses is a list of IP addresses to use for the IP address pool."},"l2Advertisement":{"type":"boolean","description":"L2Advertisement defines if L2 advertisement should be enabled for the IP address pool."}},"additionalProperties":false,"type":"object"},"MetricsServer":{"properties":{"enabled":{"type":"boolean","description":"Enabled signals the metrics server integration should be enabled."},"apiService":{"$ref":"#/$defs/APIService","description":"APIService holds information about where to find the metrics-server service. Defaults to metrics-server/kube-system."},"nodes":{"type":"boolean","description":"Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster."},"pods":{"type":"boolean","description":"Pods defines if metrics-server pods api should get proxied from host to virtual cluster."}},"additionalProperties":false,"type":"object","description":"MetricsServer reuses the metrics server from the host cluster within the vCluster."},"MutatingWebhook":{"properties":{"reinvocationPolicy":{"type":"string","description":"reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.\nAllowed values are \"Never\" and \"IfNeeded\"."},"name":{"type":"string","description":"The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization."},"clientConfig":{"$ref":"#/$defs/ValidatingWebhookClientConfig","description":"ClientConfig defines how to communicate with the hook."},"rules":{"items":true,"type":"array","description":"Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule."},"failurePolicy":{"type":"string","description":"FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail."},"matchPolicy":{"type":"string","description":"matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\"."},"namespaceSelector":{"description":"NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."},"objectSelector":{"description":"ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."},"sideEffects":{"type":"string","description":"SideEffects states whether this webhook has side effects."},"timeoutSeconds":{"type":"integer","description":"TimeoutSeconds specifies the timeout for this webhook."},"admissionReviewVersions":{"items":{"type":"string"},"type":"array","description":"AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects."},"matchConditions":{"items":true,"type":"array","description":"MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed."}},"additionalProperties":false,"type":"object"},"MutatingWebhookConfiguration":{"properties":{"kind":{"type":"string","description":"Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to."},"apiVersion":{"type":"string","description":"APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values."},"metadata":{"$ref":"#/$defs/ObjectMeta","description":"Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."},"webhooks":{"items":{"$ref":"#/$defs/MutatingWebhook"},"type":"array","description":"Webhooks is a list of webhooks and the affected resources and operations."}},"additionalProperties":false,"type":"object"},"NetworkPolicy":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if the network policy should be deployed by vCluster."},"fallbackDns":{"type":"string","description":"FallbackDNS is the fallback DNS server to use if the virtual cluster does not have a DNS server."},"outgoingConnections":{"$ref":"#/$defs/OutgoingConnections","description":"OutgoingConnections are the outgoing connections options for the vCluster workloads."},"extraControlPlaneRules":{"items":{"type":"object"},"type":"array","description":"ExtraControlPlaneRules are extra allowed rules for the vCluster control plane."},"extraWorkloadRules":{"items":{"type":"object"},"type":"array","description":"ExtraWorkloadRules are extra allowed rules for the vCluster workloads."},"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for this resource."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are extra labels for this resource."}},"additionalProperties":false,"type":"object"},"NetworkProxyKubelets":{"properties":{"byHostname":{"type":"boolean","description":"ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work\nfor all applications, e.g. Prometheus requires a node IP."},"byIP":{"type":"boolean","description":"ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to\nroute traffic."}},"additionalProperties":false,"type":"object"},"Networking":{"properties":{"serviceCIDR":{"type":"string","description":"ServiceCIDR holds the service cidr for the virtual cluster. This should only be set if privateNodes.enabled is true or vCluster cannot detect the host service cidr."},"podCIDR":{"type":"string","description":"PodCIDR holds the pod cidr for the virtual cluster. This should only be set if privateNodes.enabled is true."},"replicateServices":{"$ref":"#/$defs/ReplicateServices","description":"ReplicateServices allows replicating services from the host within the virtual cluster or the other way around."},"resolveDNS":{"items":{"$ref":"#/$defs/ResolveDNS"},"type":"array","description":"ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured."},"advanced":{"$ref":"#/$defs/NetworkingAdvanced","description":"Advanced holds advanced network options."}},"additionalProperties":false,"type":"object"},"NetworkingAdvanced":{"properties":{"clusterDomain":{"type":"string","description":"ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster."},"fallbackHostCluster":{"type":"boolean","description":"FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without\nany other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace"},"proxyKubelets":{"$ref":"#/$defs/NetworkProxyKubelets","description":"ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to \"fake\" this for applications such as\nprometheus or other node exporters."}},"additionalProperties":false,"type":"object"},"NodeRegistration":{"properties":{"criSocket":{"type":"string","description":"CRI socket is the socket for the CRI."},"kubeletExtraArgs":{"items":{"$ref":"#/$defs/KubeletExtraArg"},"type":"array","description":"KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file\nkubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config ConfigMap\nFlags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on.\nAn argument name in this list is the flag name as it appears on the command line except without leading dash(es).\nExtra arguments will override existing default arguments. Duplicate extra arguments are allowed."},"taints":{"items":{"$ref":"#/$defs/KubeletJoinTaint"},"type":"array","description":"Taints are additional taints to set for the kubelet."},"ignorePreflightErrors":{"items":{"type":"string"},"type":"array","description":"IgnorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered, e.g. 'IsPrivilegedUser,Swap'.\nValue 'all' ignores errors from all checks."},"imagePullPolicy":{"type":"string","description":"ImagePullPolicy specifies the policy for image pulling during kubeadm \"init\" and \"join\" operations.\nThe value of this field must be one of \"Always\", \"IfNotPresent\" or \"Never\".\nIf this field is unset kubeadm will default it to \"IfNotPresent\", or pull the required images if not present on the host."}},"additionalProperties":false,"type":"object"},"ObjectMeta":{"properties":{"name":{"type":"string","description":"Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services."},"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata."}},"additionalProperties":false,"type":"object"},"OutgoingConnections":{"properties":{"ipBlock":{"$ref":"#/$defs/IPBlock","description":"IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed\nto the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs\nthat should not be included within this rule."},"platform":{"type":"boolean","description":"Platform enables egress access towards loft platform"}},"additionalProperties":false,"type":"object"},"Patch":{"properties":{"op":{"type":"string","description":"Operation is the type of the patch"},"fromPath":{"type":"string","description":"FromPath is the path from the other object"},"path":{"type":"string","description":"Path is the path of the patch"},"namePath":{"type":"string","description":"NamePath is the path to the name of a child resource within Path"},"namespacePath":{"type":"string","description":"NamespacePath is path to the namespace of a child resource within Path"},"value":{"description":"Value is the new value to be set to the path"},"regex":{"type":"string","description":"Regex - is regular expresion used to identify the Name,\nand optionally Namespace, parts of the field value that\nwill be replaced with the rewritten Name and/or Namespace"},"conditions":{"items":{"$ref":"#/$defs/PatchCondition"},"type":"array","description":"Conditions are conditions that must be true for\nthe patch to get executed"},"ignore":{"type":"boolean","description":"Ignore determines if the path should be ignored if handled as a reverse patch"},"sync":{"$ref":"#/$defs/PatchSync","description":"Sync defines if a specialized syncer should be initialized using values\nfrom the rewriteName operation as Secret/Configmap names to be synced"}},"additionalProperties":false,"type":"object"},"PatchCondition":{"properties":{"path":{"type":"string","description":"Path is the path within the object to select"},"subPath":{"type":"string","description":"SubPath is the path below the selected object to select"},"equal":{"description":"Equal is the value the path should be equal to"},"notEqual":{"description":"NotEqual is the value the path should not be equal to"},"empty":{"type":"boolean","description":"Empty means that the path value should be empty or unset"}},"additionalProperties":false,"type":"object"},"PatchSync":{"properties":{"secret":{"type":"boolean"},"configmap":{"type":"boolean"}},"additionalProperties":false,"type":"object"},"PlatformAPIKey":{"properties":{"secretName":{"type":"string","description":"SecretName is the name of the secret where the platform access key is stored. This defaults to vcluster-platform-api-key if undefined."},"namespace":{"type":"string","description":"Namespace defines the namespace where the access key secret should be retrieved from. If this is not equal to the namespace\nwhere the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace."},"createRBAC":{"type":"boolean","description":"CreateRBAC will automatically create the necessary RBAC roles and role bindings to allow vCluster to read the secret specified\nin the above namespace, if specified.\nThis defaults to true."}},"additionalProperties":false,"type":"object","description":"PlatformAPIKey defines where to find the platform access key."},"PlatformAutoWakeup":{"properties":{"schedule":{"type":"string","description":"Schedule specifies scheduled wakeup from sleep in Cron format, see https://en.wikipedia.org/wiki/Cron.\nNote: timezone defined in the schedule string will be ignored. The timezone for the autoSleep schedule will be\nused\n+optional"}},"additionalProperties":false,"type":"object"},"PlatformConfig":{"properties":{"apiKey":{"$ref":"#/$defs/PlatformAPIKey","description":"APIKey defines where to find the platform access key and host. By default, vCluster will search in the following locations in this precedence:\n* environment variable called LICENSE\n* secret specified under external.platform.apiKey.secretName\n* secret called \"vcluster-platform-api-key\" in the vCluster namespace"},"project":{"type":"string","description":"Project specifies which platform project the vcluster should be imported to"},"autoSleep":{"$ref":"#/$defs/AutoSleep","description":"AutoSleep holds configuration for automatic sleep and wakeup\n+optional"},"autoDelete":{"$ref":"#/$defs/AutoDelete","description":"AutoDelete holds configuration for automatic delete\n+optional"}},"type":"object","description":"PlatformConfig holds platform configuration"},"Plugin":{"properties":{"name":{"type":"string","description":"Name is the name of the init-container and NOT the plugin name"},"image":{"type":"string","description":"Image is the container image that should be used for the plugin"},"imagePullPolicy":{"type":"string","description":"ImagePullPolicy is the pull policy to use for the container image"},"config":{"type":"object","description":"Config is the plugin config to use. This can be arbitrary config used for the plugin."},"rbac":{"$ref":"#/$defs/PluginsRBAC","description":"RBAC holds additional rbac configuration for the plugin"},"command":{"items":{"type":"string"},"type":"array","description":"Command is the command that should be used for the init container"},"args":{"items":{"type":"string"},"type":"array","description":"Args are the arguments that should be used for the init container"},"securityContext":{"type":"object","description":"SecurityContext is the container security context used for the init container"},"resources":{"type":"object","description":"Resources are the container resources used for the init container"},"volumeMounts":{"items":true,"type":"array","description":"VolumeMounts are extra volume mounts for the init container"},"version":{"type":"string","description":"Version is the plugin version, this is only needed for legacy plugins."},"env":{"items":true,"type":"array"},"envFrom":{"items":true,"type":"array"},"lifecycle":{"type":"object"},"livenessProbe":{"type":"object"},"readinessProbe":{"type":"object"},"startupProbe":{"type":"object"},"workingDir":{"type":"string"},"optional":{"type":"boolean"}},"additionalProperties":false,"type":"object"},"Plugins":{"properties":{"name":{"type":"string","description":"Name is the name of the init-container and NOT the plugin name"},"image":{"type":"string","description":"Image is the container image that should be used for the plugin"},"imagePullPolicy":{"type":"string","description":"ImagePullPolicy is the pull policy to use for the container image"},"config":{"type":"object","description":"Config is the plugin config to use. This can be arbitrary config used for the plugin."},"rbac":{"$ref":"#/$defs/PluginsRBAC","description":"RBAC holds additional rbac configuration for the plugin"},"command":{"items":{"type":"string"},"type":"array","description":"Command is the command that should be used for the init container"},"args":{"items":{"type":"string"},"type":"array","description":"Args are the arguments that should be used for the init container"},"securityContext":{"type":"object","description":"SecurityContext is the container security context used for the init container"},"resources":{"type":"object","description":"Resources are the container resources used for the init container"},"volumeMounts":{"items":true,"type":"array","description":"VolumeMounts are extra volume mounts for the init container"}},"additionalProperties":false,"type":"object"},"PluginsExtraRules":{"properties":{"extraRules":{"items":{"$ref":"#/$defs/RBACPolicyRule"},"type":"array","description":"ExtraRules are extra rbac permissions roles that will be added to role or cluster role"}},"additionalProperties":false,"type":"object"},"PluginsRBAC":{"properties":{"role":{"$ref":"#/$defs/PluginsExtraRules","description":"Role holds extra virtual cluster role permissions for the plugin"},"clusterRole":{"$ref":"#/$defs/PluginsExtraRules","description":"ClusterRole holds extra virtual cluster cluster role permissions required for the plugin"}},"additionalProperties":false,"type":"object"},"PodDNSConfig":{"properties":{"nameservers":{"items":{"type":"string"},"type":"array","description":"A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.\nDuplicated nameservers will be removed.\n+optional\n+listType=atomic"},"searches":{"items":{"type":"string"},"type":"array","description":"A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.\nDuplicated search paths will be removed.\n+optional\n+listType=atomic"},"options":{"items":{"$ref":"#/$defs/PodDNSConfigOption"},"type":"array","description":"A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy.\n+optional\n+listType=atomic"}},"additionalProperties":false,"type":"object","description":"PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy."},"PodDNSConfigOption":{"properties":{"name":{"type":"string","description":"Required."},"value":{"type":"string","description":"+optional"}},"additionalProperties":false,"type":"object","description":"PodDNSConfigOption defines DNS resolver options of a pod."},"Policies":{"properties":{"networkPolicy":{"$ref":"#/$defs/NetworkPolicy","description":"NetworkPolicy specifies network policy options."},"podSecurityStandard":{"type":"string","description":"PodSecurityStandard that can be enforced can be one of: empty (\"\"), baseline, restricted or privileged"},"resourceQuota":{"$ref":"#/$defs/ResourceQuota","description":"ResourceQuota specifies resource quota options."},"limitRange":{"$ref":"#/$defs/LimitRange","description":"LimitRange specifies limit range options."},"centralAdmission":{"$ref":"#/$defs/CentralAdmission","description":"CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster."}},"additionalProperties":false,"type":"object"},"PrivateNodes":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if dedicated nodes should be enabled."},"importNodeBinaries":{"type":"boolean","description":"ImportNodeBinaries defines to use the loft-sh/kubernetes:VERSION-full image to also copy the node binaries to the control plane. This allows upgrades and\njoining new nodes into the cluster without having to download the binaries from the internet."},"kubelet":{"$ref":"#/$defs/Kubelet","description":"Kubelet holds kubelet configuration that is used for all nodes."},"autoUpgrade":{"$ref":"#/$defs/AutoUpgrade","description":"AutoUpgrade holds configuration for auto upgrade."},"joinNode":{"$ref":"#/$defs/JoinConfiguration","description":"JoinNode holds configuration specifically used during joining the node (see \"kubeadm join\")."}},"additionalProperties":false,"type":"object","description":"PrivateNodes enables private nodes for vCluster."},"RBAC":{"properties":{"role":{"$ref":"#/$defs/RBACRole","description":"Role holds virtual cluster role configuration"},"clusterRole":{"$ref":"#/$defs/RBACClusterRole","description":"ClusterRole holds virtual cluster cluster role configuration"}},"additionalProperties":false,"type":"object"},"RBACClusterRole":{"properties":{"enabled":{"oneOf":[{"type":"string"},{"type":"boolean"}],"description":"Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role."},"extraRules":{"items":{"type":"object"},"type":"array","description":"ExtraRules will add rules to the cluster role."},"overwriteRules":{"items":{"type":"object"},"type":"array","description":"OverwriteRules will overwrite the cluster role rules completely."}},"additionalProperties":false,"type":"object"},"RBACPolicyRule":{"properties":{"verbs":{"items":{"type":"string"},"type":"array","description":"Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs."},"apiGroups":{"items":{"type":"string"},"type":"array","description":"APIGroups is the name of the APIGroup that contains the resources.  If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups."},"resources":{"items":{"type":"string"},"type":"array","description":"Resources is a list of resources this rule applies to. '*' represents all resources."},"resourceNames":{"items":{"type":"string"},"type":"array","description":"ResourceNames is an optional white list of names that the rule applies to.  An empty set means that everything is allowed."},"nonResourceURLs":{"items":{"type":"string"},"type":"array","description":"NonResourceURLs is a set of partial urls that a user should have access to.  *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"),  but not both."}},"additionalProperties":false,"type":"object"},"RBACRole":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if the role should be enabled or disabled."},"extraRules":{"items":{"type":"object"},"type":"array","description":"ExtraRules will add rules to the role."},"overwriteRules":{"items":{"type":"object"},"type":"array","description":"OverwriteRules will overwrite the role rules completely."}},"additionalProperties":false,"type":"object"},"ReadinessProbe":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."},"failureThreshold":{"type":"integer","description":"Number of consecutive failures for the probe to be considered failed"},"timeoutSeconds":{"type":"integer","description":"Maximum duration (in seconds) that the probe will wait for a response."},"periodSeconds":{"type":"integer","description":"Frequency (in seconds) to perform the probe"}},"additionalProperties":false,"type":"object","description":"ReadinessProbe defines the configuration for the readiness probe."},"Registry":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if the embedded registry should be enabled."},"anonymousPull":{"type":"boolean","description":"AnonymousPull allows enabling anonymous pull for the embedded registry. This allows anybody to pull images from the registry without authentication."},"config":{"description":"Config is the regular docker registry config. See https://distribution.github.io/distribution/about/configuration/ for more details."}},"additionalProperties":false,"type":"object"},"ReplicateServices":{"properties":{"toHost":{"items":{"$ref":"#/$defs/ServiceMapping"},"type":"array","description":"ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are\nsynced to a different namespace than the virtual cluster is in, additional permissions for the other namespace\nare required."},"fromHost":{"items":{"$ref":"#/$defs/ServiceMapping"},"type":"array","description":"FromHost defines the services that should get synced from the host to the virtual cluster."}},"additionalProperties":false,"type":"object"},"ResolveDNS":{"properties":{"hostname":{"type":"string","description":"Hostname is the hostname within the vCluster that should be resolved from."},"service":{"type":"string","description":"Service is the virtual cluster service that should be resolved from."},"namespace":{"type":"string","description":"Namespace is the virtual cluster namespace that should be resolved from."},"target":{"$ref":"#/$defs/ResolveDNSTarget","description":"Target is the DNS target that should get mapped to"}},"additionalProperties":false,"type":"object"},"ResolveDNSTarget":{"properties":{"hostname":{"type":"string","description":"Hostname to use as a DNS target"},"ip":{"type":"string","description":"IP to use as a DNS target"},"hostService":{"type":"string","description":"HostService to target, format is hostNamespace/hostService"},"hostNamespace":{"type":"string","description":"HostNamespace to target"},"vClusterService":{"type":"string","description":"VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService"}},"additionalProperties":false,"type":"object"},"ResourceQuota":{"properties":{"enabled":{"oneOf":[{"type":"string"},{"type":"boolean"}],"description":"Enabled defines if the resource quota should be enabled. \"auto\" means that if limitRange is enabled,\nthe resourceQuota will be enabled as well."},"quota":{"type":"object","description":"Quota are the quota options"},"scopeSelector":{"type":"object","description":"ScopeSelector is the resource quota scope selector"},"scopes":{"items":{"type":"string"},"type":"array","description":"Scopes are the resource quota scopes"},"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are extra annotations for this resource."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are extra labels for this resource."}},"additionalProperties":false,"type":"object"},"Resources":{"properties":{"limits":{"type":"object","description":"Limits are resource limits for the container"},"requests":{"type":"object","description":"Requests are minimal resources that will be consumed by the container"}},"additionalProperties":false,"type":"object"},"RuleWithVerbs":{"properties":{"apiGroups":{"items":{"type":"string"},"type":"array","description":"APIGroups is the API groups the resources belong to. '*' is all groups."},"apiVersions":{"items":{"type":"string"},"type":"array","description":"APIVersions is the API versions the resources belong to. '*' is all versions."},"resources":{"items":{"type":"string"},"type":"array","description":"Resources is a list of resources this rule applies to."},"scope":{"type":"string","description":"Scope specifies the scope of this rule."},"operations":{"items":{"type":"string"},"type":"array","description":"Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.\nFor non-resource requests, this is the lowercase http verb.\nIf '*' is present, the length of the slice must be one."}},"additionalProperties":false,"type":"object"},"Selector":{"properties":{"labelSelector":{"additionalProperties":{"type":"string"},"type":"object","description":"LabelSelector are the labels to select the object from"}},"additionalProperties":false,"type":"object"},"ServiceMapping":{"properties":{"from":{"type":"string","description":"From is the service that should get synced. Can be either in the form name or namespace/name."},"to":{"type":"string","description":"To is the target service that it should get synced to. Can be either in the form name or namespace/name."}},"additionalProperties":false,"type":"object"},"ServiceMonitor":{"properties":{"enabled":{"type":"boolean","description":"Enabled configures if Helm should create the service monitor."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are the extra labels to add to the service monitor."},"annotations":{"additionalProperties":{"type":"string"},"type":"object","description":"Annotations are the extra annotations to add to the service monitor."}},"additionalProperties":false,"type":"object"},"SleepMode":{"properties":{"enabled":{"type":"boolean","description":"Enabled toggles the sleep mode functionality, allowing for disabling sleep mode without removing other config"},"timeZone":{"type":"string","description":"Timezone represents the timezone a sleep schedule should run against, defaulting to UTC if unset"},"autoSleep":{"$ref":"#/$defs/SleepModeAutoSleep","description":"AutoSleep holds autoSleep details"},"autoWakeup":{"$ref":"#/$defs/AutoWakeup","description":"AutoWakeup holds configuration for waking the vCluster on a schedule rather than waiting for some activity."}},"additionalProperties":false,"type":"object","description":"SleepMode holds configuration for native/workload only sleep mode"},"SleepModeAutoSleep":{"properties":{"afterInactivity":{"type":"string","description":"AfterInactivity represents how long a vCluster can be idle before workloads are automaticaly put to sleep"},"schedule":{"type":"string","description":"Schedule represents a cron schedule for when to sleep workloads"},"exclude":{"$ref":"#/$defs/AutoSleepExclusion","description":"Exclude holds configuration for labels that, if present, will prevent a workload from going to sleep"}},"additionalProperties":false,"type":"object","description":"SleepModeAutoSleep holds configuration for allowing a vCluster to sleep its workloads automatically"},"Standalone":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if standalone mode should be enabled."},"dataDir":{"type":"string","description":"DataDir defines the data directory for the standalone mode."},"bundleRepository":{"type":"string","description":"BundleRepository is the repository to use for downloading the Kubernetes bundle. Defaults to https://github.com/loft-sh/kubernetes/releases/download"},"bundle":{"type":"string","description":"Bundle is a path to a Kubernetes bundle to use for the standalone mode. If empty, will use the bundleRepository to download the bundle."},"joinNode":{"$ref":"#/$defs/StandaloneJoinNode","description":"JoinNode holds configuration for the standalone control plane node."}},"additionalProperties":false,"type":"object"},"StandaloneJoinNode":{"properties":{"enabled":{"type":"boolean","description":"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."},"name":{"type":"string","description":"Name defines the name of the standalone node. If empty the node will get the hostname as name."},"preJoinCommands":{"items":{"type":"string"},"type":"array","description":"PreJoinCommands are commands that will be executed before the join process starts."},"postJoinCommands":{"items":{"type":"string"},"type":"array","description":"PostJoinCommands are commands that will be executed after the join process starts."},"containerd":{"$ref":"#/$defs/ContainerdJoin","description":"Containerd holds configuration for the containerd join process."},"caCertPath":{"type":"string","description":"CACertPath is the path to the SSL certificate authority used to\nsecure communications between node and control-plane.\nDefaults to \"/etc/kubernetes/pki/ca.crt\"."},"skipPhases":{"items":{"type":"string"},"type":"array","description":"SkipPhases is a list of phases to skip during command execution.\nThe list of phases can be obtained with the \"kubeadm join --help\" command."},"nodeRegistration":{"$ref":"#/$defs/NodeRegistration","description":"NodeRegistration holds configuration for the node registration similar to the kubeadm node registration."}},"additionalProperties":false,"type":"object"},"StandardLabelSelector":{"properties":{"matchLabels":{"additionalProperties":{"type":"string"},"type":"object"},"matchExpressions":{"items":{"$ref":"#/$defs/LabelSelectorRequirement"},"type":"array"}},"additionalProperties":false,"type":"object"},"StartupProbe":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."},"failureThreshold":{"type":"integer","description":"Number of consecutive failures allowed before failing the pod"},"timeoutSeconds":{"type":"integer","description":"Maximum duration (in seconds) that the probe will wait for a response."},"periodSeconds":{"type":"integer","description":"Frequency (in seconds) to perform the probe"}},"additionalProperties":false,"type":"object","description":"StartupProbe defines the configuration for the startup probe."},"StatefulSetImage":{"properties":{"registry":{"type":"string","description":"Configure the registry of the container image, e.g. my-registry.com or ghcr.io\nIt defaults to ghcr.io and can be overriding either by using this field or controlPlane.advanced.defaultImageRegistry"},"repository":{"type":"string","description":"Configure the repository of the container image, e.g. my-repo/my-image.\nIt defaults to the vCluster pro repository that includes the optional pro modules that are turned off by default.\nIf you still want to use the pure OSS build, use 'loft-sh/vcluster-oss' instead."},"tag":{"type":"string","description":"Tag is the tag of the container image, e.g. latest"}},"additionalProperties":false,"type":"object"},"Sync":{"properties":{"toHost":{"$ref":"#/$defs/SyncToHost","description":"Configure resources to sync from the virtual cluster to the host cluster."},"fromHost":{"$ref":"#/$defs/SyncFromHost","description":"Configure what resources vCluster should sync from the host cluster to the virtual cluster."}},"additionalProperties":false,"type":"object"},"SyncAllResource":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."},"all":{"type":"boolean","description":"All defines if all resources of that type should get synced or only the necessary ones that are needed."},"patches":{"items":{"$ref":"#/$defs/TranslatePatch"},"type":"array","description":"Patches patch the resource according to the provided specification."}},"additionalProperties":false,"type":"object"},"SyncFromHost":{"properties":{"nodes":{"$ref":"#/$defs/SyncNodes","description":"Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back."},"events":{"$ref":"#/$defs/EnableSwitchWithPatches","description":"Events defines if events should get synced from the host cluster to the virtual cluster, but not back."},"ingressClasses":{"$ref":"#/$defs/EnableSwitchWithPatchesAndSelector","description":"IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back."},"runtimeClasses":{"$ref":"#/$defs/EnableSwitchWithPatchesAndSelector","description":"RuntimeClasses defines if runtime classes should get synced from the host cluster to the virtual cluster, but not back."},"priorityClasses":{"$ref":"#/$defs/EnableSwitchWithPatchesAndSelector","description":"PriorityClasses defines if priority classes classes should get synced from the host cluster to the virtual cluster, but not back."},"storageClasses":{"$ref":"#/$defs/EnableAutoSwitchWithPatchesAndSelector","description":"StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."},"csiNodes":{"$ref":"#/$defs/EnableAutoSwitchWithPatches","description":"CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."},"csiDrivers":{"$ref":"#/$defs/EnableAutoSwitchWithPatches","description":"CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."},"csiStorageCapacities":{"$ref":"#/$defs/EnableAutoSwitchWithPatches","description":"CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled."},"customResources":{"additionalProperties":{"$ref":"#/$defs/SyncFromHostCustomResource"},"type":"object","description":"CustomResources defines what custom resources should get synced read-only to the virtual cluster from the host cluster. vCluster will automatically add any required RBAC to the vCluster cluster role."},"volumeSnapshotClasses":{"$ref":"#/$defs/EnableSwitchWithPatches","description":"VolumeSnapshotClasses defines if volume snapshot classes created within the virtual cluster should get synced to the host cluster."},"configMaps":{"$ref":"#/$defs/EnableSwitchWithResourcesMappings","description":"ConfigMaps defines if config maps in the host should get synced to the virtual cluster."},"secrets":{"$ref":"#/$defs/EnableSwitchWithResourcesMappings","description":"Secrets defines if secrets in the host should get synced to the virtual cluster."}},"additionalProperties":false,"type":"object"},"SyncFromHostCustomResource":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."},"scope":{"type":"string","description":"Scope defines the scope of the resource"},"patches":{"items":{"$ref":"#/$defs/TranslatePatch"},"type":"array","description":"Patches patch the resource according to the provided specification."},"mappings":{"$ref":"#/$defs/FromHostMappings","description":"Mappings for Namespace and Object"}},"additionalProperties":false,"type":"object","required":["enabled","scope"]},"SyncNodeSelector":{"properties":{"all":{"type":"boolean","description":"All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to."},"labels":{"additionalProperties":{"type":"string"},"type":"object","description":"Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value."}},"additionalProperties":false,"type":"object"},"SyncNodes":{"properties":{"enabled":{"type":"boolean","description":"Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead."},"syncBackChanges":{"type":"boolean","description":"SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node."},"clearImageStatus":{"type":"boolean","description":"ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node."},"selector":{"$ref":"#/$defs/SyncNodeSelector","description":"Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster."},"patches":{"items":{"$ref":"#/$defs/TranslatePatch"},"type":"array","description":"Patches patch the resource according to the provided specification."}},"additionalProperties":false,"type":"object"},"SyncPods":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if pod syncing should be enabled."},"translateImage":{"additionalProperties":{"type":"string"},"type":"object","description":"TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite\na certain image that is used within the virtual cluster to be another image on the host cluster"},"enforceTolerations":{"items":{"type":"string"},"type":"array","description":"EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster."},"useSecretsForSATokens":{"type":"boolean","description":"UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a\npod annotation."},"runtimeClassName":{"type":"string","description":"RuntimeClassName is the runtime class to set for synced pods."},"priorityClassName":{"type":"string","description":"PriorityClassName is the priority class to set for synced pods."},"rewriteHosts":{"$ref":"#/$defs/SyncRewriteHosts","description":"RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add\na small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by\nthe virtual cluster."},"patches":{"items":{"$ref":"#/$defs/TranslatePatch"},"type":"array","description":"Patches patch the resource according to the provided specification."},"hybridScheduling":{"$ref":"#/$defs/HybridScheduling","description":"HybridScheduling is used to enable and configure hybrid scheduling for pods in the virtual cluster."}},"additionalProperties":false,"type":"object"},"SyncRewriteHosts":{"properties":{"enabled":{"type":"boolean","description":"Enabled specifies if rewriting stateful set pods should be enabled."},"initContainer":{"$ref":"#/$defs/SyncRewriteHostsInitContainer","description":"InitContainer holds extra options for the init container used by vCluster to rewrite the FQDN for stateful set pods."}},"additionalProperties":false,"type":"object"},"SyncRewriteHostsInitContainer":{"properties":{"image":{"type":"string","description":"Image is the image virtual cluster should use to rewrite this FQDN."},"resources":{"$ref":"#/$defs/Resources","description":"Resources are the resources that should be assigned to the init container for each stateful set init container."}},"additionalProperties":false,"type":"object"},"SyncToHost":{"properties":{"pods":{"$ref":"#/$defs/SyncPods","description":"Pods defines if pods created within the virtual cluster should get synced to the host cluster."},"secrets":{"$ref":"#/$defs/SyncAllResource","description":"Secrets defines if secrets created within the virtual cluster should get synced to the host cluster."},"configMaps":{"$ref":"#/$defs/SyncAllResource","description":"ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster."},"ingresses":{"$ref":"#/$defs/EnableSwitchWithPatches","description":"Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster."},"services":{"$ref":"#/$defs/EnableSwitchWithPatches","description":"Services defines if services created within the virtual cluster should get synced to the host cluster."},"endpoints":{"$ref":"#/$defs/EnableSwitchWithPatches","description":"Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster."},"networkPolicies":{"$ref":"#/$defs/EnableSwitchWithPatches","description":"NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster."},"persistentVolumeClaims":{"$ref":"#/$defs/EnableSwitchWithPatches","description":"PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster."},"persistentVolumes":{"$ref":"#/$defs/EnableSwitchWithPatches","description":"PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster."},"volumeSnapshots":{"$ref":"#/$defs/EnableSwitchWithPatches","description":"VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster."},"volumeSnapshotContents":{"$ref":"#/$defs/EnableSwitchWithPatches","description":"VolumeSnapshotContents defines if volume snapshot contents created within the virtual cluster should get synced to the host cluster."},"storageClasses":{"$ref":"#/$defs/EnableSwitchWithPatches","description":"StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster."},"serviceAccounts":{"$ref":"#/$defs/EnableSwitchWithPatches","description":"ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster."},"podDisruptionBudgets":{"$ref":"#/$defs/EnableSwitchWithPatches","description":"PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster."},"priorityClasses":{"$ref":"#/$defs/EnableSwitchWithPatches","description":"PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster."},"customResources":{"additionalProperties":{"$ref":"#/$defs/SyncToHostCustomResource"},"type":"object","description":"CustomResources defines what custom resources should get synced from the virtual cluster to the host cluster. vCluster will copy the definition automatically from host cluster to virtual cluster on startup.\nvCluster will also automatically add any required RBAC permissions to the vCluster role for this to work."},"namespaces":{"$ref":"#/$defs/SyncToHostNamespaces","description":"Namespaces defines if namespaces created within the virtual cluster should get synced to the host cluster."}},"additionalProperties":false,"type":"object"},"SyncToHostCustomResource":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."},"scope":{"type":"string","description":"Scope defines the scope of the resource. If undefined, will use Namespaced. Currently only Namespaced is supported."},"patches":{"items":{"$ref":"#/$defs/TranslatePatch"},"type":"array","description":"Patches patch the resource according to the provided specification."}},"additionalProperties":false,"type":"object","required":["enabled"]},"SyncToHostNamespaces":{"properties":{"enabled":{"type":"boolean","description":"Enabled defines if this option should be enabled."},"patches":{"items":{"$ref":"#/$defs/TranslatePatch"},"type":"array","description":"Patches patch the resource according to the provided specification."},"mappings":{"$ref":"#/$defs/FromHostMappings","description":"Mappings for Namespace and Object"},"mappingsOnly":{"type":"boolean","description":"MappingsOnly defines if creation of namespaces not matched by mappings should be allowed."},"extraLabels":{"additionalProperties":{"type":"string"},"type":"object","description":"ExtraLabels are additional labels to add to the namespace in the host cluster."}},"additionalProperties":false,"type":"object","required":["enabled"],"description":"SyncToHostNamespaces defines how namespaces should be synced from the virtual cluster to the host cluster."},"Telemetry":{"properties":{"enabled":{"type":"boolean","description":"Enabled specifies that the telemetry for the vCluster control plane should be enabled."},"instanceCreator":{"type":"string"},"machineID":{"type":"string"},"platformUserID":{"type":"string"},"platformInstanceID":{"type":"string"}},"additionalProperties":false,"type":"object"},"TranslatePatch":{"properties":{"path":{"type":"string","description":"Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied."},"expression":{"type":"string","description":"Expression transforms the value according to the given JavaScript expression."},"reverseExpression":{"type":"string","description":"ReverseExpression transforms the value according to the given JavaScript expression."},"reference":{"$ref":"#/$defs/TranslatePatchReference","description":"Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode\nautomatically. In single-namespace mode this will translate the name to \"vxxxxxxxxx\" to avoid conflicts with\nother names, in multi-namespace mode this will not translate the name."},"labels":{"$ref":"#/$defs/TranslatePatchLabels","description":"Labels treats the path value as a labels selector."}},"additionalProperties":false,"type":"object","required":["path"]},"TranslatePatchLabels":{"properties":{},"additionalProperties":false,"type":"object"},"TranslatePatchReference":{"properties":{"apiVersion":{"type":"string","description":"APIVersion is the apiVersion of the referenced object."},"apiVersionPath":{"type":"string","description":"APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion."},"kind":{"type":"string","description":"Kind is the kind of the referenced object."},"kindPath":{"type":"string","description":"KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind."},"namePath":{"type":"string","description":"NamePath is the optional relative path to the reference name within the object."},"namespacePath":{"type":"string","description":"NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the\nmetadata.namespace path of the object."}},"additionalProperties":false,"type":"object","required":["apiVersion","kind"]},"ValidatingWebhook":{"properties":{"name":{"type":"string","description":"The name of the admission webhook.\nName should be fully qualified, e.g., imagepolicy.kubernetes.io, where\n\"imagepolicy\" is the name of the webhook, and kubernetes.io is the name\nof the organization."},"clientConfig":{"$ref":"#/$defs/ValidatingWebhookClientConfig","description":"ClientConfig defines how to communicate with the hook."},"rules":{"items":true,"type":"array","description":"Rules describes what operations on what resources/subresources the webhook cares about.\nThe webhook cares about an operation if it matches _any_ Rule."},"failurePolicy":{"type":"string","description":"FailurePolicy defines how unrecognized errors from the admission endpoint are handled -\nallowed values are Ignore or Fail. Defaults to Fail."},"matchPolicy":{"type":"string","description":"matchPolicy defines how the \"rules\" list is used to match incoming requests.\nAllowed values are \"Exact\" or \"Equivalent\"."},"namespaceSelector":{"description":"NamespaceSelector decides whether to run the webhook on an object based\non whether the namespace for that object matches the selector. If the\nobject itself is a namespace, the matching is performed on\nobject.metadata.labels. If the object is another cluster scoped resource,\nit never skips the webhook."},"objectSelector":{"description":"ObjectSelector decides whether to run the webhook based on if the\nobject has matching labels. objectSelector is evaluated against both\nthe oldObject and newObject that would be sent to the webhook, and\nis considered to match if either object matches the selector."},"sideEffects":{"type":"string","description":"SideEffects states whether this webhook has side effects."},"timeoutSeconds":{"type":"integer","description":"TimeoutSeconds specifies the timeout for this webhook."},"admissionReviewVersions":{"items":{"type":"string"},"type":"array","description":"AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`\nversions the Webhook expects."},"matchConditions":{"items":true,"type":"array","description":"MatchConditions is a list of conditions that must be met for a request to be sent to this\nwebhook. Match conditions filter requests that have already been matched by the rules,\nnamespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.\nThere are a maximum of 64 match conditions allowed."}},"additionalProperties":false,"type":"object"},"ValidatingWebhookClientConfig":{"properties":{"url":{"type":"string","description":"URL gives the location of the webhook, in standard URL form\n(`scheme://host:port/path`). Exactly one of `url` or `service`\nmust be specified."},"service":{"$ref":"#/$defs/ValidatingWebhookServiceReference","description":"Service is a reference to the service for this webhook. Either\n`service` or `url` must be specified.\n\nIf the webhook is running within the cluster, then you should use `service`."},"caBundle":{"type":"string","contentEncoding":"base64","description":"CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.\nIf unspecified, system trust roots on the apiserver are used."}},"additionalProperties":false,"type":"object","description":"ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook"},"ValidatingWebhookConfiguration":{"properties":{"kind":{"type":"string","description":"Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to."},"apiVersion":{"type":"string","description":"APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values."},"metadata":{"$ref":"#/$defs/ObjectMeta","description":"Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata."},"webhooks":{"items":{"$ref":"#/$defs/ValidatingWebhook"},"type":"array","description":"Webhooks is a list of webhooks and the affected resources and operations."}},"additionalProperties":false,"type":"object"},"ValidatingWebhookServiceReference":{"properties":{"namespace":{"type":"string","description":"Namespace is the namespace of the service."},"name":{"type":"string","description":"Name is the name of the service."},"path":{"type":"string","description":"Path is an optional URL path which will be sent in any request to\nthis service."},"port":{"type":"integer","description":"If specified, the port on the service that hosting webhook.\nDefault to 443 for backward compatibility.\n`port` should be a valid port number (1-65535, inclusive)."}},"additionalProperties":false,"type":"object"},"VirtualClusterKubeConfig":{"properties":{"kubeConfig":{"type":"string","description":"KubeConfig is the virtual cluster kubeconfig path."},"serverCAKey":{"type":"string","description":"ServerCAKey is the server ca key path."},"serverCACert":{"type":"string","description":"ServerCAKey is the server ca cert path."},"clientCACert":{"type":"string","description":"ServerCAKey is the client ca cert path."},"requestHeaderCACert":{"type":"string","description":"RequestHeaderCACert is the request header ca cert path."}},"additionalProperties":false,"type":"object"},"VolumeClaim":{"properties":{"enabled":{"oneOf":[{"type":"string"},{"type":"boolean"}],"description":"Enabled enables deploying a persistent volume claim. If auto, vCluster will automatically determine\nbased on the chosen distro and other options if this is required."},"accessModes":{"items":{"type":"string"},"type":"array","description":"AccessModes are the persistent volume claim access modes."},"retentionPolicy":{"type":"string","description":"RetentionPolicy is the persistent volume claim retention policy."},"size":{"type":"string","description":"Size is the persistent volume claim storage size."},"storageClass":{"type":"string","description":"StorageClass is the persistent volume claim storage class."}},"additionalProperties":false,"type":"object"},"VolumeMount":{"properties":{"name":{"type":"string","description":"This must match the Name of a Volume."},"readOnly":{"type":"boolean","description":"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false."},"mountPath":{"type":"string","description":"Path within the container at which the volume should be mounted.  Must\nnot contain ':'."},"subPath":{"type":"string","description":"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)."},"mountPropagation":{"type":"string","description":"mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10."},"subPathExpr":{"type":"string","description":"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive."}},"additionalProperties":false,"type":"object","description":"VolumeMount describes a mounting of a Volume within a container."}},"properties":{"global":{"description":"Global values shared across all (sub)charts"},"exportKubeConfig":{"$ref":"#/$defs/ExportKubeConfig","description":"ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file."},"sync":{"$ref":"#/$defs/Sync","description":"Sync describes how to sync resources from the virtual cluster to host cluster and back."},"integrations":{"$ref":"#/$defs/Integrations","description":"Integrations holds config for vCluster integrations with other operators or tools running on the host cluster"},"deploy":{"$ref":"#/$defs/Deploy","description":"Deploy holds configuration for the deployment of vCluster."},"networking":{"$ref":"#/$defs/Networking","description":"Networking options related to the virtual cluster."},"policies":{"$ref":"#/$defs/Policies","description":"Policies to enforce for the virtual cluster deployment as well as within the virtual cluster."},"controlPlane":{"$ref":"#/$defs/ControlPlane","description":"Configure vCluster's control plane components and deployment."},"privateNodes":{"$ref":"#/$defs/PrivateNodes","description":"PrivateNodes holds configuration for vCluster private nodes mode."},"rbac":{"$ref":"#/$defs/RBAC","description":"RBAC options for the virtual cluster."},"plugins":{"anyOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"object"},{"type":"object"}],"additionalProperties":{"$ref":"#/$defs/Plugins"},"description":"Define which vCluster plugins to load."},"experimental":{"$ref":"#/$defs/Experimental","description":"Experimental features for vCluster. Configuration here might change, so be careful with this."},"external":{"$ref":"#/$defs/ExternalConfig","description":"External holds configuration for tools that are external to the vCluster."},"telemetry":{"$ref":"#/$defs/Telemetry","description":"Configuration related to telemetry gathered about vCluster usage."},"serviceCIDR":{"type":"string","description":"ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore."},"pro":{"type":"boolean","description":"Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore."},"plugin":{"anyOf":[{"patternProperties":{".*":{"type":"string"}},"type":"object"},{"type":"object"},{"type":"object"}],"additionalProperties":{"$ref":"#/$defs/Plugin"},"description":"Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore."},"sleepMode":{"$ref":"#/$defs/SleepMode","description":"SleepMode holds the native sleep mode configuration for Pro clusters"},"logging":{"$ref":"#/$defs/Logging","description":"Logging provides structured logging options"}},"additionalProperties":false,"type":"object","description":"Config is the vCluster config."}
</schema>

[User] Provide a JSON object that satisfies the schema "vcluster.schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.

Service is a reference to the service for the API server.

APIService holds configuration related to the api server

Name is the name of the host service of the apiservice.

Namespace is the name of the host service of the apiservice.

Port is the target port on the host service to connect to.

APIServiceService holds the service name and namespace of the host apiservice.

AfterInactivity specifies after how many seconds of inactivity the virtual cluster be deleted
+optional

AfterInactivity specifies after how many seconds of inactivity the virtual cluster should sleep
+optional

Schedule specifies scheduled virtual cluster sleep in Cron format, see https://en.wikipedia.org/wiki/Cron.
Note: timezone defined in the schedule string will be ignored. Use ".Timezone" field instead.
+optional

Timezone specifies time zone used for scheduled virtual cluster operations. Defaults to UTC.
Accepts the same format as time.LoadLocation() in Go (https://pkg.go.dev/time#LoadLocation).
The value should be a location name corresponding to a file in the IANA Time Zone database, such as "America/New_York".
+optional

AutoSleep holds configuration for automatic wakeup
+optional

AutoSleepExclusion holds conifiguration for excluding workloads from sleeping by label(s)

Enabled defines if auto upgrade should be enabled.

Image is the image for the auto upgrade pod started by vCluster. If empty defaults to the controlPlane.statefulSet.image.

ImagePullPolicy is the policy how to pull the image.

NodeSelector is the node selector for the auto upgrade. If empty will select all worker nodes.

BundleRepository is the repository to use for downloading the Kubernetes bundle. Defaults to https://github.com/loft-sh/kubernetes/releases/download

BinariesPath is the base path for the kubeadm binaries. Defaults to /usr/local/bin

CNIBinariesPath is the base path for the CNI binaries. Defaults to /opt/cni/bin

Concurrency is the number of nodes that can be upgraded at the same time.

AutoWakeup holds the cron schedule to wake workloads automatically

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

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.

Flannel holds dedicated Flannel configuration.

Enabled defines if Flannel should be enabled.

Image is the image for Flannel main container.

InitImage is the image for Flannel init container.

ValidatingWebhooks are validating webhooks that should be enforced in the virtual cluster

MutatingWebhooks are mutating webhooks that should be enforced in the virtual cluster

Enabled defines if this option should be enabled.

Sync contains advanced configuration for syncing cert-manager resources.

CertManager reuses a host cert-manager and makes its CRDs from it available inside the vCluster

ClusterIssuers defines if (and which) cluster issuers should get synced from the host cluster to the virtual cluster.

Certificates defines if certificates should get synced from the virtual cluster to the host cluster.

Issuers defines if issuers should get synced from the virtual cluster to the host cluster.

Selector defines what cluster issuers should be imported.

Selector defines what cluster stores should be synced

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

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

ImportImages is a list of images to import into the containerd registry from local files. If the path is a folder, all files that end with .tar or .tar.gz in the folder will be imported.

PauseImage is the image for the pause container.

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 are paths to CA certificates to use for the containerd registry mirror.

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

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

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

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

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

ConfigPath is the path to the containerd registry config.

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.

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

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

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

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

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

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

HostPathMapper defines if vCluster should rewrite host paths.

Ingress defines options for vCluster ingress deployed by Helm.

Service defines options for vCluster service deployed by Helm.

StatefulSet defines options for vCluster statefulSet deployed by Helm.

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

Advanced holds additional configuration for the vCluster control plane.

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 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.

ServiceAccount specifies options for the vCluster control plane service account.

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

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

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

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.

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

Annotations are extra annotations for this resource.

Labels are extra labels for this resource.

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

LeaseDuration is the time to lease for the leader.

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

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

Enabled defines if the control plane ingress should be enabled

Host is the host where vCluster will be reachable

PathType is the path type of the ingress

Spec allows you to configure extra ingress options.

VolumeClaim can be used to configure the persistent volume claim.

VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet

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

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 defines extra volumes for the pod

AddVolumeMounts defines extra volume mounts for the container

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

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

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

BindAddress under which vCluster will expose the proxy.

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

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

NodeSelector is the node selector to apply to the pod.

Affinity is the affinity to apply to the pod.

Tolerations are the tolerations to apply to the pod.

PriorityClassName is the priority class name for the the pod.

PodManagementPolicy is the statefulSet pod management policy.

TopologySpreadConstraints are the topology spread constraints for the pod.

PodSecurityContext specifies security context options on the pod level.

ContainerSecurityContext specifies security context options on the container level.

Enabled defines if the control plane service should be enabled

Spec allows you to configure extra service options.

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

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

Annotations are extra annotations for this resource.

Labels are extra labels for this resource.

Enabled specifies if the service account should get deployed.

Name specifies what name to use for the service account.

ImagePullSecrets defines extra image pull secrets for the service account.

HighAvailability holds options related to high availability.

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

Scheduling holds options related to scheduling.

Security defines pod or container security context.

Probes enables or disables the main container probes.

Persistence defines options around persistence for the statefulSet.

EnableServiceLinks for the StatefulSet pod

Additional labels or annotations for the statefulSet pods.

Image is the image for the controlPlane statefulSet container

ImagePullPolicy is the policy how to pull the image.

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

Command allows you to override the main command.

Args allows you to override the main arguments.

Env are additional environment variables for the statefulSet container.

Set DNS policy for the pod.

Specifies the DNS parameters of a pod.

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

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

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

Annotations are extra annotations for this resource.

Labels are extra labels for this resource.

Enabled defines if coredns is enabled

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 defines pod or container security context.

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

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

OverwriteConfig can be used to overwrite the coredns config

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

PriorityClassName specifies the priority class name for the CoreDNS pods.

Image is the coredns image to use

Replicas is the amount of coredns pods to run.

NodeSelector is the node selector to use for coredns.

Affinity is the affinity to apply to the pod.

Tolerations are the tolerations to apply to the pod.

Resources are the desired resources for coredns.

Pods is additional metadata for the coredns pods.

TopologySpreadConstraints are the topology spread constraints for the CoreDNS pod.

Spec holds extra options for the coredns service

Annotations are extra annotations for this resource.

Labels are extra labels for this resource.

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

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

Enabled defines if the database should be used.

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

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

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

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

ExtraArgs are additional arguments to pass to Kine.

The name of the check.

Namespace describe a list of namespaces that will be affected by the check.
An empty list means that all namespaces will be affected.
In case of ClusterScoped rules, only the Namespace resource is affected.

Rules describes on which verbs and on what resources/subresources the webhook is enforced.
The webhook is enforced if it matches any Rule.
The version of the request must match the rule version exactly. Equivalent matching is not supported.

ExcludedUsers describe a list of users for which the checks will be skipped.
Impersonation attempts on these users will still be subjected to the checks.

KubeProxy holds dedicated kube proxy configuration.

Metallb holds dedicated metallb configuration.

CNI holds dedicated CNI configuration.

LocalPathProvisioner holds dedicated local path provisioner configuration.

IngressNginx holds dedicated ingress-nginx configuration.

MetricsServer holds dedicated metrics server configuration.

Enabled defines if metrics server should be enabled.

K8S holds K8s relevant configuration.

[Deprecated] K3S holds K3s relevant configuration.

Enabled signals this container should be enabled.

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

ExtraArgs are additional arguments to pass to the distro binary.

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

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

Image is the distro image

ImagePullPolicy is the pull policy for the distro image

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

Resources for the distro init container

Security options can be used for the distro init container

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

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

APIServer holds configuration specific to starting the api server.

ControllerManager holds configuration specific to starting the controller manager.

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

Image is the distro image

Resources for the distro init container

Enabled defines if this option should be enabled.

Patches patch the resource according to the provided specification.

Selector defines the selector to use for the resource. If not set, all resources of that type will be synced.

Mappings for Namespace and Object

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

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

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

Enabled defines that an external etcd should be deployed.

StatefulSet holds options for the external etcd statefulSet.

Service holds options for the external etcd service.

HeadlessService holds options for the external etcd headless service.

Annotations are extra annotations for the external etcd headless service

Enabled defines if the etcd service should be deployed

Annotations are extra annotations for the external etcd service

Enabled defines if the statefulSet should be deployed

EnableServiceLinks for the StatefulSet pod

Image is the image to use for the external etcd statefulSet

ImagePullPolicy is the pull policy for the external etcd image

Env are extra environment variables

ExtraArgs are appended to the etcd command.

Resources the etcd can consume

Pods defines extra metadata for the etcd pods.

HighAvailability are high availability options

Scheduling options for the etcd pods.

Security options for the etcd pods.

Persistence options for the etcd pods.

Annotations are extra annotations for this resource.

Labels are extra labels for this resource.

Enabled defines if the embedded etcd should be used.

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

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

ExtraArgs are additional arguments to pass to the embedded etcd.

Enabled defines if the external etcd should be used.

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

TLS defines the tls configuration for the external etcd server

CaFile is the path to the ca file

CertFile is the path to the cert file

KeyFile is the path to the key file

EtcdExternalTLS defines tls for external etcd server

Deploy allows you to configure manifests and Helm charts to deploy within the host or virtual cluster.

SyncSettings are advanced settings for the syncer controller.

GenericSync holds options to generically sync resources from virtual cluster to host.

IsolatedControlPlane is a feature to run the vCluster control plane in a different Kubernetes cluster than the workloads themselves.

VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config.

DenyProxyRequests denies certain requests in the vCluster proxy.

Host defines what manifests to deploy into the host cluster

VCluster defines what manifests and charts to deploy into the vCluster

Chart defines what chart should get deployed.

Release defines what release should get deployed.

Values defines what values should get used.

Timeout defines the timeout for Helm

Bundle allows to compress the Helm chart and specify this instead of an online chart

Name of the release

Namespace of the release

Manifests are raw Kubernetes manifests that should get applied within the host cluster.

ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the host cluster.

Manifests are raw Kubernetes manifests that should get applied within the virtual cluster.

ManifestsTemplate is a Kubernetes manifest template that will be rendered with vCluster values before applying it within the virtual cluster.

Helm are Helm charts that should get deployed into the virtual cluster

Version is the config version

Exports syncs a resource from the virtual cluster to the host

Imports syncs a resource from the host cluster to virtual cluster

Hooks are hooks that can be used to inject custom patches before syncing

Enabled specifies if the isolated control plane feature should be enabled.

Headless states that Helm should deploy the vCluster in headless mode for the isolated control plane.

KubeConfig is the path where to find the remote workload cluster kubeconfig.

Namespace is the namespace where to sync the workloads into.

Service is the vCluster service in the remote cluster.

TargetNamespace is the namespace where the workloads should get synced to.

SetOwner specifies if vCluster should set an owner reference on the synced objects to the vCluster service. This allows for easy garbage collection.

HostMetricsBindAddress is the bind address for the local manager

VirtualMetricsBindAddress is the bind address for the virtual manager

APIVersion of the object to sync

Kind of the object to sync

ReplaceWhenInvalid determines if the controller should try to recreate the object
if there is a problem applying

Patches are the patches to apply on the virtual cluster objects
when syncing them from the host cluster

ReversePatches are the patches to apply to host cluster objects
after it has been synced to the virtual cluster

Selector is a label selector to select the synced objects in the virtual cluster.
If empty, all objects will be synced.

Context is the name of the context within the generated kubeconfig to use.

Override the default https://localhost:8443 and specify a custom hostname for the generated kubeconfig.

If tls should get skipped for the server

ServiceAccount can be used to generate a service account token instead of the default certificates.

Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.
If this is not defined, vCluster will create it with `vc-NAME`. If you specify another name,
vCluster creates the config in this other secret.

Deprecated: Use AdditionalSecrets instead.

AdditionalSecrets specifies the additional host cluster secrets in which vCluster will store the
generated virtual cluster kubeconfigs.

ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.

Name is the name of the secret where the kubeconfig is stored.

Namespace where vCluster stores the kubeconfig secret. If this is not equal to the namespace
where you deployed vCluster, you need to make sure vCluster has access to this other namespace.

ExportKubeConfigAdditionalSecretReference defines the additional host cluster secret in which vCluster stores the generated virtual cluster kubeconfigs.

Name is the name of the secret where the kubeconfig should get stored.

Namespace where vCluster should store the kubeconfig secret. If this is not equal to the namespace
where you deployed vCluster, you need to make sure vCluster has access to this other namespace.

Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.

Name of the service account to be used to generate a service account token instead of the default certificates.

Namespace of the service account to be used to generate a service account token instead of the default certificates.
If omitted, will use the kube-system namespace.

ClusterRole to assign to the service account.

platform holds platform configuration

ExternalConfig holds external configuration

Enabled defines if the database should be used.

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

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

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

ExtraArgs are additional arguments to pass to Kine.

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.

Replicas are the amount of pods to use.

VolumeClaim can be used to configure the persistent volume claim.

VolumeClaimTemplates defines the volumeClaimTemplates for the statefulSet

AddVolumes defines extra volumes for the pod

AddVolumeMounts defines extra volume mounts for the container

Enabled enables deploying a persistent volume claim.

AccessModes are the persistent volume claim access modes.

RetentionPolicy is the persistent volume claim retention policy.

Size is the persistent volume claim storage size.

StorageClass is the persistent volume claim storage class.

Enabled defines whether the external secret integration is enabled or not

Webhook defines whether the host webhooks are reused or not

Sync defines the syncing behavior for the integration

ExternalSecrets reuses a host external secret operator and makes certain CRDs from it available inside the vCluster

ExternalSecrets defines if external secrets should get synced from the virtual cluster to the host cluster.

Stores defines if secret stores should get synced from the virtual cluster to the host cluster and then bi-directionally.

ClusterStores defines if cluster secrets stores should get synced from the host cluster to the virtual cluster.

ByName is a map of host-object-namespace/host-object-name: virtual-object-namespace/virtual-object-name.
There are several wildcards supported:
1. To match all objects in host namespace and sync them to different namespace in vCluster:
byName:
  "foo/*": "foo-in-virtual/*"
2. To match specific object in the host namespace and sync it to the same namespace with the same name:
byName:
  "foo/my-object": "foo/my-object"
3. To match specific object in the host namespace and sync it to the same namespace with different name:
byName:
  "foo/my-object": "foo/my-virtual-object"
4. To match all objects in the vCluster host namespace and sync them to a different namespace in vCluster:
byName:
  "": "my-virtual-namespace/*"
5. To match specific objects in the vCluster host namespace and sync them to a different namespace in vCluster:
byName:
  "/my-object": "my-virtual-namespace/my-object"

APIVersion of the object to sync

Kind of the object to sync

Verbs are the verbs that the hook should mutate

Patches are the patches to apply on the object to be synced

HostToVirtual is a hook that is executed before syncing from the host to the virtual cluster

VirtualToHost is a hook that is executed before syncing from the virtual to the host cluster

Enabled specifies if the host path mapper will be used

Central specifies if the central host path mapper will be used

Enabled specifies if hybrid scheduling is enabled.

HostSchedulers is a list of schedulers that are deployed on the host cluster.

cidr is a string representing the IPBlock
Valid examples are "192.168.1.0/24" or "2001:db8::/64"

except is a slice of CIDRs that should not be included within an IPBlock
Valid examples are "192.168.1.0/24" or "2001:db8::/64"
Except values will be rejected if they are outside the cidr range
+optional

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 is the repository of the container image, e.g. my-repo/my-image

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

Name of the image pull secret to use.

APIVersion of the object to sync

Kind of the object to sync

ReplaceWhenInvalid determines if the controller should try to recreate the object
if there is a problem applying

Patches are the patches to apply on the virtual cluster objects
when syncing them from the host cluster

ReversePatches are the patches to apply to host cluster objects
after it has been synced to the virtual cluster

Enabled defines if ingress-nginx should be enabled.

DefaultIngressClass defines if the deployed ingress class should be the default ingress class.

MetricsServer reuses the metrics server from the host cluster within the vCluster.

KubeVirt reuses a host kubevirt and makes certain CRDs from it available inside the vCluster

ExternalSecrets reuses a host external secret operator and makes certain CRDs from it available inside the vCluster.
- ExternalSecrets will be synced from the virtual cluster to the host cluster.
- SecretStores will be synced from the virtual cluster to the host cluster and then bi-directionally.
- ClusterSecretStores will be synced from the host cluster to the virtual cluster.

CertManager reuses a host cert-manager and makes its CRDs from it available inside the vCluster.
- Certificates and Issuers will be synced from the virtual cluster to the host cluster.
- ClusterIssuers will be synced from the host cluster to the virtual cluster.

Istio syncs DestinationRules, Gateways and VirtualServices from virtual cluster to the host.

Integrations holds config for vCluster integrations with other operators or tools running on the host cluster

Enabled defines if this option should be enabled.

PreJoinCommands are commands that will be executed before the join process starts.

PostJoinCommands are commands that will be executed after the join process starts.

Containerd holds configuration for the containerd join process.

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 is a list of phases to skip during command execution.
The list of phases can be obtained with the "kubeadm join --help" command.

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

Server holds configuration for the konnectivity server.

Agent holds configuration for the konnectivity agent.

Enabled defines if the konnectivity agent should be enabled.

Replicas is the number of replicas for the konnectivity agent.

Image is the image for the konnectivity agent.

ImagePullPolicy is the policy how to pull the image.

NodeSelector is the node selector for the konnectivity agent.

PriorityClassName is the priority class name for the konnectivity agent.

Tolerations is the tolerations for the konnectivity agent.

ExtraEnv is the extra environment variables for the konnectivity agent.

ExtraArgs are additional arguments to pass to the konnectivity agent.

Enabled defines if the konnectivity server should be enabled.

ExtraArgs are additional arguments to pass to the konnectivity server.

Enabled defines if the kube proxy should be enabled.

Image is the image for the kube-proxy.

NodeSelector is the node selector for the kube-proxy.

PriorityClassName is the priority class name for the kube-proxy.

Tolerations is the tolerations for the kube-proxy.

ExtraEnv is the extra environment variables for the kube-proxy.

ExtraArgs are additional arguments to pass to the kube-proxy.

Enabled signals if the integration should be enabled

APIService holds information about where to find the virt-api service. Defaults to virt-api/kubevirt.

Webhook holds configuration for enabling the webhook within the vCluster

Sync holds configuration on what resources to sync

KubeVirt reuses a host kubevirt and makes certain CRDs from it available inside the vCluster

If DataVolumes should get synced

If VirtualMachineInstanceMigrations should get synced

If VirtualMachineInstances should get synced

If VirtualMachines should get synced

If VirtualMachineClones should get synced

If VirtualMachinePools should get synced

KubeVirtSync are the crds that are supported by this integration

CgroupDriver defines the cgroup driver to use for the kubelet.

Name is the name of the argument.

Value is the value of the argument.

KubeletExtraArg represents an argument with a name and a value.

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

The taint value corresponding to the taint key.
+optional

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

Labels defines what labels should be looked for

Annotations are extra annotations for this resource.

Labels are extra labels for this resource.

Enabled defines if the limit range should be deployed by vCluster. "auto" means that if resourceQuota is enabled,
the limitRange will be enabled as well.

Default are the default limits for the limit range

DefaultRequest are the default request options for the limit range

Max are the max limits for the limit range

Min are the min limits for the limit range

Enabled defines if this option should be enabled.

Number of consecutive failures for the probe to be considered failed

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

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

Frequency (in seconds) to perform the probe

LivenessProbe defines the configuration for the liveness probe.

Enabled defines if LocalPathProvisioner should be enabled.

Image is the image for local path provisioner.

ImagePullPolicy is the policy how to pull the image.

NodePath is the path on the node where to create the persistent volume directories.

Encoding specifies the format of vCluster logs, it can either be json or console.

Logging holds the log encoding details

Enabled defines if metallb should be enabled.

ControllerImage is the image for metallb controller.

SpeakerImage is the image for metallb speaker.

IPAddressPool is the IP address pool to use for metallb.

Addresses is a list of IP addresses to use for the IP address pool.

L2Advertisement defines if L2 advertisement should be enabled for the IP address pool.

Enabled signals the metrics server integration should be enabled.

APIService holds information about where to find the metrics-server service. Defaults to metrics-server/kube-system.

Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.

Pods defines if metrics-server pods api should get proxied from host to virtual cluster.

MetricsServer reuses the metrics server from the host cluster within the vCluster.

reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation.
Allowed values are "Never" and "IfNeeded".

The name of the admission webhook.
Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where
"imagepolicy" is the name of the webhook, and kubernetes.io is the name
of the organization.

ClientConfig defines how to communicate with the hook.

Rules describes what operations on what resources/subresources the webhook cares about.
The webhook cares about an operation if it matches _any_ Rule.

FailurePolicy defines how unrecognized errors from the admission endpoint are handled -
allowed values are Ignore or Fail. Defaults to Fail.

matchPolicy defines how the "rules" list is used to match incoming requests.
Allowed values are "Exact" or "Equivalent".

NamespaceSelector decides whether to run the webhook on an object based
on whether the namespace for that object matches the selector. If the
object itself is a namespace, the matching is performed on
object.metadata.labels. If the object is another cluster scoped resource,
it never skips the webhook.

ObjectSelector decides whether to run the webhook based on if the
object has matching labels. objectSelector is evaluated against both
the oldObject and newObject that would be sent to the webhook, and
is considered to match if either object matches the selector.

SideEffects states whether this webhook has side effects.

TimeoutSeconds specifies the timeout for this webhook.

AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`
versions the Webhook expects.

MatchConditions is a list of conditions that must be met for a request to be sent to this
webhook. Match conditions filter requests that have already been matched by the rules,
namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests.
There are a maximum of 64 match conditions allowed.

Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.

APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.

Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.

Webhooks is a list of webhooks and the affected resources and operations.

Enabled defines if the network policy should be deployed by vCluster.

FallbackDNS is the fallback DNS server to use if the virtual cluster does not have a DNS server.

OutgoingConnections are the outgoing connections options for the vCluster workloads.

ExtraControlPlaneRules are extra allowed rules for the vCluster control plane.

ExtraWorkloadRules are extra allowed rules for the vCluster workloads.

Annotations are extra annotations for this resource.

Labels are extra labels for this resource.

ByHostname will add a special vCluster hostname to the nodes where the node can be reached at. This doesn't work
for all applications, e.g. Prometheus requires a node IP.

ByIP will create a separate service in the host cluster for every node that will point to virtual cluster and will be used to
route traffic.

ServiceCIDR holds the service cidr for the virtual cluster. This should only be set if privateNodes.enabled is true or vCluster cannot detect the host service cidr.

PodCIDR holds the pod cidr for the virtual cluster. This should only be set if privateNodes.enabled is true.

ReplicateServices allows replicating services from the host within the virtual cluster or the other way around.

ResolveDNS allows to define extra DNS rules. This only works if embedded coredns is configured.

Advanced holds advanced network options.

ClusterDomain is the Kubernetes cluster domain to use within the virtual cluster.

FallbackHostCluster allows to fallback dns to the host cluster. This is useful if you want to reach host services without
any other modification. You will need to provide a namespace for the service, e.g. my-other-service.my-other-namespace

ProxyKubelets allows rewriting certain metrics and stats from the Kubelet to "fake" this for applications such as
prometheus or other node exporters.

CRI socket is the socket for the CRI.

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.

Taints are additional taints to set for the kubelet.

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 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.

Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.

Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.

Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata.

IPBlock describes a particular CIDR (Ex. "192.168.1.0/24","2001:db8::/64") that is allowed
to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs
that should not be included within this rule.

Platform enables egress access towards loft platform

Operation is the type of the patch

FromPath is the path from the other object

Path is the path of the patch

NamePath is the path to the name of a child resource within Path

NamespacePath is path to the namespace of a child resource within Path

Value is the new value to be set to the path

Regex - is regular expresion used to identify the Name,
and optionally Namespace, parts of the field value that
will be replaced with the rewritten Name and/or Namespace

Conditions are conditions that must be true for
the patch to get executed

Ignore determines if the path should be ignored if handled as a reverse patch

Sync defines if a specialized syncer should be initialized using values
from the rewriteName operation as Secret/Configmap names to be synced

Path is the path within the object to select

SubPath is the path below the selected object to select

Equal is the value the path should be equal to

NotEqual is the value the path should not be equal to

Empty means that the path value should be empty or unset

SecretName is the name of the secret where the platform access key is stored. This defaults to vcluster-platform-api-key if undefined.

Namespace defines the namespace where the access key secret should be retrieved from. If this is not equal to the namespace
where the vCluster instance is deployed, you need to make sure vCluster has access to this other namespace.

CreateRBAC will automatically create the necessary RBAC roles and role bindings to allow vCluster to read the secret specified
in the above namespace, if specified.
This defaults to true.

PlatformAPIKey defines where to find the platform access key.

Schedule specifies scheduled wakeup from sleep in Cron format, see https://en.wikipedia.org/wiki/Cron.
Note: timezone defined in the schedule string will be ignored. The timezone for the autoSleep schedule will be
used
+optional

APIKey defines where to find the platform access key and host. By default, vCluster will search in the following locations in this precedence:
* environment variable called LICENSE
* secret specified under external.platform.apiKey.secretName
* secret called "vcluster-platform-api-key" in the vCluster namespace

Project specifies which platform project the vcluster should be imported to

AutoSleep holds configuration for automatic sleep and wakeup
+optional

AutoDelete holds configuration for automatic delete
+optional

PlatformConfig holds platform configuration

Name is the name of the init-container and NOT the plugin name

Image is the container image that should be used for the plugin

ImagePullPolicy is the pull policy to use for the container image

Config is the plugin config to use. This can be arbitrary config used for the plugin.

RBAC holds additional rbac configuration for the plugin

Command is the command that should be used for the init container

Args are the arguments that should be used for the init container

SecurityContext is the container security context used for the init container

Resources are the container resources used for the init container

VolumeMounts are extra volume mounts for the init container

Version is the plugin version, this is only needed for legacy plugins.

ExtraRules are extra rbac permissions roles that will be added to role or cluster role

Role holds extra virtual cluster role permissions for the plugin

ClusterRole holds extra virtual cluster cluster role permissions required for the plugin

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

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.
+optional
+listType=atomic

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.
+optional
+listType=atomic

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

Required.

+optional

PodDNSConfigOption defines DNS resolver options of a pod.

NetworkPolicy specifies network policy options.

PodSecurityStandard that can be enforced can be one of: empty (""), baseline, restricted or privileged

ResourceQuota specifies resource quota options.

LimitRange specifies limit range options.

CentralAdmission defines what validating or mutating webhooks should be enforced within the virtual cluster.

Enabled defines if dedicated nodes should be enabled.

ImportNodeBinaries defines to use the loft-sh/kubernetes:VERSION-full image to also copy the node binaries to the control plane. This allows upgrades and
joining new nodes into the cluster without having to download the binaries from the internet.

Kubelet holds kubelet configuration that is used for all nodes.

AutoUpgrade holds configuration for auto upgrade.

JoinNode holds configuration specifically used during joining the node (see "kubeadm join").

PrivateNodes enables private nodes for vCluster.

Role holds virtual cluster role configuration

ClusterRole holds virtual cluster cluster role configuration

Enabled defines if the cluster role should be enabled or disabled. If auto, vCluster automatically determines whether the virtual cluster requires a cluster role.

ExtraRules will add rules to the cluster role.

OverwriteRules will overwrite the cluster role rules completely.

Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

APIGroups is the name of the APIGroup that contains the resources.  If multiple API groups are specified, any action requested against one of
the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.

Resources is a list of resources this rule applies to. '*' represents all resources.

ResourceNames is an optional white list of names that the rule applies to.  An empty set means that everything is allowed.

NonResourceURLs is a set of partial urls that a user should have access to.  *s are allowed, but only as the full, final step in the path
Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.
Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"),  but not both.

Enabled defines if the role should be enabled or disabled.

ExtraRules will add rules to the role.

OverwriteRules will overwrite the role rules completely.

Enabled defines if this option should be enabled.

Number of consecutive failures for the probe to be considered failed

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

Frequency (in seconds) to perform the probe

ReadinessProbe defines the configuration for the readiness probe.

Enabled defines if the embedded registry should be enabled.

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

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

ToHost defines the services that should get synced from virtual cluster to the host cluster. If services are
synced to a different namespace than the virtual cluster is in, additional permissions for the other namespace
are required.

FromHost defines the services that should get synced from the host to the virtual cluster.

Hostname is the hostname within the vCluster that should be resolved from.

Service is the virtual cluster service that should be resolved from.

Namespace is the virtual cluster namespace that should be resolved from.

Target is the DNS target that should get mapped to

Hostname to use as a DNS target

IP to use as a DNS target

HostService to target, format is hostNamespace/hostService

HostNamespace to target

VClusterService format is hostNamespace/vClusterName/vClusterNamespace/vClusterService

Enabled defines if the resource quota should be enabled. "auto" means that if limitRange is enabled,
the resourceQuota will be enabled as well.

Quota are the quota options

ScopeSelector is the resource quota scope selector

Scopes are the resource quota scopes

Annotations are extra annotations for this resource.

Labels are extra labels for this resource.

Limits are resource limits for the container

Requests are minimal resources that will be consumed by the container

APIGroups is the API groups the resources belong to. '*' is all groups.

APIVersions is the API versions the resources belong to. '*' is all versions.

Resources is a list of resources this rule applies to.

Scope specifies the scope of this rule.

Verb is the kube verb associated with the request for API requests, not the http verb. This includes things like list and watch.
For non-resource requests, this is the lowercase http verb.
If '*' is present, the length of the slice must be one.

LabelSelector are the labels to select the object from

From is the service that should get synced. Can be either in the form name or namespace/name.

To is the target service that it should get synced to. Can be either in the form name or namespace/name.

Enabled configures if Helm should create the service monitor.

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

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

Enabled toggles the sleep mode functionality, allowing for disabling sleep mode without removing other config

Timezone represents the timezone a sleep schedule should run against, defaulting to UTC if unset

AutoSleep holds autoSleep details

AutoWakeup holds configuration for waking the vCluster on a schedule rather than waiting for some activity.

SleepMode holds configuration for native/workload only sleep mode

AfterInactivity represents how long a vCluster can be idle before workloads are automaticaly put to sleep

Schedule represents a cron schedule for when to sleep workloads

Exclude holds configuration for labels that, if present, will prevent a workload from going to sleep

SleepModeAutoSleep holds configuration for allowing a vCluster to sleep its workloads automatically

Enabled defines if standalone mode should be enabled.

DataDir defines the data directory for the standalone mode.

BundleRepository is the repository to use for downloading the Kubernetes bundle. Defaults to https://github.com/loft-sh/kubernetes/releases/download

Bundle is a path to a Kubernetes bundle to use for the standalone mode. If empty, will use the bundleRepository to download the bundle.

JoinNode holds configuration for the standalone control plane node.

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.

Name defines the name of the standalone node. If empty the node will get the hostname as name.

PreJoinCommands are commands that will be executed before the join process starts.

PostJoinCommands are commands that will be executed after the join process starts.

Containerd holds configuration for the containerd join process.

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 is a list of phases to skip during command execution.
The list of phases can be obtained with the "kubeadm join --help" command.

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

Enabled defines if this option should be enabled.

Number of consecutive failures allowed before failing the pod

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

Frequency (in seconds) to perform the probe

StartupProbe defines the configuration for the startup probe.

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

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.

Tag is the tag of the container image, e.g. latest

Configure resources to sync from the virtual cluster to the host cluster.

Configure what resources vCluster should sync from the host cluster to the virtual cluster.

All defines if all resources of that type should get synced or only the necessary ones that are needed.

Patches patch the resource according to the provided specification.

Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back.

Events defines if events should get synced from the host cluster to the virtual cluster, but not back.

IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back.

RuntimeClasses defines if runtime classes should get synced from the host cluster to the virtual cluster, but not back.

PriorityClasses defines if priority classes classes should get synced from the host cluster to the virtual cluster, but not back.

StorageClasses defines if storage classes should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled.

CSINodes defines if csi nodes should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled.

CSIDrivers defines if csi drivers should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled.

CSIStorageCapacities defines if csi storage capacities should get synced from the host cluster to the virtual cluster, but not back. If auto, is automatically enabled when the virtual scheduler is enabled.

CustomResources defines what custom resources should get synced read-only to the virtual cluster from the host cluster. vCluster will automatically add any required RBAC to the vCluster cluster role.

VolumeSnapshotClasses defines if volume snapshot classes created within the virtual cluster should get synced to the host cluster.

ConfigMaps defines if config maps in the host should get synced to the virtual cluster.

Secrets defines if secrets in the host should get synced to the virtual cluster.

Enabled defines if this option should be enabled.

Scope defines the scope of the resource

Mappings for Namespace and Object

All specifies if all nodes should get synced by vCluster from the host to the virtual cluster or only the ones where pods are assigned to.

Labels are the node labels used to sync nodes from host cluster to virtual cluster. This will also set the node selector when syncing a pod from virtual cluster to host cluster to the same value.

Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.

SyncBackChanges enables syncing labels and taints from the virtual cluster to the host cluster. If this is enabled someone within the virtual cluster will be able to change the labels and taints of the host cluster node.

ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.

Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster.

Patches patch the resource according to the provided specification.

Enabled defines if pod syncing should be enabled.

TranslateImage maps an image to another image that should be used instead. For example this can be used to rewrite
a certain image that is used within the virtual cluster to be another image on the host cluster

EnforceTolerations will add the specified tolerations to all pods synced by the virtual cluster.

UseSecretsForSATokens will use secrets to save the generated service account tokens by virtual cluster instead of using a
pod annotation.

RuntimeClassName is the runtime class to set for synced pods.

PriorityClassName is the priority class to set for synced pods.

RewriteHosts is a special option needed to rewrite statefulset containers to allow the correct FQDN. virtual cluster will add
a small container to each stateful set pod that will initially rewrite the /etc/hosts file to match the FQDN expected by
the virtual cluster.

HybridScheduling is used to enable and configure hybrid scheduling for pods in the virtual cluster.

Enabled specifies if rewriting stateful set pods should be enabled.

InitContainer holds extra options for the init container used by vCluster to rewrite the FQDN for stateful set pods.

Image is the image virtual cluster should use to rewrite this FQDN.

Resources are the resources that should be assigned to the init container for each stateful set init container.

Pods defines if pods created within the virtual cluster should get synced to the host cluster.

Secrets defines if secrets created within the virtual cluster should get synced to the host cluster.

ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster.

Ingresses defines if ingresses created within the virtual cluster should get synced to the host cluster.

Services defines if services created within the virtual cluster should get synced to the host cluster.

Endpoints defines if endpoints created within the virtual cluster should get synced to the host cluster.

NetworkPolicies defines if network policies created within the virtual cluster should get synced to the host cluster.

PersistentVolumeClaims defines if persistent volume claims created within the virtual cluster should get synced to the host cluster.

PersistentVolumes defines if persistent volumes created within the virtual cluster should get synced to the host cluster.

VolumeSnapshots defines if volume snapshots created within the virtual cluster should get synced to the host cluster.

VolumeSnapshotContents defines if volume snapshot contents created within the virtual cluster should get synced to the host cluster.

StorageClasses defines if storage classes created within the virtual cluster should get synced to the host cluster.

ServiceAccounts defines if service accounts created within the virtual cluster should get synced to the host cluster.

PodDisruptionBudgets defines if pod disruption budgets created within the virtual cluster should get synced to the host cluster.

PriorityClasses defines if priority classes created within the virtual cluster should get synced to the host cluster.

CustomResources defines what custom resources should get synced from the virtual cluster to the host cluster. vCluster will copy the definition automatically from host cluster to virtual cluster on startup.
vCluster will also automatically add any required RBAC permissions to the vCluster role for this to work.

Namespaces defines if namespaces created within the virtual cluster should get synced to the host cluster.

Enabled defines if this option should be enabled.

Scope defines the scope of the resource. If undefined, will use Namespaced. Currently only Namespaced is supported.

Patches patch the resource according to the provided specification.

Mappings for Namespace and Object

MappingsOnly defines if creation of namespaces not matched by mappings should be allowed.

ExtraLabels are additional labels to add to the namespace in the host cluster.

SyncToHostNamespaces defines how namespaces should be synced from the virtual cluster to the host cluster.

Enabled specifies that the telemetry for the vCluster control plane should be enabled.

Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.

Expression transforms the value according to the given JavaScript expression.

ReverseExpression transforms the value according to the given JavaScript expression.

Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.

Labels treats the path value as a labels selector.

APIVersion is the apiVersion of the referenced object.

APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.

Kind is the kind of the referenced object.

KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.

NamePath is the optional relative path to the reference name within the object.

NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.

ClientConfig defines how to communicate with the hook.

Rules describes what operations on what resources/subresources the webhook cares about.
The webhook cares about an operation if it matches _any_ Rule.

FailurePolicy defines how unrecognized errors from the admission endpoint are handled -
allowed values are Ignore or Fail. Defaults to Fail.

matchPolicy defines how the "rules" list is used to match incoming requests.
Allowed values are "Exact" or "Equivalent".

SideEffects states whether this webhook has side effects.

TimeoutSeconds specifies the timeout for this webhook.

AdmissionReviewVersions is an ordered list of preferred `AdmissionReview`
versions the Webhook expects.

URL gives the location of the webhook, in standard URL form
(`scheme://host:port/path`). Exactly one of `url` or `service`
must be specified.

Service is a reference to the service for this webhook. Either
`service` or `url` must be specified.

If the webhook is running within the cluster, then you should use `service`.

CABundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate.
If unspecified, system trust roots on the apiserver are used.

ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook

Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.

Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.

Webhooks is a list of webhooks and the affected resources and operations.

Namespace is the namespace of the service.

Name is the name of the service.

Path is an optional URL path which will be sent in any request to
this service.

If specified, the port on the service that hosting webhook.
Default to 443 for backward compatibility.
`port` should be a valid port number (1-65535, inclusive).

KubeConfig is the virtual cluster kubeconfig path.

ServerCAKey is the server ca key path.

ServerCAKey is the server ca cert path.

ServerCAKey is the client ca cert path.

RequestHeaderCACert is the request header ca cert path.

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 are the persistent volume claim access modes.

RetentionPolicy is the persistent volume claim retention policy.

Size is the persistent volume claim storage size.

StorageClass is the persistent volume claim storage class.

This must match the Name of a Volume.

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

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

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

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.

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.

VolumeMount describes a mounting of a Volume within a container.

Global values shared across all (sub)charts

ExportKubeConfig describes how vCluster should export the vCluster kubeConfig file.

Sync describes how to sync resources from the virtual cluster to host cluster and back.

Integrations holds config for vCluster integrations with other operators or tools running on the host cluster

Deploy holds configuration for the deployment of vCluster.

Networking options related to the virtual cluster.

Policies to enforce for the virtual cluster deployment as well as within the virtual cluster.

Configure vCluster's control plane components and deployment.

PrivateNodes holds configuration for vCluster private nodes mode.

RBAC options for the virtual cluster.

Define which vCluster plugins to load.

Experimental features for vCluster. Configuration here might change, so be careful with this.

External holds configuration for tools that are external to the vCluster.

Configuration related to telemetry gathered about vCluster usage.

ServiceCIDR holds the service cidr for the virtual cluster. Do not use this option anymore.

Specifies whether to use vCluster Pro. This is automatically inferred in newer versions. Do not use that option anymore.

Plugin specifies which vCluster plugins to enable. Use "plugins" instead. Do not use this option anymore.

SleepMode holds the native sleep mode configuration for Pro clusters

Logging provides structured logging options

Config is the vCluster config.

Provide a JSON object that satisfies the schema "vcluster.schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.