Sync

A virtual cluster does not have actual worker nodes or a network. Instead, the vCluster syncer component replicates the pods that are created within the virtual cluster to the host cluster. Subsequently, the host cluster schedules the pods, and the syncer keeps the virtual cluster pods and host cluster pods in sync.

By default, vCluster runs with a minimal set of RBAC permissions to allow execution in restricted environments. Certain resources require extra permissions to sync, which will automatically be given to the vCluster ServiceAccount if you enable the resource sync with the associated config value.

Sync from Virtual Cluser to Host Cluster

Enabled by Default

• Pods
• Secrets
• ConfigMaps
• Services
• Endpoints
• PersistentVolumeClaims

Disabled by Default

• Ingresses
• NetworkPolicies
• PersistentVolumes
• VolumeSnapshots
• StorageClasses
• ServiceAccounts
• PodDisruptionBudgets
• PriorityClasses

Config reference

sync required object pro

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

toHost required object pro

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

pods required object pro

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

enabled required boolean true pro

Enabled defines if pod syncing should be enabled.

translateImage required object {} pro

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

enforceTolerations required string[] [] pro

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

useSecretsForSATokens required boolean false pro

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

rewriteHosts required object pro

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

enabled required boolean true pro

Enabled specifies if rewriting stateful set pods should be enabled.

initContainer required object pro

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

image required string library/alpine:3.20 pro

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

resources required object pro

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

limits required object map[cpu:30m memory:64Mi] pro

Limits are resource limits for the container

requests required object map[cpu:30m memory:64Mi] pro

Requests are minimal resources that will be consumed by the container

translate required object[] pro

Translate the patch according to the given patches.

path required string pro

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

expression required object pro

Expression transforms the value according to the given JavaScript expression.

toHost required string pro

ToHost is the expression to apply when retrieving a change from virtual to host.

fromHost required string pro

FromHost is the patch to apply when retrieving a change from host to virtual.

reference required object pro

Reference rewrites the value value according to the name.

apiVersion required string pro

APIVersion is the apiVersion of the referenced object.

kind required string pro

Kind is the kind of the referenced object.

namePath required string pro

NamePath is the optional path to the reference name within the object. If omitted namePath equals to the translate patch path.

namespacePath required string pro

NamespacePath is the optional path to the reference namespace within the object. If omitted namespacePath equals to the metadata.namespace path of the object.

secrets required object pro

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

enabled required boolean true pro

Enabled defines if this option should be enabled.

all required boolean false pro

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

translate required object[] pro

Translate the patch according to the given patches.

path required string pro

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

expression required object pro

Expression transforms the value according to the given JavaScript expression.

toHost required string pro

ToHost is the expression to apply when retrieving a change from virtual to host.

fromHost required string pro

FromHost is the patch to apply when retrieving a change from host to virtual.

reference required object pro

Reference rewrites the value value according to the name.

apiVersion required string pro

APIVersion is the apiVersion of the referenced object.

kind required string pro

Kind is the kind of the referenced object.

namePath required string pro

NamePath is the optional path to the reference name within the object. If omitted namePath equals to the translate patch path.

namespacePath required string pro

NamespacePath is the optional path to the reference namespace within the object. If omitted namespacePath equals to the metadata.namespace path of the object.

configMaps required object pro

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

enabled required boolean true pro

Enabled defines if this option should be enabled.

all required boolean false pro

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

translate required object[] pro

Translate the patch according to the given patches.

path required string pro

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

expression required object pro

Expression transforms the value according to the given JavaScript expression.

toHost required string pro

ToHost is the expression to apply when retrieving a change from virtual to host.

fromHost required string pro

FromHost is the patch to apply when retrieving a change from host to virtual.

reference required object pro

Reference rewrites the value value according to the name.

apiVersion required string pro

APIVersion is the apiVersion of the referenced object.

kind required string pro

Kind is the kind of the referenced object.

namePath required string pro

NamePath is the optional path to the reference name within the object. If omitted namePath equals to the translate patch path.

namespacePath required string pro

NamespacePath is the optional path to the reference namespace within the object. If omitted namespacePath equals to the metadata.namespace path of the object.

ingresses required object pro

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

enabled required boolean false pro

Enabled defines if this option should be enabled.

translate required object[] pro

Translate the patch according to the given patches.

path required string pro

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

expression required object pro

Expression transforms the value according to the given JavaScript expression.

toHost required string pro

ToHost is the expression to apply when retrieving a change from virtual to host.

