Skip to main content
Version: main 🚧

ResourceClaims

Enterprise
Available in these plansFreeDevProdScale
DRA Sync
Supported Configurations
Running the control plane as a container with:

By default, this is disabled.

When enabled, sync all ResourceClaims resources from the tenant cluster to the control plane cluster. Use this option to create resource claims that can be referenced in workloads created in the vCluster.

When enabled, vCluster automatically tries to detect the presence of api-resource resource.k8s.io/v1 on the control plane cluster and fails to start up if the api-resource is missing.

Referenced Device Class

The resource claims must reference device classes synced from the host.

Sync ResourceClaims from the tenant to control plane cluster​

sync:
  toHost:
    resourceClaims:
      enabled: true

Patches​

Use sync.toHost.resourceClaims.patches to transform ResourceClaim fields while syncing to the control plane cluster. See Patching synced resources for syntax, directionality, and examples.

Config reference​

resourceClaims required object ​

ResourceClaims defines if resource claims created within the virtual cluster should get synced to the host cluster.

enabled required boolean false ​

Enabled defines if this option should be enabled.

patches required object[] ​

Patches patch the resource according to the provided specification.

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.

expression required string ​

Expression transforms the value according to the given JavaScript expression.

reverseExpression required string ​

ReverseExpression transforms the value according to the given JavaScript expression.

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.

apiVersion required string ​

APIVersion is the apiVersion of the referenced object.

apiVersionPath required string ​

APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.

kind required string ​

Kind is the kind of the referenced object.

kindPath required string ​

KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.

namePath required string ​

NamePath is the optional relative path to the reference name within the object.

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.

labels required object ​

Labels treats the path value as a labels selector.