Skip to main content
Version: v0.38 Stable

Sync to 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 cluster to the control plane cluster.

vCluster syncs specific Kubernetes resources from the cluster to the control plane cluster. These resources are expected to be created and updated within the cluster. In addition to standard Kubernetes resources, custom resources can also be synced if configured.

Enabled by default​

The following resources are synced by default.

Disabled by default​

The following resources are not synced by default. You can explicitly enable them in your vcluster.yaml configuration.

Added by the cluster​

When syncing objects from the cluster to the control plane cluster, the cluster adds management labels to the control plane cluster-side objects.

In the default (single-namespace) mode, the following labels are added:

  • release
  • vcluster.loft.sh/namespace
  • vcluster.loft.sh/managed-by
  • vcluster.loft.sh/controlled-by
note

If sync.toHost.namespaces.enabled is true (multi-namespace sync), the cluster does not add the release label. Only the vcluster.loft.sh/* labels are applied.

Bidirectional syncing​

For all resources synced from the cluster to the control plane cluster, metadata.labels and metadata.annotations are synchronized in both directions. This means changes made in the cluster are reflected in the control plane cluster, and changes made in the control plane cluster are also reflected in the cluster.

vCluster specific Labels

Any labels prefixed with vcluster.loft.sh on the control plane cluster resources should not be updated by the user. These labels are managed by the vCluster control plane to track resources and prevent conflicts.

Additional fields that support bidirectional sync​

All metadata.labels and metadata.annotations are bidirectionally synced for resources synced from the cluster to the control plane cluster.
In addition to these fields, vCluster also supports bidirectional syncing for the following resource-specific fields:

ResourceFields
Pods
  • status.conditions
Secrets
  • spec.data
  • type
ConfigMaps
  • spec.data
  • spec.binaryData
Services
  • spec.externalIPs
  • spec.loadBalancerIP
  • spec.ports
  • spec.publishNotReadyAddresses
  • spec.type
  • spec.externalName
  • spec.externalTrafficPolicy
  • spec.sessionAffinity
  • spec.sessionAffinityConfig
  • spec.loadBalancerSourceRanges
  • spec.healthCheckNodePort
  • spec.selector
Ingresses
  • spec.ingressClassName
Gateway API
  • HTTPRoute, Gateway, TLSRoute, BackendTLSPolicy, and ReferenceGrant metadata and status fields vary by resource and controller support.
PersistentVolumes
  • spec.persistentVolumeSource
  • spec.capacity
  • spec.accessModes
  • spec.persistentVolumeReclaimPolicy
  • spec.nodeAffinity
  • spec.volumeMode
  • spec.mountOptions
StorageClass
  • spec.provisioner
  • spec.parameters
  • spec.reclaimPolicy
  • spec.mountOptions
  • spec.allowVolumeExpansion
  • spec.volumeBindingMode
  • spec.allowedTopologies

Config reference​

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

You can also browse these settings in the schema explorer (beta), laid out like the YAML you write. Click a field for its type, default, and description. Fold sections and filter to navigate quickly.