fromHost required string pro

FromHost is the patch to apply when retrieving a change from host to virtual.

reference required object pro

Reference rewrites the value value according to the name.

apiVersion required string pro

APIVersion is the apiVersion of the referenced object.

kind required string pro

Kind is the kind of the referenced object.

namePath required string pro

NamePath is the optional path to the reference name within the object. If omitted namePath equals to the translate patch path.

namespacePath required string pro

NamespacePath is the optional path to the reference namespace within the object. If omitted namespacePath equals to the metadata.namespace path of the object.

services required object pro

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

enabled required boolean true pro

Enabled defines if this option should be enabled.

translate required object[] pro

Translate the patch according to the given patches.

path required string pro

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

expression required object pro

Expression transforms the value according to the given JavaScript expression.

toHost required string pro

ToHost is the expression to apply when retrieving a change from virtual to host.

fromHost required string pro

FromHost is the patch to apply when retrieving a change from host to virtual.

reference required object pro

Reference rewrites the value value according to the name.

apiVersion required string pro

APIVersion is the apiVersion of the referenced object.

kind required string pro

Kind is the kind of the referenced object.

namePath required string pro

NamePath is the optional path to the reference name within the object. If omitted namePath equals to the translate patch path.

namespacePath required string pro

NamespacePath is the optional path to the reference namespace within the object. If omitted namespacePath equals to the metadata.namespace path of the object.

endpoints required object pro

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

enabled required boolean true pro

Enabled defines if this option should be enabled.

networkPolicies required object pro

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

enabled required boolean false pro

Enabled defines if this option should be enabled.

persistentVolumeClaims required object pro

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

enabled required boolean true pro

Enabled defines if this option should be enabled.

translate required object[] pro

Translate the patch according to the given patches.

path required string pro

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

expression required object pro

Expression transforms the value according to the given JavaScript expression.

toHost required string pro

ToHost is the expression to apply when retrieving a change from virtual to host.

fromHost required string pro

FromHost is the patch to apply when retrieving a change from host to virtual.

reference required object pro

Reference rewrites the value value according to the name.

apiVersion required string pro

APIVersion is the apiVersion of the referenced object.

kind required string pro

Kind is the kind of the referenced object.

namePath required string pro

NamePath is the optional path to the reference name within the object. If omitted namePath equals to the translate patch path.

namespacePath required string pro

NamespacePath is the optional path to the reference namespace within the object. If omitted namespacePath equals to the metadata.namespace path of the object.

persistentVolumes required object pro

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

enabled required boolean false pro

Enabled defines if this option should be enabled.

volumeSnapshots required object pro

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

enabled required boolean false pro

Enabled defines if this option should be enabled.

storageClasses required object pro

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

enabled required boolean false pro

Enabled defines if this option should be enabled.

serviceAccounts required object pro

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

enabled required boolean false pro

Enabled defines if this option should be enabled.

podDisruptionBudgets required object pro

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

enabled required boolean false pro

Enabled defines if this option should be enabled.

priorityClasses required object pro

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

enabled required boolean false pro

Enabled defines if this option should be enabled.

customResourceDefinitions required object pro

CustomResourceDefinitions defines what custom resource definitions should get synced from the virtual cluster to the host cluster.

fromHost required object pro

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

nodes required object pro

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

enabled required boolean false pro

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

syncBackChanges required boolean false pro

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 required boolean false pro

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

selector required object pro

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

all required boolean false pro

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 required object {} pro

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.

events required object pro

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

enabled required boolean true pro

Enabled defines if this option should be enabled.

ingressClasses required object pro

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

enabled required boolean false pro

Enabled defines if this option should be enabled.

runtimeClasses required object pro

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

enabled required boolean false pro

Enabled defines if this option should be enabled.

priorityClasses required object pro

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

enabled required boolean false pro

Enabled defines if this option should be enabled.

storageClasses required object pro

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.

enabled required string|boolean auto pro

Enabled defines if this option should be enabled.

csiNodes required object pro

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.

enabled required string|boolean auto pro

Enabled defines if this option should be enabled.

csiDrivers required object pro

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.

enabled required string|boolean auto pro

Enabled defines if this option should be enabled.

csiStorageCapacities required object pro

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.

enabled required string|boolean auto pro

Enabled defines if this option should be enabled.

customResourceDefinitions required object pro

CustomResourceDefinitions defines what custom resource definitions should get synced read-only to the virtual cluster from the host cluster.