Skip to main content
Version: main 🚧

Custom Resource Definitions


Pro Feature

This feature is available in the vCluster Pro tier. Contact us for more details and to start a trial.

vCluster allows you to sync custom resources from the host cluster to the virtual cluster. Resources will only be read by vCluster and then synced in read-only mode into the vCluster. vCluster will copy the CRD itself in the beginning from the host to the virtual cluster and then start syncing the resources into the vCluster. This is especially helpful if you want to show certain resources inside the vCluster, such as ClusterIssuers (for cert-manager) or ClusterStores (for external-secrets). If you are looking to sync resources from the vCluster to the host cluster, see syncing CRDs to the host cluster

Only Cluster-Scoped Resource

This feature currently only works for cluster-scoped resources only.

No need to configure RBAC

vCluster will automatically add the required cluster RBAC permissions for retrieving the custom resource definition and syncing the resources from the host to the virtual cluster.

Example​

To configure vCluster to sync ClusterIssuers from the host cluster (from cert-manager):

sync:
fromHost:
customResourceDefinitions:
clusterissuers.cert-manager.io:
enabled: true

Config reference​

customResourceDefinitions required {key: object} pro​

CustomResourceDefinitions defines what custom resource definitions should get synced read-only to the virtual cluster from the host cluster.

enabled required boolean pro​

Enabled defines if this option should be enabled.