Skip to main content

Sync to Host from Virtual

Declare which virtual cluster resources you want to sync to the host cluster.

Enabled by Default​

Disabled by Default​

Config reference​

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.