Skip to main content
Version: main 🚧

Config maps

Supported Configurations
Running the control plane as a container with:

By default, this is enabled.

Sync ConfigMap resources that are used by pods from the tenant cluster to the control plane cluster. Apps frequently need configuration data to function.

Sync only used ConfigMaps from the tenant to control plane cluster​

Sync any ConfigMap that is used by a Pod synced from the tenant to control plane cluster.

sync:
  toHost:
    configMaps:
      enabled: true

Sync all ConfigMaps from the tenant to control plane cluster​

If you have a resource in the control plane cluster monitoring ConfigMap objects that aren't required by a Pod to run, then you can enable the all option.

sync:
  toHost:
    configMaps:
      enabled: true
      all: true

Patches​

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

Config reference​

Do Not Disable

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

configMaps object ​

ConfigMaps defines if config maps created within the virtual cluster should get synced to the host cluster.

enabled boolean true ​

Enabled defines if this option should be enabled.

all boolean false ​

All defines if all resources of that type should get synced or only the necessary ones that are needed.

patches 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 string ​

Expression transforms the value according to the given JavaScript expression.

reverseExpression string ​

ReverseExpression transforms the value according to the given JavaScript expression.

reference 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 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 string ​

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

namePath string ​

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

namespacePath 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 object ​

Labels treats the path value as a labels selector.