Skip to main content
Version: main 🚧

Sync from the control plane cluster

Supported Configurations
Running the control plane as a container with:

Read more about how syncing works before deciding which resources to sync from the control plane cluster to the cluster.

vCluster can sync certain resources from the control plane cluster to make them available inside the cluster, but when these resources are synced, they are only synced in read-only mode. No changes to the resource in the cluster syncs back to the control plane cluster as the resources are shared across the control plane cluster.

A good example would be nodes, which are nice to view inside the cluster and can be also used to enabled certain features such as scheduling inside the vCluster, but you wouldn't want your cluster to change the node itself. Another benefit of only syncing from the control plane cluster is that vCluster itself only requires read-only RBAC permissions.

vCluster also lets you sync custom resources with the custom resource syncer

There are a couple of labels that are created on the control plane cluster by vCluster that never get synced to the cluster resource. These labels are:

  • release (Label is needed to avoid conflicts with the vCluster pods themselves).
  • vcluster.loft.sh/namespace
  • vcluster.loft.sh/managed-by
  • vcluster.loft.sh/controlled-by
  • vcluster.loft.sh/ns-label-* These labels are added as management labels when syncing from the cluster to the control plane cluster, but skipped when syncing from the control plane cluster to the 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 cluster:

The following resources are created in the cluster as read-only if they don't already exist during the sync:

Namespaced resources​

Namespaced resources are automatically created in the cluster if they do not already exist. Before synchronization occurs, the mapping between the control plane cluster source namespace name and the corresponding cluster target namespace name must be defined. This applies to:

For CSIStorageCapacities, synchronization occurs only when a corresponding mapping exists between the physical StorageClass name in the control plane cluster and the StorageClass name in the cluster and the capacity aligns with the associated physical node:

Enabled by default​

Disabled by default​

No bi-directional syncing​

Since syncing resources from the control plane cluster is in read only mode and changes in the cluster do not get applied to the resource in the control plane cluster, bi-directional syncing does not exist across these resources.

Config reference​

For every field under sync.fromHost, see the sync reference.