{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://catalog.lintel.tools/schemas/schemastore/vcluster/latest.json", "description": "Config is the vCluster config.", "x-lintel": { "source": "https://raw.githubusercontent.com/loft-sh/vcluster/main/chart/values.schema.json", "sourceSha256": "c25068b8e0440cd6de8753c9aa461b894bea020ee4285871b91614c72f63608f", "fileMatch": [ "vCluster.yml", "vCluster.yaml", "vcluster.yaml", "vcluster.yml" ], "parsers": [ "yaml" ] }, "type": "object", "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": [ { "type": "object", "patternProperties": { ".*": { "type": "string" } } }, { "type": "object" }, { "type": "object" } ], "description": "Define which vCluster plugins to load.", "additionalProperties": { "$ref": "#/$defs/Plugins" } }, "experimental": { "$ref": "#/$defs/Experimental", "description": "Experimental features for vCluster. Configuration here might change, so be careful with this." }, "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": [ { "type": "object", "patternProperties": { ".*": { "type": "string" } } }, { "type": "object" }, { "type": "object" } ], "description": "Plugin specifies which vCluster plugins to enable. Use \"plugins\" instead. Do not use this option anymore.", "additionalProperties": { "$ref": "#/$defs/Plugin" } }, "logging": { "$ref": "#/$defs/Logging", "description": "Logging provides structured logging options" }, "sleep": { "$ref": "#/$defs/Sleep", "description": "Sleep holds configuration for automatically putting the virtual cluster to sleep." }, "snapshots": { "$ref": "#/$defs/Snapshots", "description": "Snapshots holds configuration for automatic vCluster snapshots." }, "deletion": { "$ref": "#/$defs/Deletion", "description": "Deletion holds configuration for automatic vCluster deletion." }, "platform": { "$ref": "#/$defs/Platform", "description": "Platform holds vCluster Platform specific configuration." } }, "$defs": { "APIService": { "properties": { "service": { "$ref": "#/$defs/APIServiceService", "description": "Service is a reference to the service for the API server." } }, "description": "APIService holds configuration related to the api server", "type": "object", "additionalProperties": false }, "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." } }, "description": "APIServiceService holds the service name and namespace of the host apiservice.", "type": "object", "additionalProperties": false }, "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": { "description": "NodeSelector is the node selector for the auto upgrade. If empty will select all worker nodes.", "type": "object", "additionalProperties": { "type": "string" } }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "CNI": { "properties": { "flannel": { "$ref": "#/$defs/CNIFlannel", "description": "Flannel holds dedicated Flannel configuration." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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." } }, "description": "CertManager reuses a host cert-manager and makes its CRDs from it available inside the vCluster", "type": "object", "additionalProperties": false }, "CertManagerSync": { "properties": { "toHost": { "$ref": "#/$defs/CertManagerSyncToHost" }, "fromHost": { "$ref": "#/$defs/CertManagerSyncFromHost" } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "CloudControllerManager": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if the embedded cloud controller manager should be enabled. This defaults to true, but can be disabled if you want to use\nan external cloud controller manager such as AWS or GCP. The cloud controller manager is responsible for setting the node's ip addresses as well\nas the provider id for the node and other node metadata." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." }, "pauseImage": { "type": "string", "description": "PauseImage is the image for the pause container." } }, "type": "object", "additionalProperties": false }, "ContainerdMirror": { "properties": { "server": { "type": "string", "description": "Server is the fallback server to use for the containerd registry mirror. E.g. . See 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." }, "overridePath": { "type": "boolean", "description": "OverridePath is a boolean to override the path for the containerd registry mirror." }, "hosts": { "items": { "$ref": "#/$defs/ContainerdMirrorHost" }, "type": "array", "description": "Hosts holds configuration for the containerd registry mirror hosts. See for more details." } }, "type": "object", "additionalProperties": false }, "ContainerdMirrorHost": { "properties": { "server": { "type": "string", "description": "Server is the server to use for the containerd registry mirror host. E.g. ." }, "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." }, "overridePath": { "type": "boolean", "description": "OverridePath is a boolean to override the path for the containerd registry mirror." } }, "type": "object", "additionalProperties": false }, "ContainerdRegistry": { "properties": { "configPath": { "type": "string", "description": "ConfigPath is the path to the containerd registry config." }, "mirrors": { "description": "Mirrors holds configuration for the containerd registry mirrors. E.g. myregistry.io:5000 or docker.io. See for more details.", "type": "object", "additionalProperties": { "$ref": "#/$defs/ContainerdMirror" } }, "auth": { "description": "Auth holds configuration for the containerd registry auth. See for more details.", "type": "object", "additionalProperties": { "$ref": "#/$defs/ContainerdRegistryAuth" } } }, "type": "object", "additionalProperties": false }, "ContainerdRegistryAuth": { "properties": { "username": { "type": "string", "description": "Username is the username for the containerd registry." }, "password": { "type": "string", "description": "Password is the password for the containerd registry." }, "identityToken": { "type": "string", "description": "IdentityToken is the token for the containerd registry." }, "auth": { "type": "string", "description": "Auth is the auth config for the containerd registry." } }, "type": "object", "additionalProperties": false }, "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.", "pro": true }, "ingress": { "$ref": "#/$defs/ControlPlaneIngress", "description": "Ingress defines options for vCluster ingress deployed by Helm." }, "tlsRoute": { "$ref": "#/$defs/ControlPlaneTLSRoute", "description": "TLSRoute defines options for vCluster TLS route 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." } }, "type": "object", "additionalProperties": false }, "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." }, "cloudControllerManager": { "$ref": "#/$defs/CloudControllerManager", "description": "CloudControllerManager holds configuration for the embedded cloud controller manager. This is only available when private nodes are enabled.\nThe cloud controller manager is responsible for setting the node's ip addresses as well as the provider id for the node and other node metadata." }, "globalMetadata": { "$ref": "#/$defs/ControlPlaneGlobalMetadata", "description": "GlobalMetadata is metadata that will be added to all resources deployed by Helm." }, "kubeVip": { "$ref": "#/$defs/KubeVip", "description": "KubeVip holds configuration for embedded kube-vip that announces the virtual cluster endpoint IP on layer 2." }, "podDisruptionBudget": { "$ref": "#/$defs/PodDisruptionBudget", "description": "PodDisruptionBudget limits how many pods of an application can be voluntarily disrupted at once\nto ensure availability during maintenance or scaling operations." } }, "type": "object", "additionalProperties": false }, "ControlPlaneGlobalMetadata": { "properties": { "annotations": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "ControlPlaneHeadlessService": { "properties": { "annotations": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "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": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "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": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "pods": { "$ref": "#/$defs/LabelsAndAnnotations", "description": "Additional labels or annotations for the statefulSet pods." }, "image": { "$ref": "#/$defs/Image", "description": "Image is the image for the controlPlane statefulSet container\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, set the repository to 'loft-sh/vcluster-oss'." }, "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." }, "initContainers": { "items": true, "type": "array", "description": "InitContainers are additional init containers for the statefulSet." }, "sidecarContainers": { "items": true, "type": "array", "description": "SidecarContainers are additional sidecar containers for the statefulSet." }, "hostAliases": { "items": { "$ref": "#/$defs/HostAlias" }, "type": "array", "description": "HostAliases allows you to add custom entries to the /etc/hosts file of each Pod created." }, "runtimeClassName": { "type": "string", "description": "RuntimeClassName is the runtime class to set for the statefulSet pods." } }, "type": "object", "additionalProperties": false }, "ControlPlaneTLSRoute": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if the control plane should be exposed via a gateway api tls route. Make sure to enable tls passthrough in the gateway via tls.mode to \"Passthrough\"" }, "apiVersion": { "type": "string", "description": "APIVersion is the version of the gateway api tls route." }, "host": { "type": "string", "description": "Host is the host where vCluster will be reachable" }, "parentRefs": { "items": { "type": "object" }, "type": "array", "description": "ParentRefs are the parent references for the TLS route" }, "spec": { "type": "object", "description": "Spec allows you to configure extra tls route options." }, "annotations": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "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": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "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.", "pro": true }, "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." } }, "type": "object", "additionalProperties": false }, "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": { "description": "NodeSelector is the node selector to use for coredns.", "type": "object", "additionalProperties": { "type": "string" } }, "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": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "topologySpreadConstraints": { "items": true, "type": "array", "description": "TopologySpreadConstraints are the topology spread constraints for the CoreDNS pod." } }, "type": "object", "additionalProperties": false }, "CoreDNSService": { "properties": { "spec": { "type": "object", "description": "Spec holds extra options for the coredns service" }, "annotations": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "CustomResourceProxy": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if this resource proxy should be enabled" }, "targetVirtualCluster": { "$ref": "#/$defs/VirtualClusterRef", "description": "TargetVirtualCluster is the target virtual cluster for the custom resource proxy" }, "accessResources": { "type": "string", "description": "AccessResources defines which resources should be accessible in the proxy." } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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 external database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/vcluster\n* postgres: postgres://username:password@hostname:5432/vcluster" }, "identityProvider": { "type": "string", "description": "IdentityProvider is the kine identity provider to use when generating temporary authentication tokens for enhanced security.\nThis is optional for the external database. Examples:\n* aws: RDS IAM Authentication" }, "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." } }, "type": "object", "additionalProperties": false }, "Deletion": { "properties": { "prevent": { "type": "boolean", "description": "Prevent prevents the vCluster from being deleted\n+optional" }, "auto": { "$ref": "#/$defs/DeletionAuto", "description": "Auto holds automatic deletion configuration\n+optional" } }, "description": "Deletion holds configuration for automatic vCluster deletion.", "type": "object", "additionalProperties": false }, "DeletionAuto": { "properties": { "afterInactivity": { "type": "string", "description": "AfterInactivity specifies after how long of inactivity the virtual cluster will be deleted.\nUses Go duration format (e.g., \"720h\" for 30 days).\n+optional" } }, "description": "DeletionAuto holds automatic deletion configuration", "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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.\nDeprecated: We do not deploy ingress nginx and the project is being deprecated." }, "metricsServer": { "$ref": "#/$defs/DeployMetricsServer", "description": "MetricsServer holds dedicated metrics server configuration." }, "volumeSnapshotController": { "$ref": "#/$defs/VolumeSnapshotController", "description": "VolumeSnapshotController holds dedicated CSI snapshot-controller configuration." } }, "type": "object", "additionalProperties": false }, "DeployMetricsServer": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if metrics server should be enabled." } }, "type": "object", "additionalProperties": false }, "Distro": { "properties": { "k8s": { "$ref": "#/$defs/DistroK8s", "description": "K8S holds K8s relevant configuration." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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": "Version is the Kubernetes version to use." }, "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." }, "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" } }, "type": "object", "additionalProperties": false }, "DynamicNodePool": { "properties": { "name": { "type": "string", "description": "Name is the name of this NodePool" }, "nodeTypeSelector": { "items": { "$ref": "#/$defs/Requirement" }, "type": "array", "description": "NodeTypeSelector filters the types of nodes that can be provisioned by this pool.\nAll requirements must be met for a node type to be eligible." }, "taints": { "items": { "$ref": "#/$defs/KubeletJoinTaint" }, "type": "array", "description": "Taints are the taints to apply to the nodes in this pool." }, "nodeLabels": { "description": "NodeLabels are the labels to apply to the nodes in this pool.", "type": "object", "additionalProperties": { "type": "string" } }, "limits": { "description": "Limits specify the maximum resources that can be provisioned by this node pool,\nmapping to the 'limits' field in Karpenter's NodePool API.", "type": "object", "additionalProperties": { "type": "string" } }, "disruption": { "$ref": "#/$defs/DynamicNodePoolDisruption", "description": "Disruption contains the parameters that relate to Karpenter's disruption logic" }, "terminationGracePeriod": { "type": "string", "description": "TerminationGracePeriod is the maximum duration the controller will wait before forcefully deleting the pods on a node, measured from when deletion is first initiated.\n\nWarning: this feature takes precedence over a Pod's terminationGracePeriodSeconds value, and bypasses any blocked PDBs or the karpenter.sh/do-not-disrupt annotation.\n\nThis field is intended to be used by cluster administrators to enforce that nodes can be cycled within a given time period.\nWhen set, drifted nodes will begin draining even if there are pods blocking eviction. Draining will respect PDBs and the do-not-disrupt annotation until the TGP is reached.\n\nKarpenter will preemptively delete pods so their terminationGracePeriodSeconds align with the node's terminationGracePeriod.\nIf a pod would be terminated without being granted its full terminationGracePeriodSeconds prior to the node timeout,\nthat pod will be deleted at T = node timeout - pod terminationGracePeriodSeconds.\n\nThe feature can also be used to allow maximum time limits for long-running jobs which can delay node termination with preStop hooks.\nDefaults to 30s. Set to Never to wait indefinitely for pods to be drained." }, "expireAfter": { "type": "string", "description": "The amount of time a Node can live on the cluster before being removed" }, "weight": { "type": "integer", "description": "Weight is the weight of this node pool." } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "DynamicNodePoolDisruption": { "properties": { "consolidateAfter": { "type": "string", "description": "ConsolidateAfter is the duration the controller will wait\nbefore attempting to terminate nodes that are underutilized.\nRefer to ConsolidationPolicy for how underutilization is considered." }, "consolidationPolicy": { "type": "string", "description": "ConsolidationPolicy describes which nodes Karpenter can disrupt through its consolidation\nalgorithm. This policy defaults to \"WhenEmptyOrUnderutilized\" if not specified" }, "budgets": { "items": { "$ref": "#/$defs/DynamicNodePoolDisruptionBudget" }, "type": "array", "description": "Budgets is a list of Budgets.\nIf there are multiple active budgets, Karpenter uses\nthe most restrictive value. If left undefined,\nthis will default to one budget with a value to 10%." } }, "type": "object", "additionalProperties": false }, "DynamicNodePoolDisruptionBudget": { "properties": { "nodes": { "type": "string", "description": "Nodes dictates the maximum number of NodeClaims owned by this NodePool\nthat can be terminating at once. This is calculated by counting nodes that\nhave a deletion timestamp set, or are actively being deleted by Karpenter.\nThis field is required when specifying a budget." }, "schedule": { "type": "string", "description": "Schedule specifies when a budget begins being active, following\nthe upstream cronjob syntax. If omitted, the budget is always active.\nTimezones are not supported." }, "duration": { "type": "string", "description": "Duration determines how long a Budget is active since each Schedule hit.\nOnly minutes and hours are accepted, as cron does not work in seconds.\nIf omitted, the budget is always active.\nThis is required if Schedule is set." } }, "type": "object", "additionalProperties": false }, "EnableAutoSwitch": { "properties": { "enabled": { "oneOf": [ { "type": "string" }, { "type": "boolean" } ], "description": "Enabled defines if this option should be enabled." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "EnableSwitch": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if this option should be enabled." } }, "type": "object", "additionalProperties": false }, "EnableSwitchSelector": { "properties": { "selector": { "$ref": "#/$defs/StandardLabelSelector" }, "enabled": { "type": "boolean", "description": "Enabled defines if this option should be enabled." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "Etcd": { "properties": { "embedded": { "$ref": "#/$defs/EtcdEmbedded", "description": "Embedded defines to use embedded etcd as a storage backend for the virtual cluster", "pro": true }, "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" } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "EtcdDeployHeadlessService": { "properties": { "annotations": { "description": "Annotations are extra annotations for the external etcd headless service", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "EtcdDeployService": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if the etcd service should be deployed" }, "annotations": { "description": "Annotations are extra annotations for the external etcd service", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "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": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "EtcdEmbedded": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if the embedded etcd should be used.", "pro": true }, "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." } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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" } }, "description": "EtcdExternalTLS defines tls for external etcd server", "type": "object", "additionalProperties": false }, "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." }, "virtualClusterKubeConfig": { "$ref": "#/$defs/VirtualClusterKubeConfig", "description": "VirtualClusterKubeConfig allows you to override distro specifics and specify where vCluster will find the required certificates and vCluster config.\nDeprecated: Removed in 0.29.0." }, "denyProxyRequests": { "items": { "$ref": "#/$defs/DenyRule" }, "type": "array", "description": "DenyProxyRequests denies certain requests in the vCluster proxy.", "pro": true }, "proxy": { "$ref": "#/$defs/Proxy", "description": "Proxy enables vCluster-to-vCluster proxying of resources" }, "docker": { "$ref": "#/$defs/ExperimentalDocker", "description": "Docker allows you to configure Docker related settings when deploying a vCluster using Docker." }, "nodeMonitors": { "items": { "$ref": "#/$defs/ExperimentalNodeMonitor" }, "type": "array", "description": "NodeMonitors allows you to create a service monitor for each node." } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "ExperimentalDeployHelmChart": { "properties": { "name": { "type": "string" }, "repo": { "type": "string" }, "insecure": { "type": "boolean" }, "version": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" } }, "type": "object", "additionalProperties": false }, "ExperimentalDeployHelmRelease": { "properties": { "name": { "type": "string", "description": "Name of the release" }, "namespace": { "type": "string", "description": "Namespace of the release" } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "ExperimentalDocker": { "properties": { "image": { "type": "string", "description": "Image defines the image to use for the container. Defaults to ghcr.io/loft-sh/vm-container." }, "ports": { "items": { "type": "string" }, "type": "array", "description": "Ports defines extra port mappings to be added to the container." }, "volumes": { "items": { "type": "string" }, "type": "array", "description": "Volumes defines extra volumes to be added to the container." }, "env": { "items": { "type": "string" }, "type": "array", "description": "Env defines extra environment variables to be added to the container. Use key=value." }, "args": { "items": { "type": "string" }, "type": "array", "description": "Args defines extra arguments to be added to the docker run command of the container." }, "enabled": { "type": "boolean", "description": "Enabled defines if the vCluster was deployed using Docker. This is automatically set by vCluster and should not be set by the user." }, "network": { "type": "string", "description": "Network defines the network to use for the vCluster. If not specified, the a network will be created for the vCluster." }, "nodes": { "items": { "$ref": "#/$defs/ExperimentalDockerNode" }, "type": "array", "description": "Nodes defines the nodes of the vCluster." }, "registryProxy": { "$ref": "#/$defs/EnableSwitch", "description": "Defines if docker images should be pulled from the host docker daemon. This prevents pulling images again and allows to\nuse purely local images. Only works if containerd image storage is used. For more information, see " }, "loadBalancer": { "$ref": "#/$defs/ExperimentalDockerLoadBalancer", "description": "Defines if vCluster should configure load balancer services inside the vCluster. This might require\nsudo access on the host cluster for docker desktop or rancher desktop on macos." } }, "type": "object", "additionalProperties": false }, "ExperimentalDockerLoadBalancer": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if this option should be enabled." }, "forwardPorts": { "type": "boolean", "description": "ForwardPorts defines if the load balancer ips should be made available locally\nvia port forwarding. This will be only done if necessary for example on macos when using docker desktop." } }, "type": "object", "additionalProperties": false }, "ExperimentalDockerNode": { "properties": { "image": { "type": "string", "description": "Image defines the image to use for the container. Defaults to ghcr.io/loft-sh/vm-container." }, "ports": { "items": { "type": "string" }, "type": "array", "description": "Ports defines extra port mappings to be added to the container." }, "volumes": { "items": { "type": "string" }, "type": "array", "description": "Volumes defines extra volumes to be added to the container." }, "env": { "items": { "type": "string" }, "type": "array", "description": "Env defines extra environment variables to be added to the container. Use key=value." }, "args": { "items": { "type": "string" }, "type": "array", "description": "Args defines extra arguments to be added to the docker run command of the container." }, "name": { "type": "string", "description": "Name defines the name of the node. If not specified, a random name will be generated." } }, "type": "object", "additionalProperties": false }, "ExperimentalNodeMonitor": { "properties": { "name": { "type": "string", "description": "Name is the name of the monitor. It will be suffixed with the node name." }, "nodeSelector": { "description": "NodeSelector defines the node selector for the service monitor.", "type": "object", "additionalProperties": { "type": "string" } }, "endpoints": { "items": { "$ref": "#/$defs/ExperimentalNodeServiceMonitorEndpoint" }, "type": "array", "description": "Endpoints is a list of endpoints to add to the service monitor. By default, vCluster will relabel the node and instance label to the node name." }, "spec": { "type": "object", "description": "Spec allows you to configure extra service monitor options that will be merged into the spec." }, "annotations": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "ExperimentalNodeServiceMonitorEndpoint": { "properties": { "path": { "type": "string", "description": "Path is the kubelet path of the endpoint. vCluster will prepend /api/v1/nodes/NODE_NAME to the path." }, "params": { "description": "Params allows you to configure extra parameters to add to the endpoint.", "type": "object", "additionalProperties": { "items": { "type": "string" }, "type": "array" } }, "extraRelabelings": { "items": { "type": "object" }, "type": "array", "description": "ExtraRelabelings allows you to configure extra relabelings to add to the endpoint. By default, vCluster will relabel the node and instance label to the node name." }, "metricsRelabelings": { "items": { "type": "object" }, "type": "array", "description": "MetricsRelabelings allows you to configure extra metrics relabelings to add to the endpoint." }, "interval": { "type": "string", "description": "Interval is the interval at which to scrape the endpoint." }, "scrapeTimeout": { "type": "string", "description": "ScrapeTimeout is the timeout for the scrape of the endpoint." } }, "type": "object", "additionalProperties": false }, "ExperimentalSyncSettings": { "properties": { "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" } }, "type": "object", "additionalProperties": false }, "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 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." } }, "description": "ExportKubeConfig describes how vCluster should export the vCluster kubeconfig.", "type": "object", "additionalProperties": false }, "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 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." } }, "description": "ExportKubeConfigAdditionalSecretReference defines the additional host cluster secret in which vCluster stores the generated virtual cluster kubeconfigs.", "type": "object", "additionalProperties": false }, "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." } }, "description": "Declare in which host cluster secret vCluster should store the generated virtual cluster kubeconfig.", "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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 external database. Examples:\n* mysql: mysql://username:password@tcp(hostname:3306)/vcluster\n* postgres: postgres://username:password@hostname:5432/vcluster" }, "identityProvider": { "type": "string", "description": "IdentityProvider is the kine identity provider to use when generating temporary authentication tokens for enhanced security.\nThis is optional for the external database. Examples:\n* aws: RDS IAM Authentication" }, "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." } }, "type": "object", "additionalProperties": false }, "ExternalEtcdHighAvailability": { "properties": { "replicas": { "type": "integer", "description": "Replicas are the amount of pods to use." } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "ExternalSecrets": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines whether the external secret integration is enabled or not" }, "version": { "type": "string", "description": "Version defines the version of the external secrets operator to use. If empty, the storage version will be used." }, "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" } }, "description": "ExternalSecrets reuses a host external secret operator and makes certain CRDs from it available inside the vCluster", "type": "object", "additionalProperties": false }, "ExternalSecretsSync": { "properties": { "toHost": { "$ref": "#/$defs/ExternalSecretsSyncToHostConfig", "description": "ToHost defines what resources are synced from the virtual cluster to the host" }, "fromHost": { "$ref": "#/$defs/ExternalSecretsSyncFromHostConfig", "description": "FromHost defines what resources are synced from the host cluster to the virtual cluster" } }, "type": "object", "additionalProperties": false }, "ExternalSecretsSyncFromHostConfig": { "properties": { "clusterStores": { "$ref": "#/$defs/EnableSwitchSelector", "description": "ClusterStores defines if cluster secrets stores should get synced from the host cluster to the virtual cluster." } }, "type": "object", "additionalProperties": false }, "ExternalSecretsSyncToHostConfig": { "properties": { "externalSecrets": { "$ref": "#/$defs/SelectorConfig", "description": "ExternalSecrets allows to configure if only a subset of ExternalSecrets matching a label selector should get synced from the virtual cluster to the host cluster." }, "stores": { "$ref": "#/$defs/EnableSwitchSelector", "description": "Stores defines if secret stores should get synced from the virtual cluster to the host cluster and then bi-directionally." } }, "type": "object", "additionalProperties": false }, "FromHostMappings": { "properties": { "byName": { "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\"", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "HostAlias": { "properties": { "ip": { "type": "string" }, "hostnames": { "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "IPBlock": { "properties": { "cidr": { "type": "string", "description": "CIDR defines the allowed workload public egress destination.\nValid examples are \"0.0.0.0/0\", \"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. Items outside the cidr range will be rejected.\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\".\n+optional" } }, "description": "IPBlock describes a particular CIDR (Ex.", "type": "object", "additionalProperties": false }, "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, and is the default version." } }, "type": "object", "additionalProperties": false }, "ImagePullSecretName": { "properties": { "name": { "type": "string", "description": "Name of the image pull secret to use." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." }, "netris": { "$ref": "#/$defs/NetrisIntegration", "description": "Netris integration helps configuring netris networking for vCluster." } }, "description": "Integrations holds config for vCluster integrations with other operators or tools running on the host cluster", "type": "object", "additionalProperties": false }, "Istio": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if this option should be enabled." }, "sync": { "$ref": "#/$defs/IstioSync" } }, "type": "object", "additionalProperties": false }, "IstioSync": { "properties": { "toHost": { "$ref": "#/$defs/IstioSyncToHost" } }, "type": "object", "additionalProperties": false }, "IstioSyncToHost": { "properties": { "destinationRules": { "$ref": "#/$defs/EnableSwitch" }, "gateways": { "$ref": "#/$defs/EnableSwitch" }, "virtualServices": { "$ref": "#/$defs/EnableSwitch" } }, "type": "object", "additionalProperties": false }, "JoinConfiguration": { "properties": { "preInstallCommands": { "items": { "type": "string" }, "type": "array", "description": "PreInstallCommands are commands that will be executed before containerd, kubelet etc. is installed." }, "preJoinCommands": { "items": { "type": "string" }, "type": "array", "description": "PreJoinCommands are commands that will be executed before kubeadm join is executed." }, "postJoinCommands": { "items": { "type": "string" }, "type": "array", "description": "PostJoinCommands are commands that will be executed after kubeadm join is executed." }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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": { "description": "NodeSelector is the node selector for the konnectivity agent.", "type": "object", "additionalProperties": { "type": "string" } }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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": { "description": "NodeSelector is the node selector for the kube-proxy.", "type": "object", "additionalProperties": { "type": "string" } }, "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." }, "config": { "type": "object", "description": "Config is the config for the kube-proxy that will be merged into the default kube-proxy config. More information can be found here:\n" } }, "type": "object", "additionalProperties": false }, "KubeVip": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if embedded kube-vip should be enabled." }, "interface": { "type": "string", "description": "Interface is the network interface on which the VIP is announced." }, "gateway": { "type": "string", "description": "Gateway is the gateway address in CIDR notation (e.g., 10.100.0.1/24).\nThis is used to configure policy-based routing for the VIP and must include the subnet prefix." } }, "type": "object", "additionalProperties": false }, "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" } }, "description": "KubeVirt reuses a host kubevirt and makes certain CRDs from it available inside the vCluster", "type": "object", "additionalProperties": false }, "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" } }, "description": "KubeVirtSync are the crds that are supported by this integration", "type": "object", "additionalProperties": false }, "Kubelet": { "properties": { "config": { "type": "object", "description": "Config is the config for the kubelet that will be merged into the default kubelet config. More information can be found here:\n" } }, "type": "object", "additionalProperties": false }, "KubeletExtraArg": { "properties": { "name": { "type": "string", "description": "Name is the name of the argument." }, "value": { "type": "string", "description": "Value is the value of the argument." } }, "description": "KubeletExtraArg represents an argument with a name and a value.", "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "LabelSelector": { "properties": { "labels": { "description": "Labels defines what labels should be looked for", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "LabelSelectorRequirement": { "properties": { "key": { "type": "string" }, "operator": { "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "LabelsAndAnnotations": { "properties": { "annotations": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "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": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "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" } }, "description": "LivenessProbe defines the configuration for the liveness probe.", "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "Logging": { "properties": { "encoding": { "type": "string", "description": "Encoding specifies the format of vCluster logs, it can either be json or console." } }, "description": "Logging holds the log encoding details", "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "description": "MetricsServer reuses the metrics server from the host cluster within the vCluster.", "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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: ." }, "webhooks": { "items": { "$ref": "#/$defs/MutatingWebhook" }, "type": "array", "description": "Webhooks is a list of webhooks and the affected resources and operations." } }, "type": "object", "additionalProperties": false }, "NetrisIntegration": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if netris integration is enabled\n+optional" }, "connector": { "type": "string", "description": "Connector specifies the netris connector name\n+optional" }, "kubeVip": { "$ref": "#/$defs/NetrisKubeVipConfig", "description": "KubeVip holds kube-vip configuration for netris\n+optional" } }, "description": "NetrisIntegration holds netris integration configuration.", "type": "object", "additionalProperties": false }, "NetrisKubeVipConfig": { "properties": { "serverCluster": { "type": "string", "description": "ServerCluster specifies the server cluster name\n+optional" }, "bridge": { "type": "string", "description": "Bridge specifies the bridge interface name\n+optional" }, "ipRange": { "type": "string", "description": "IPRange specifies the IP range for kube-vip\n+optional" } }, "description": "NetrisKubeVipConfig holds kube-vip configuration for netris integration", "type": "object", "additionalProperties": false }, "NetworkPolicy": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if the network policy should be deployed by vCluster." }, "annotations": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "fallbackDns": { "type": "string", "description": "FallbackDNS is the fallback DNS server to use if the virtual cluster does not have a DNS server." }, "controlPlane": { "$ref": "#/$defs/NetworkPolicyControlPlane", "description": "ControlPlane network policy rules" }, "workload": { "$ref": "#/$defs/NetworkPolicyWorkload", "description": "Workload network policy rules" } }, "type": "object", "additionalProperties": false }, "NetworkPolicyControlPlane": { "properties": { "ingress": { "items": { "$ref": "#/$defs/NetworkPolicyIngressRule" }, "type": "array", "description": "Ingress rules for the vCluster control plane." }, "egress": { "items": { "$ref": "#/$defs/NetworkPolicyEgressRule" }, "type": "array", "description": "Egress rules for the vCluster control plane." } }, "type": "object", "additionalProperties": false }, "NetworkPolicyEgressRule": { "properties": { "ports": { "items": { "$ref": "#/$defs/NetworkPolicyPort" }, "type": "array", "description": "ports is a list of destination ports for outgoing traffic.\nEach item in this list is combined using a logical OR. If this field is\nempty or missing, this rule matches all ports (traffic not restricted by port).\nIf this field is present and contains at least one item, then this rule allows\ntraffic only if the traffic matches at least one port in the list.\n+optional\n+listType=atomic" }, "to": { "items": { "$ref": "#/$defs/NetworkPolicyPeer" }, "type": "array", "description": "to is a list of destinations for outgoing traffic of pods selected for this rule.\nItems in this list are combined using a logical OR operation. If this field is\nempty or missing, this rule matches all destinations (traffic not restricted by\ndestination). If this field is present and contains at least one item, this rule\nallows traffic only if the traffic matches at least one item in the to list.\n+optional\n+listType=atomic" } }, "description": "NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector.", "type": "object", "additionalProperties": false }, "NetworkPolicyIngressRule": { "properties": { "ports": { "items": { "$ref": "#/$defs/NetworkPolicyPort" }, "type": "array", "description": "ports is a list of ports which should be made accessible on the pods selected for\nthis rule. Each item in this list is combined using a logical OR. If this field is\nempty or missing, this rule matches all ports (traffic not restricted by port).\nIf this field is present and contains at least one item, then this rule allows\ntraffic only if the traffic matches at least one port in the list.\n+optional\n+listType=atomic" }, "from": { "items": { "$ref": "#/$defs/NetworkPolicyPeer" }, "type": "array", "description": "from is a list of sources which should be able to access the pods selected for this rule.\nItems in this list are combined using a logical OR operation. If this field is\nempty or missing, this rule matches all sources (traffic not restricted by\nsource). If this field is present and contains at least one item, this rule\nallows traffic only if the traffic matches at least one item in the from list.\n+optional\n+listType=atomic" } }, "description": "NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector.", "type": "object", "additionalProperties": false }, "NetworkPolicyPeer": { "properties": { "podSelector": { "$ref": "#/$defs/StandardLabelSelector", "description": "podSelector is a label selector which selects pods. This field follows standard label\nselector semantics; if present but empty, it selects all pods.\n\nIf namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects\nthe pods matching podSelector in the Namespaces selected by NamespaceSelector.\nOtherwise it selects the pods matching podSelector in the policy's own namespace.\n+optional" }, "namespaceSelector": { "$ref": "#/$defs/StandardLabelSelector", "description": "namespaceSelector selects namespaces using cluster-scoped labels. This field follows\nstandard label selector semantics; if present but empty, it selects all namespaces.\n\nIf podSelector is also set, then the NetworkPolicyPeer as a whole selects\nthe pods matching podSelector in the namespaces selected by namespaceSelector.\nOtherwise it selects all pods in the namespaces selected by namespaceSelector.\n+optional" }, "ipBlock": { "$ref": "#/$defs/IPBlock", "description": "ipBlock defines policy on a particular IPBlock. If this field is set then\nneither of the other fields can be.\n+optional" } }, "description": "NetworkPolicyPeer describes a peer to allow traffic to/from.", "type": "object", "additionalProperties": false }, "NetworkPolicyPort": { "properties": { "protocol": { "type": "string", "description": "protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match.\nIf not specified, this field defaults to TCP.\n+optional" }, "port": { "description": "port represents the port on the given protocol. This can either be a numerical or named\nport on a pod. If this field is not provided, this matches all port names and\nnumbers.\nIf present, only traffic on the specified protocol AND port will be matched.\n+optional" }, "endPort": { "type": "integer", "description": "endPort indicates that the range of ports from port to endPort if set, inclusive,\nshould be allowed by the policy. This field cannot be defined if the port field\nis not defined or if the port field is defined as a named (string) port.\nThe endPort must be equal or greater than port.\n+optional" } }, "description": "NetworkPolicyPort describes a port to allow traffic on", "type": "object", "additionalProperties": false }, "NetworkPolicyWorkload": { "properties": { "publicEgress": { "$ref": "#/$defs/NetworkPolicyWorkloadPublicEgress", "description": "PublicEgress holds the public outgoing connections options for the vCluster workloads." }, "ingress": { "items": { "$ref": "#/$defs/NetworkPolicyIngressRule" }, "type": "array", "description": "Ingress rules for the vCluster workloads." }, "egress": { "items": { "$ref": "#/$defs/NetworkPolicyEgressRule" }, "type": "array", "description": "Egress rules for the vCluster workloads." } }, "type": "object", "additionalProperties": false }, "NetworkPolicyWorkloadPublicEgress": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if the workload public egress should be enabled or disabled." }, "cidr": { "type": "string", "description": "CIDR defines the allowed workload public egress destination.\nValid examples are \"0.0.0.0/0\", \"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. Items outside the cidr range will be rejected.\nValid examples are \"192.168.1.0/24\" or \"2001:db8::/64\".\n+optional" } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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.", "pro": true }, "advanced": { "$ref": "#/$defs/NetworkingAdvanced", "description": "Advanced holds advanced network options." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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": { "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.", "type": "object", "additionalProperties": { "type": "string" } }, "annotations": { "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.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "Platform": { "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 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\n+optional" } }, "description": "Platform holds vCluster Platform specific configuration.", "type": "object", "additionalProperties": false }, "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.\n+optional" }, "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.\n+optional" }, "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.\n+optional" } }, "description": "PlatformAPIKey defines where to find the platform access key.", "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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" } }, "description": "PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.", "type": "object", "additionalProperties": false }, "PodDNSConfigOption": { "properties": { "name": { "type": "string", "description": "Required." }, "value": { "type": "string", "description": "+optional" } }, "description": "PodDNSConfigOption defines DNS resolver options of a pod.", "type": "object", "additionalProperties": false }, "PodDisruptionBudget": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if the pod disruption budget should be enabled." }, "minAvailable": { "description": "MinAvailable describes the minimal number or percentage of available pods." }, "maxUnavailable": { "description": "MaxUnavailable describes the minimal number or percentage of unavailable pods." }, "unhealthyPodEvictionPolicy": { "type": "string", "description": "UnhealthyPodEvictionPolicy defines the criteria when unhealthy pods should be considered for eviction.\nCurrently supported values are:\n* IfHealthyBudget - pods that are in the Running phase but not yet healthy are considered disrupted\n\tand may be evicted even if the PodDisruptionBudget criteria are not met.\n* AlwaysAllow - pods that are in the Running phase but not yet healthy are considered disrupted\n\tand can be evicted regardless of whether the criteria in a PDB is met." } }, "type": "object", "additionalProperties": false }, "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.", "pro": true } }, "type": "object", "additionalProperties": false }, "PrivateNodes": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if dedicated nodes should be enabled." }, "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\")." }, "autoNodes": { "items": { "$ref": "#/$defs/PrivateNodesAutoNodes" }, "type": "array", "description": "AutoNodes stores auto nodes configuration." }, "vpn": { "$ref": "#/$defs/PrivateNodesVPN", "description": "VPN holds configuration for the private nodes vpn. This can be used to connect the private nodes to the control plane or\nconnect the private nodes to each other if they are not running in the same network. Platform connection is required for the vpn to work." } }, "description": "PrivateNodes enables private nodes for vCluster.", "type": "object", "additionalProperties": false }, "PrivateNodesAutoNodes": { "properties": { "provider": { "type": "string", "description": "Provider is the node provider of the nodes in this pool." }, "properties": { "description": "Properties are the node provider properties. This is a simple key value map and can contain things\nlike region, subscription, etc. that is then used by the node provider to create the nodes and node environment.", "type": "object", "additionalProperties": { "type": "string" } }, "static": { "items": { "$ref": "#/$defs/StaticNodePool" }, "type": "array", "description": "Static defines static node pools. Static node pools have a fixed size and are not scaled automatically." }, "dynamic": { "items": { "$ref": "#/$defs/DynamicNodePool" }, "type": "array", "description": "Dynamic defines dynamic node pools. Dynamic node pools are scaled automatically based on the requirements within the cluster.\nKarpenter is used under the hood to handle the scheduling of the nodes." } }, "description": "PrivateNodesAutoNodes defines auto nodes", "type": "object", "required": [ "provider" ], "additionalProperties": false }, "PrivateNodesVPN": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if the private nodes vpn should be enabled." }, "nodeToNode": { "$ref": "#/$defs/PrivateNodesVPNNodeToNode", "description": "NodeToNode holds configuration for the node to node vpn. This can be used to connect the private nodes to each other if they are not running in the same network." } }, "type": "object", "additionalProperties": false }, "PrivateNodesVPNNodeToNode": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if the node to node vpn should be enabled." } }, "type": "object", "additionalProperties": false }, "Proxy": { "properties": { "customResources": { "description": "CustomResources is a map of resource keys (format: \"kind.apiGroup/version\") to proxy configuration", "type": "object", "additionalProperties": { "$ref": "#/$defs/CustomResourceProxy" } } }, "type": "object", "additionalProperties": false }, "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" }, "enableVolumeSnapshotRules": { "$ref": "#/$defs/EnableAutoSwitch", "description": "EnableVolumeSnapshotRules enables all required volume snapshot rules in the Role and\nClusterRole." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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" } }, "description": "ReadinessProbe defines the configuration for the readiness probe.", "type": "object", "additionalProperties": false }, "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 for more details." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "Requirement": { "properties": { "property": { "type": "string", "description": "Property is the property on the node type to select." }, "operator": { "type": "string", "description": "Operator is the comparison operator, such as \"In\", \"NotIn\", \"Exists\". If empty, defaults to \"In\"." }, "values": { "items": { "type": "string" }, "type": "array", "description": "Values is the list of values to use for comparison. This is mutually exclusive with value." }, "value": { "type": "string", "description": "Value is the value to use for comparison. This is mutually exclusive with values." } }, "description": "KarpenterRequirement defines a scheduling requirement for a dynamic node pool.", "type": "object", "required": [ "property" ], "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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": { "description": "Annotations are extra annotations for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Labels are extra labels for this resource.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "SelectorConfig": { "properties": { "selector": { "$ref": "#/$defs/StandardLabelSelector" } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "ServiceMonitor": { "properties": { "enabled": { "type": "boolean", "description": "Enabled configures if Helm should create the service monitor." }, "labels": { "description": "Labels are the extra labels to add to the service monitor.", "type": "object", "additionalProperties": { "type": "string" } }, "annotations": { "description": "Annotations are the extra annotations to add to the service monitor.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "Sleep": { "properties": { "auto": { "$ref": "#/$defs/SleepAuto", "description": "Auto holds automatic sleep configuration" } }, "description": "Sleep holds configuration for automatically putting the virtual cluster to sleep.", "type": "object", "additionalProperties": false }, "SleepAuto": { "properties": { "afterInactivity": { "type": "string", "description": "AfterInactivity represents how long a vCluster can be idle before workloads are automatically put to sleep" }, "schedule": { "type": "string", "description": "Schedule represents a cron schedule for when to sleep workloads" }, "exclude": { "$ref": "#/$defs/SleepAutoExclusion", "description": "Exclude holds configuration for labels that, if present, will prevent a workload from going to sleep" }, "wakeup": { "$ref": "#/$defs/SleepAutoWakeup", "description": "Wakeup holds configuration for waking the vCluster on a schedule" }, "timezone": { "type": "string", "description": "Timezone specifies time zone used for scheduled sleep 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" } }, "description": "SleepAuto holds configuration for automatic sleep and wakeup", "type": "object", "additionalProperties": false }, "SleepAutoExclusion": { "properties": { "selector": { "$ref": "#/$defs/LabelSelector" } }, "description": "SleepAutoExclusion holds conifiguration for excluding workloads from sleeping by label(s)", "type": "object", "additionalProperties": false }, "SleepAutoWakeup": { "properties": { "schedule": { "type": "string" } }, "description": "SleepAutoWakeup holds the cron schedule to wake workloads automatically", "type": "object", "additionalProperties": false }, "SnapshotRetention": { "properties": { "period": { "type": "integer", "description": "Period defines the number of days a snapshot will be kept\n+optional" }, "maxSnapshots": { "type": "integer", "description": "MaxSnapshots defines the number of snapshots that can be taken\n+optional" } }, "description": "SnapshotRetention holds snapshot retention configuration", "type": "object", "additionalProperties": false }, "SnapshotSecretCredential": { "properties": { "secretName": { "type": "string", "description": "SecretName is the secret name with credential\n+optional" }, "secretNamespace": { "type": "string", "description": "SecretNamespace is the secret namespace with credential\n+optional" } }, "description": "SnapshotSecretCredential holds secret reference for credentials", "type": "object", "additionalProperties": false }, "SnapshotStorage": { "properties": { "type": { "type": "string", "description": "Type specifies supported type of storage services for a snapshot S3/OCI/Container, see \n+optional" }, "s3": { "$ref": "#/$defs/SnapshotStorageS3", "description": "S3 holds configuration for storing snapshots in S3-compatible bucket\n+optional" }, "oci": { "$ref": "#/$defs/SnapshotStorageOCI", "description": "OCI holds configuration for storing snapshots in OCI image registries\n+optional" }, "container": { "$ref": "#/$defs/SnapshotStorageContainer", "description": "Container holds configuration for storing snapshots as local files inside a vCluster container\n+optional" } }, "description": "SnapshotStorage holds snapshot storage configuration", "type": "object", "additionalProperties": false }, "SnapshotStorageContainer": { "properties": { "path": { "type": "string", "description": "Path specifies directory to store the snapshot\n+optional" }, "volume": { "$ref": "#/$defs/SnapshotStorageContainerVolume", "description": "Volume specifies which volume needs to be mounted into the container to store the snapshot\n+optional" } }, "description": "SnapshotStorageContainer holds container local storage configuration", "type": "object", "additionalProperties": false }, "SnapshotStorageContainerVolume": { "properties": { "name": { "type": "string", "description": "Name to be used to mount the volume\n+optional" }, "path": { "type": "string", "description": "Path to the volume mount\n+optional" } }, "description": "SnapshotStorageContainerVolume holds volume mount configuration", "type": "object", "additionalProperties": false }, "SnapshotStorageOCI": { "properties": { "repository": { "type": "string", "description": "Repository OCI repository to store the snapshot\n+optional" }, "credential": { "$ref": "#/$defs/SnapshotSecretCredential", "description": "Credential secret with the OCI Credentials\n+optional" }, "username": { "type": "string", "description": "Username to authenticate with the OCI registry\n+optional" }, "password": { "type": "string", "description": "Password to authenticate with the OCI registry\n+optional" } }, "description": "SnapshotStorageOCI holds OCI registry storage configuration", "type": "object", "additionalProperties": false }, "SnapshotStorageS3": { "properties": { "url": { "type": "string", "description": "Url specifies url to the storage service\n+optional" }, "credential": { "$ref": "#/$defs/SnapshotSecretCredential", "description": "Credential secret with the S3 Credentials, it should contain AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN\n+optional" } }, "description": "SnapshotStorageS3 holds S3 storage configuration", "type": "object", "additionalProperties": false }, "SnapshotVolumes": { "properties": { "enabled": { "type": "boolean", "description": "Enabled specifies whether a snapshot should also include volumes in the snapshot\n+optional" } }, "description": "SnapshotVolumes holds volume snapshot configuration", "type": "object", "additionalProperties": false }, "Snapshots": { "properties": { "auto": { "$ref": "#/$defs/SnapshotsAuto", "description": "Auto holds automatic snapshot configuration\n+optional" } }, "description": "Snapshots holds configuration for automatic vCluster snapshots.", "type": "object", "additionalProperties": false }, "SnapshotsAuto": { "properties": { "schedule": { "type": "string", "description": "Schedule specifies a scheduled time in Cron format, see for a virtual cluster snapshot to be taken\n+optional" }, "timezone": { "type": "string", "description": "Timezone specifies time zone used for scheduled snapshot 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" }, "retention": { "$ref": "#/$defs/SnapshotRetention", "description": "Retention specifies how long snapshots will be kept\n+optional" }, "storage": { "$ref": "#/$defs/SnapshotStorage", "description": "Storage specifies where the snapshot will be stored\n+optional" }, "volumes": { "$ref": "#/$defs/SnapshotVolumes", "description": "Volumes specifies configuration for volume snapshots\n+optional" } }, "description": "SnapshotsAuto holds automatic snapshot scheduling and retention configuration", "type": "object", "additionalProperties": false }, "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." }, "autoNodes": { "$ref": "#/$defs/StandaloneAutoNodes", "description": "AutoNodes automatically deploys nodes for standalone mode." }, "joinNode": { "$ref": "#/$defs/StandaloneJoinNode", "description": "JoinNode holds configuration for the standalone control plane node." } }, "type": "object", "additionalProperties": false }, "StandaloneAutoNodes": { "properties": { "provider": { "type": "string", "description": "Provider is the node provider of the nodes in this pool." }, "quantity": { "type": "integer", "description": "Quantity is the number of nodes to deploy for standalone mode." }, "nodeTypeSelector": { "items": { "$ref": "#/$defs/Requirement" }, "type": "array", "description": "NodeTypeSelector filters the types of nodes that can be provisioned by this pool.\nAll requirements must be met for a node type to be eligible." } }, "type": "object", "additionalProperties": false }, "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." }, "preInstallCommands": { "items": { "type": "string" }, "type": "array", "description": "PreInstallCommands are commands that will be executed before containerd, kubelet etc. is installed." }, "preJoinCommands": { "items": { "type": "string" }, "type": "array", "description": "PreJoinCommands are commands that will be executed before kubeadm join is executed." }, "postJoinCommands": { "items": { "type": "string" }, "type": "array", "description": "PostJoinCommands are commands that will be executed after kubeadm join is executed." }, "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." } }, "type": "object", "additionalProperties": false }, "StandardLabelSelector": { "properties": { "matchLabels": { "type": "object", "additionalProperties": { "type": "string" } }, "matchExpressions": { "items": { "$ref": "#/$defs/LabelSelectorRequirement" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "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" } }, "description": "StartupProbe defines the configuration for the startup probe.", "type": "object", "additionalProperties": false }, "StaticNodePool": { "properties": { "name": { "type": "string", "description": "Name is the name of this static nodePool" }, "nodeTypeSelector": { "items": { "$ref": "#/$defs/Requirement" }, "type": "array", "description": "NodeTypeSelector filters the types of nodes that can be provisioned by this pool.\nAll requirements must be met for a node type to be eligible." }, "taints": { "items": { "$ref": "#/$defs/KubeletJoinTaint" }, "type": "array", "description": "Taints are the taints to apply to the nodes in this pool." }, "nodeLabels": { "description": "NodeLabels are the labels to apply to the nodes in this pool.", "type": "object", "additionalProperties": { "type": "string" } }, "terminationGracePeriod": { "type": "string", "description": "TerminationGracePeriod is the maximum duration the controller will wait before forcefully deleting the pods on a node, measured from when deletion is first initiated.\n\nWarning: this feature takes precedence over a Pod's terminationGracePeriodSeconds value, and bypasses any blocked PDBs or the karpenter.sh/do-not-disrupt annotation.\n\nThis field is intended to be used by cluster administrators to enforce that nodes can be cycled within a given time period.\nWhen set, drifted nodes will begin draining even if there are pods blocking eviction. Draining will respect PDBs and the do-not-disrupt annotation until the TGP is reached.\n\nKarpenter will preemptively delete pods so their terminationGracePeriodSeconds align with the node's terminationGracePeriod.\nIf a pod would be terminated without being granted its full terminationGracePeriodSeconds prior to the node timeout,\nthat pod will be deleted at T = node timeout - pod terminationGracePeriodSeconds.\n\nThe feature can also be used to allow maximum time limits for long-running jobs which can delay node termination with preStop hooks.\nDefaults to 30s. Set to Never to wait indefinitely for pods to be drained." }, "quantity": { "type": "integer", "description": "Quantity is the number of desired nodes in this pool." } }, "required": [ "name", "quantity" ], "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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": { "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.", "type": "object", "additionalProperties": { "$ref": "#/$defs/SyncFromHostCustomResource" } }, "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." }, "deviceClasses": { "$ref": "#/$defs/EnableSwitchWithPatchesAndSelector", "description": "DeviceClasses defines if device classes in the host should get synced to the virtual cluster" } }, "type": "object", "additionalProperties": false }, "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" } }, "required": [ "enabled", "scope" ], "type": "object", "additionalProperties": false }, "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": { "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.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "SyncPods": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if pod syncing should be enabled." }, "translateImage": { "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", "type": "object", "additionalProperties": { "type": "string" } }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "SyncRewriteHostsInitContainer": { "properties": { "image": { "$ref": "#/$defs/Image", "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." } }, "type": "object", "additionalProperties": false }, "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." }, "endpointSlices": { "$ref": "#/$defs/EnableSwitchWithPatches", "description": "EndpointSlices defines if endpointslices 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": { "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.", "type": "object", "additionalProperties": { "$ref": "#/$defs/SyncToHostCustomResource" } }, "namespaces": { "$ref": "#/$defs/SyncToHostNamespaces", "description": "Namespaces defines if namespaces created within the virtual cluster should get synced to the host cluster." }, "resourceClaims": { "$ref": "#/$defs/EnableSwitchWithPatches", "description": "ResourceClaim defines if resource claims created within the virtual cluster should get synced to the host cluster." }, "resourceClaimTemplates": { "$ref": "#/$defs/EnableSwitchWithPatches", "description": "ResourceClaimTemplates defines if resourceClaimTemplates created within the virtual cluster should get synced to the host cluster." } }, "type": "object", "additionalProperties": false }, "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." } }, "required": [ "enabled" ], "type": "object", "additionalProperties": false }, "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": { "description": "ExtraLabels are additional labels to add to the namespace in the host cluster.", "type": "object", "additionalProperties": { "type": "string" } } }, "description": "SyncToHostNamespaces defines how namespaces should be synced from the virtual cluster to the host cluster.", "type": "object", "required": [ "enabled" ], "additionalProperties": false }, "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" } }, "type": "object", "additionalProperties": false }, "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." } }, "required": [ "path" ], "type": "object", "additionalProperties": false }, "TranslatePatchLabels": { "properties": {}, "type": "object", "additionalProperties": false }, "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." } }, "required": [ "apiVersion", "kind" ], "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "description": "ValidatingWebhookClientConfig contains the information to make a TLS connection with the webhook", "type": "object", "additionalProperties": false }, "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: ." }, "webhooks": { "items": { "$ref": "#/$defs/ValidatingWebhook" }, "type": "array", "description": "Webhooks is a list of webhooks and the affected resources and operations." } }, "type": "object", "additionalProperties": false }, "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)." } }, "type": "object", "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "VirtualClusterRef": { "properties": { "name": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "description": "Name is the name of the target virtual cluster." }, "project": { "type": "string", "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "description": "Project is the project of the target virtual cluster. If empty, defaults to the same project as the source vCluster." } }, "description": "VirtualClusterRef is a reference to a virtual cluster within the platform.", "type": "object", "required": [ "name" ], "additionalProperties": false }, "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." } }, "type": "object", "additionalProperties": false }, "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." } }, "description": "VolumeMount describes a mounting of a Volume within a container.", "type": "object", "additionalProperties": false }, "VolumeSnapshotController": { "properties": { "enabled": { "type": "boolean", "description": "Enabled defines if the CSI volumes snapshot-controller should be enabled." } }, "description": "VolumeSnapshotController defines CSI volumes snapshot-controller configuration.", "type": "object", "additionalProperties": false } }, "additionalProperties": false }