Skip to main content
Version: v0.38 Stable

Pods

Supported Configurations
Running the control plane as a container with:

By default, this is enabled.

Sync all Pod resources, including ephemeral containers, from the cluster to the control plane cluster.

Automatically apply tolerations to all pods synced by vCluster​

Kubernetes has a concept of Taints and Tolerations, which is used for controlling scheduling. If you have a use case that requires vCluster to sync all pods and automatically set a toleration on those pods, then you can achieve this with the enforceTolerations option. You can pass multiple toleration expressions, and the syncer adds them to every new pod that vCluster syncs.

sync:
toHost:
pods:
enabled: true
enforceTolerations:
- example-key=example-value:NoSchedule
- another-key:PreferNoSchedule
info

vCluster does not support setting the tolerationSeconds field of a toleration. If your use case requires this, open an issue in the vCluster repo on GitHub.

Replace container images when pods are synced​

If certain images used within the cluster are not accessible in the control plane cluster due to registry restrictions or security policies, translateImage can map these to equivalent, permitted images in the control plane cluster's registry.

sync:
toHost:
pods:
enabled: true
translateImage:
"virtualcluster/image:tag": "hostcluster/alternative-image:tag"

Patches​

Use sync.toHost.pods.patches to transform Pod fields, such as spec.containers[*].name, while syncing to the control plane cluster. See Patching synced resources for syntax, directionality, and examples.

Use secrets for ServiceAccount tokens​

A host Pod requires a ServiceAccount token to communicate with the cluster's API. If you don't want to create these secrets in the control plane cluster, disable this option. vCluster then adds annotations to the pods.

Rewrite hosts​

Applies only to Pods that have the field spec.subdomain set. In such Pods, the fqdn hostname (hostname -f) is constructed based on the control plane cluster namespace the vCluster runs in. This is usually not what applications expect as they are unaware of the control plane cluster.

If this option is enabled, vCluster injects an initContainer to override the Pod's /etc/hosts file to change the fqdn hostname to match the expected domain. To pull that initContainer's image from your own registry, see Override the Alpine sidecar image.

Configuration change

In vCluster version 0.27.0, the rewriteHosts.initContainer.image configuration changed from a string to an object format. This change provides granular control over the registry, repository, and tag of the image.

For more information on the new object structure, see the configuration reference.

Config reference​

Do Not Disable

Disabling the syncing of this resource could cause the vCluster to not work properly.

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