Sync from host to virtual
Read more about how syncing works before deciding which resources to sync from the host cluster to the virtual cluster.
vCluster can sync certain resources from the host cluster to make them available inside the virtual cluster, but when these resources are synced, they are only synced in read-only mode. No changes to the resource in the virtual cluster syncs back to the host cluster as the resources are shared across the host cluster.
A good example would be nodes, which are nice to view inside the virtual cluster and can be also used to enabled certain features such as scheduling inside the vCluster, but you wouldn't want your virtual cluster to change the node itself. Another benefit of only syncing from host is that vCluster itself only requires read-only RBAC permissions.
vCluster also allows to sync custom resources via the custom resource definitions syncer
There are a couple of labels that are created on the host cluster by vCluster that never get synced to the virtual cluster resource. These labels are:
release(Label is needed to avoid conflicts with the vCluster pods themselves).vcluster.loft.sh/namespacevcluster.loft.sh/managed-byvcluster.loft.sh/controlled-byvcluster.loft.sh/ns-label-*These labels are added as management labels when synching from the virtual cluster to the host cluster, but skipped when syncing from the host cluster to the virtual cluster to prevent sync loops.
Resource creation behavior
Cluster-scoped resources
The following resources are not created during sync if they don’t already exist in the virtual cluster:
The following resouces are created in the virtual cluster as read-only if they don't already exist during the sync:
- Nodes
- IngressClasses
- StorageClasses
- Cluster-scoped CustomResources
Namespaced resources
Namespaced resources are automatically created in the virtual cluster if they do not already exist. Before synchronization occurs, the mapping between the host cluster source namespace name and the corresponding virtual cluster target namespace name must be defined. This applies to:
- Events
- ConfigMaps
- Secrets
- Namespace-scoped CustomResources
For CSIStorageCapacities, synchronization occurs only when a corresponding mapping exists between the physical StorageClass name in the host cluster and the StorageClass name in the virtual cluster and the capacity aligns with the associated physical node:
Enabled by default
Disabled by default
- CustomResources
- Nodes
- IngressClasses
- StorageClasses
- CSINodes
- CSIDrivers
- CSIStorageCapacities
- ConfigMaps
- Secrets
No bi-directional syncing
Since syncing resources from the host cluster is in read only mode and changes in the virtual cluster do not get applied to the resource in the host cluster, bi-directional syncing does not exist across these resources.
Config reference
fromHost required object
Configure what resources vCluster should sync from the host cluster to the virtual cluster.
fromHost required object nodes required object
Nodes defines if nodes should get synced from the host cluster to the virtual cluster, but not back.
nodes required object enabled required boolean false
Enabled specifies if syncing real nodes should be enabled. If this is disabled, vCluster will create fake nodes instead.
enabled required boolean false syncBackChanges required boolean false
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.
syncBackChanges required boolean false clearImageStatus required boolean false
ClearImageStatus will erase the image status when syncing a node. This allows to hide images that are pulled by the node.
clearImageStatus required boolean false selector required object
Selector can be used to define more granular what nodes should get synced from the host cluster to the virtual cluster.
selector required object all required boolean false
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.
all required boolean false labels required object {}
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.
labels required object {} patches required object[]
Patches patch the resource according to the provided specification.
patches required object[] path required string
Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.
path required string expression required string
Expression transforms the value according to the given JavaScript expression.
expression required string reverseExpression required string
ReverseExpression transforms the value according to the given JavaScript expression.
reverseExpression required string reference required object
Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.
reference required object apiVersion required string
APIVersion is the apiVersion of the referenced object.
apiVersion required string apiVersionPath required string
APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.
apiVersionPath required string kind required string
Kind is the kind of the referenced object.
kind required string kindPath required string
KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.
kindPath required string namePath required string
NamePath is the optional relative path to the reference name within the object.
namePath required string namespacePath required string
NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.
namespacePath required string labels required object
Labels treats the path value as a labels selector.
labels required object events required object
Events defines if events should get synced from the host cluster to the virtual cluster, but not back.
events required object enabled required boolean true
Enabled defines if this option should be enabled.
enabled required boolean true patches required object[]
Patches patch the resource according to the provided specification.
patches required object[] path required string
Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.
path required string expression required string
Expression transforms the value according to the given JavaScript expression.
expression required string reverseExpression required string
ReverseExpression transforms the value according to the given JavaScript expression.
reverseExpression required string reference required object
Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.
reference required object apiVersion required string
APIVersion is the apiVersion of the referenced object.
apiVersion required string apiVersionPath required string
APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.
apiVersionPath required string kind required string
Kind is the kind of the referenced object.
kind required string kindPath required string
KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.
kindPath required string namePath required string
NamePath is the optional relative path to the reference name within the object.
namePath required string namespacePath required string
NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.
namespacePath required string labels required object
Labels treats the path value as a labels selector.
labels required object ingressClasses required object
IngressClasses defines if ingress classes should get synced from the host cluster to the virtual cluster, but not back.
ingressClasses required object enabled required boolean false
Enabled defines if this option should be enabled.
enabled required boolean false patches required object[]
Patches patch the resource according to the provided specification.
patches required object[] path required string
Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.
path required string expression required string
Expression transforms the value according to the given JavaScript expression.
expression required string reverseExpression required string
ReverseExpression transforms the value according to the given JavaScript expression.
reverseExpression required string reference required object
Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.
reference required object apiVersion required string
APIVersion is the apiVersion of the referenced object.
apiVersion required string apiVersionPath required string
APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.
apiVersionPath required string kind required string
Kind is the kind of the referenced object.
kind required string kindPath required string
KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.
kindPath required string namePath required string
NamePath is the optional relative path to the reference name within the object.
namePath required string namespacePath required string
NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.
namespacePath required string labels required object
Labels treats the path value as a labels selector.
labels required object runtimeClasses required object
RuntimeClasses defines if runtime classes should get synced from the host cluster to the virtual cluster, but not back.
runtimeClasses required object enabled required boolean false
Enabled defines if this option should be enabled.
enabled required boolean false patches required object[]
Patches patch the resource according to the provided specification.
patches required object[] path required string
Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.
path required string expression required string
Expression transforms the value according to the given JavaScript expression.
expression required string reverseExpression required string
ReverseExpression transforms the value according to the given JavaScript expression.
reverseExpression required string reference required object
Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.
reference required object apiVersion required string
APIVersion is the apiVersion of the referenced object.
apiVersion required string apiVersionPath required string
APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.
apiVersionPath required string kind required string
Kind is the kind of the referenced object.
kind required string kindPath required string
KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.
kindPath required string namePath required string
NamePath is the optional relative path to the reference name within the object.
namePath required string namespacePath required string
NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.
namespacePath required string labels required object
Labels treats the path value as a labels selector.
labels required object priorityClasses required object
PriorityClasses defines if priority classes classes should get synced from the host cluster to the virtual cluster, but not back.
priorityClasses required object enabled required boolean false
Enabled defines if this option should be enabled.
enabled required boolean false patches required object[]
Patches patch the resource according to the provided specification.
patches required object[] path required string
Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.
path required string expression required string
Expression transforms the value according to the given JavaScript expression.
expression required string reverseExpression required string
ReverseExpression transforms the value according to the given JavaScript expression.
reverseExpression required string reference required object
Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.
reference required object apiVersion required string
APIVersion is the apiVersion of the referenced object.
apiVersion required string apiVersionPath required string
APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.
apiVersionPath required string kind required string
Kind is the kind of the referenced object.
kind required string kindPath required string
KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.
kindPath required string namePath required string
NamePath is the optional relative path to the reference name within the object.
namePath required string namespacePath required string
NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.
namespacePath required string labels required object
Labels treats the path value as a labels selector.
labels required object storageClasses required object
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.
storageClasses required object enabled required string|boolean auto
Enabled defines if this option should be enabled.
enabled required string|boolean auto patches required object[]
Patches patch the resource according to the provided specification.
patches required object[] path required string
Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.
path required string expression required string
Expression transforms the value according to the given JavaScript expression.
expression required string reverseExpression required string
ReverseExpression transforms the value according to the given JavaScript expression.
reverseExpression required string reference required object
Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.
reference required object apiVersion required string
APIVersion is the apiVersion of the referenced object.
apiVersion required string apiVersionPath required string
APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.
apiVersionPath required string kind required string
Kind is the kind of the referenced object.
kind required string kindPath required string
KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.
kindPath required string namePath required string
NamePath is the optional relative path to the reference name within the object.
namePath required string namespacePath required string
NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.
namespacePath required string labels required object
Labels treats the path value as a labels selector.
labels required object csiNodes required object
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.
csiNodes required object enabled required string|boolean auto
Enabled defines if this option should be enabled.
enabled required string|boolean auto patches required object[]
Patches patch the resource according to the provided specification.
patches required object[] path required string
Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.
path required string expression required string
Expression transforms the value according to the given JavaScript expression.
expression required string reverseExpression required string
ReverseExpression transforms the value according to the given JavaScript expression.
reverseExpression required string reference required object
Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.
reference required object apiVersion required string
APIVersion is the apiVersion of the referenced object.
apiVersion required string apiVersionPath required string
APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.
apiVersionPath required string kind required string
Kind is the kind of the referenced object.
kind required string kindPath required string
KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.
kindPath required string namePath required string
NamePath is the optional relative path to the reference name within the object.
namePath required string namespacePath required string
NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.
namespacePath required string labels required object
Labels treats the path value as a labels selector.
labels required object csiDrivers required object
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.
csiDrivers required object enabled required string|boolean auto
Enabled defines if this option should be enabled.
enabled required string|boolean auto patches required object[]
Patches patch the resource according to the provided specification.
patches required object[] path required string
Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.
path required string expression required string
Expression transforms the value according to the given JavaScript expression.
expression required string reverseExpression required string
ReverseExpression transforms the value according to the given JavaScript expression.
reverseExpression required string reference required object
Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.
reference required object apiVersion required string
APIVersion is the apiVersion of the referenced object.
apiVersion required string apiVersionPath required string
APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.
apiVersionPath required string kind required string
Kind is the kind of the referenced object.
kind required string kindPath required string
KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.
kindPath required string namePath required string
NamePath is the optional relative path to the reference name within the object.
namePath required string namespacePath required string
NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.
namespacePath required string labels required object
Labels treats the path value as a labels selector.
labels required object csiStorageCapacities required object
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.
csiStorageCapacities required object enabled required string|boolean auto
Enabled defines if this option should be enabled.
enabled required string|boolean auto patches required object[]
Patches patch the resource according to the provided specification.
patches required object[] path required string
Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.
path required string expression required string
Expression transforms the value according to the given JavaScript expression.
expression required string reverseExpression required string
ReverseExpression transforms the value according to the given JavaScript expression.
reverseExpression required string reference required object
Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.
reference required object apiVersion required string
APIVersion is the apiVersion of the referenced object.
apiVersion required string apiVersionPath required string
APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.
apiVersionPath required string kind required string
Kind is the kind of the referenced object.
kind required string kindPath required string
KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.
kindPath required string namePath required string
NamePath is the optional relative path to the reference name within the object.
namePath required string namespacePath required string
NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.
namespacePath required string labels required object
Labels treats the path value as a labels selector.
labels required object customResources required {key: object}
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.
customResources required {key: object} enabled required boolean
Enabled defines if this option should be enabled.
enabled required boolean scope required string
Scope defines the scope of the resource
scope required string patches required object[]
Patches patch the resource according to the provided specification.
patches required object[] path required string
Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.
path required string expression required string
Expression transforms the value according to the given JavaScript expression.
expression required string reverseExpression required string
ReverseExpression transforms the value according to the given JavaScript expression.
reverseExpression required string reference required object
Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.
reference required object apiVersion required string
APIVersion is the apiVersion of the referenced object.
apiVersion required string apiVersionPath required string
APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.
apiVersionPath required string kind required string
Kind is the kind of the referenced object.
kind required string kindPath required string
KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.
kindPath required string namePath required string
NamePath is the optional relative path to the reference name within the object.
namePath required string namespacePath required string
NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.
namespacePath required string labels required object
Labels treats the path value as a labels selector.
labels required object mappings required object
Mappings for Namespace and Object
mappings required object byName required object
ByName is a map of host-object-namespace/host-object-name: virtual-object-namespace/virtual-object-name.
There are several wildcards supported:
- To match all objects in host namespace and sync them to different namespace in vCluster:
byName:
"foo/": "foo-in-virtual/"
- To match specific object in the host namespace and sync it to the same namespace with the same name:
byName:
"foo/my-object": "foo/my-object"
- To match specific object in the host namespace and sync it to the same namespace with different name:
byName:
"foo/my-object": "foo/my-virtual-object"
- To match all objects in the vCluster host namespace and sync them to a different namespace in vCluster:
byName:
"": "my-virtual-namespace/*"
- To match specific objects in the vCluster host namespace and sync them to a different namespace in vCluster:
byName:
"/my-object": "my-virtual-namespace/my-object"
byName required object volumeSnapshotClasses required object
VolumeSnapshotClasses defines if volume snapshot classes created within the virtual cluster should get synced to the host cluster.
volumeSnapshotClasses required object enabled required boolean false
Enabled defines if this option should be enabled.
enabled required boolean false patches required object[]
Patches patch the resource according to the provided specification.
patches required object[] path required string
Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.
path required string expression required string
Expression transforms the value according to the given JavaScript expression.
expression required string reverseExpression required string
ReverseExpression transforms the value according to the given JavaScript expression.
reverseExpression required string reference required object
Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.
reference required object apiVersion required string
APIVersion is the apiVersion of the referenced object.
apiVersion required string apiVersionPath required string
APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.
apiVersionPath required string kind required string
Kind is the kind of the referenced object.
kind required string kindPath required string
KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.
kindPath required string namePath required string
NamePath is the optional relative path to the reference name within the object.
namePath required string namespacePath required string
NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.
namespacePath required string labels required object
Labels treats the path value as a labels selector.
labels required object configMaps required object
ConfigMaps defines if config maps in the host should get synced to the virtual cluster.
configMaps required object enabled required boolean false
Enabled defines if this option should be enabled.
enabled required boolean false patches required object[]
Patches patch the resource according to the provided specification.
patches required object[] path required string
Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.
path required string expression required string
Expression transforms the value according to the given JavaScript expression.
expression required string reverseExpression required string
ReverseExpression transforms the value according to the given JavaScript expression.
reverseExpression required string reference required object
Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.
reference required object apiVersion required string
APIVersion is the apiVersion of the referenced object.
apiVersion required string apiVersionPath required string
APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.
apiVersionPath required string kind required string
Kind is the kind of the referenced object.
kind required string kindPath required string
KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.
kindPath required string namePath required string
NamePath is the optional relative path to the reference name within the object.
namePath required string namespacePath required string
NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.
namespacePath required string labels required object
Labels treats the path value as a labels selector.
labels required object mappings required object
Mappings for Namespace and Object
mappings required object byName required object {}
ByName is a map of host-object-namespace/host-object-name: virtual-object-namespace/virtual-object-name.
There are several wildcards supported:
- To match all objects in host namespace and sync them to different namespace in vCluster:
byName:
"foo/": "foo-in-virtual/"
- To match specific object in the host namespace and sync it to the same namespace with the same name:
byName:
"foo/my-object": "foo/my-object"
- To match specific object in the host namespace and sync it to the same namespace with different name:
byName:
"foo/my-object": "foo/my-virtual-object"
- To match all objects in the vCluster host namespace and sync them to a different namespace in vCluster:
byName:
"": "my-virtual-namespace/*"
- To match specific objects in the vCluster host namespace and sync them to a different namespace in vCluster:
byName:
"/my-object": "my-virtual-namespace/my-object"
byName required object {} secrets required object
Secrets defines if secrets in the host should get synced to the virtual cluster.
secrets required object enabled required boolean false
Enabled defines if this option should be enabled.
enabled required boolean false patches required object[]
Patches patch the resource according to the provided specification.
patches required object[] path required string
Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.
path required string expression required string
Expression transforms the value according to the given JavaScript expression.
expression required string reverseExpression required string
ReverseExpression transforms the value according to the given JavaScript expression.
reverseExpression required string reference required object
Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.
reference required object apiVersion required string
APIVersion is the apiVersion of the referenced object.
apiVersion required string apiVersionPath required string
APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.
apiVersionPath required string kind required string
Kind is the kind of the referenced object.
kind required string kindPath required string
KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.
kindPath required string namePath required string
NamePath is the optional relative path to the reference name within the object.
namePath required string namespacePath required string
NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.
namespacePath required string labels required object
Labels treats the path value as a labels selector.
labels required object mappings required object
Mappings for Namespace and Object
mappings required object byName required object {}
ByName is a map of host-object-namespace/host-object-name: virtual-object-namespace/virtual-object-name.
There are several wildcards supported:
- To match all objects in host namespace and sync them to different namespace in vCluster:
byName:
"foo/": "foo-in-virtual/"
- To match specific object in the host namespace and sync it to the same namespace with the same name:
byName:
"foo/my-object": "foo/my-object"
- To match specific object in the host namespace and sync it to the same namespace with different name:
byName:
"foo/my-object": "foo/my-virtual-object"
- To match all objects in the vCluster host namespace and sync them to a different namespace in vCluster:
byName:
"": "my-virtual-namespace/*"
- To match specific objects in the vCluster host namespace and sync them to a different namespace in vCluster:
byName:
"/my-object": "my-virtual-namespace/my-object"
byName required object {} deviceClasses required object
DeviceClasses defines if device classes in the host should get synced to the virtual cluster
deviceClasses required object enabled required boolean false
Enabled defines if this option should be enabled.
enabled required boolean false patches required object[]
Patches patch the resource according to the provided specification.
patches required object[] path required string
Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.
path required string expression required string
Expression transforms the value according to the given JavaScript expression.
expression required string reverseExpression required string
ReverseExpression transforms the value according to the given JavaScript expression.
reverseExpression required string reference required object
Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode
automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with
other names, in multi-namespace mode this will not translate the name.
reference required object apiVersion required string
APIVersion is the apiVersion of the referenced object.
apiVersion required string apiVersionPath required string
APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.
apiVersionPath required string kind required string
Kind is the kind of the referenced object.
kind required string kindPath required string
KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.
kindPath required string namePath required string
NamePath is the optional relative path to the reference name within the object.
namePath required string namespacePath required string
NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the
metadata.namespace path of the object.
namespacePath required string labels required object
Labels treats the path value as a labels selector.
labels required object