Skip to main content

Integrations

Supported Configurations
Running the control plane as a container with:

Config reference​

integrations required object ​

Integrations holds config for vCluster integrations with other operators or tools running on the host cluster

metricsServer required object ​

MetricsServer reuses the metrics server from the host cluster within the vCluster.

enabled required boolean false ​

Enabled signals the metrics server integration should be enabled.

apiService required object ​

APIService holds information about where to find the metrics-server service. Defaults to metrics-server/kube-system.

service required object ​

Service is a reference to the service for the API server.

name required string ​

Name is the name of the host service of the apiservice.

namespace required string ​

Namespace is the name of the host service of the apiservice.

port required integer ​

Port is the target port on the host service to connect to.

nodes required boolean true ​

Nodes defines if metrics-server nodes api should get proxied from host to virtual cluster.

pods required boolean true ​

Pods defines if metrics-server pods api should get proxied from host to virtual cluster.

kubeVirt required object ​

KubeVirt reuses a host kubevirt and makes certain CRDs from it available inside the vCluster

enabled required boolean false ​

Enabled signals if the integration should be enabled

apiService required object ​

APIService holds information about where to find the virt-api service. Defaults to virt-api/kubevirt.

service required object ​

Service is a reference to the service for the API server.

name required string ​

Name is the name of the host service of the apiservice.

namespace required string ​

Namespace is the name of the host service of the apiservice.

port required integer ​

Port is the target port on the host service to connect to.

webhook required object ​

Webhook holds configuration for enabling the webhook within the vCluster

enabled required boolean true ​

Enabled defines if this option should be enabled.

sync required object ​

Sync holds configuration on what resources to sync

dataVolumes required object ​

If DataVolumes should get synced

enabled required boolean false ​

Enabled defines if this option should be enabled.

virtualMachineInstanceMigrations required object ​

If VirtualMachineInstanceMigrations should get synced

enabled required boolean true ​

Enabled defines if this option should be enabled.

virtualMachineInstances required object ​

If VirtualMachineInstances should get synced

enabled required boolean true ​

Enabled defines if this option should be enabled.

virtualMachines required object ​

If VirtualMachines should get synced

enabled required boolean true ​

Enabled defines if this option should be enabled.

virtualMachineClones required object ​

If VirtualMachineClones should get synced

enabled required boolean true ​

Enabled defines if this option should be enabled.

virtualMachinePools required object ​

If VirtualMachinePools should get synced

enabled required boolean true ​

Enabled defines if this option should be enabled.

externalSecrets required object ​

ExternalSecrets reuses a host external secret operator and makes certain CRDs from it available inside the vCluster.

  • ExternalSecrets will be synced from the virtual cluster to the host cluster.
  • SecretStores will be synced from the virtual cluster to the host cluster and then bi-directionally.
  • ClusterSecretStores will be synced from the host cluster to the virtual cluster.

enabled required boolean false ​

Enabled defines whether the external secret integration is enabled or not

version required string ​

Version defines the version of the external secrets operator to use. If empty, the storage version will be used.

webhook required object ​

Webhook defines whether the host webhooks are reused or not

enabled required boolean false ​

Enabled defines if this option should be enabled.

sync required object ​

Sync defines the syncing behavior for the integration

toHost required object ​

ToHost defines what resources are synced from the virtual cluster to the host

externalSecrets required object ​

ExternalSecrets allows to configure if only a subset of ExternalSecrets matching a label selector should get synced from the virtual cluster to the host cluster.

selector required object ​
matchLabels required object {} ​
matchExpressions required object[] ​
key required string ​
operator required string ​
values required string[] ​
stores required object ​

Stores defines if secret stores should get synced from the virtual cluster to the host cluster and then bi-directionally.

selector required object ​
matchLabels required object {} ​
matchExpressions required object[] ​
key required string ​
operator required string ​
values required string[] ​
enabled required boolean false ​

Enabled defines if this option should be enabled.

fromHost required object ​

FromHost defines what resources are synced from the host cluster to the virtual cluster

clusterStores required object ​

ClusterStores defines if cluster secrets stores should get synced from the host cluster to the virtual cluster.

selector required object ​
matchLabels required object {} ​
matchExpressions required object[] ​
key required string ​
operator required string ​
values required string[] ​
enabled required boolean false ​

Enabled defines if this option should be enabled.

certManager required object ​

CertManager reuses a host cert-manager and makes its CRDs from it available inside the vCluster.

  • Certificates and Issuers will be synced from the virtual cluster to the host cluster.
  • ClusterIssuers will be synced from the host cluster to the virtual cluster.

enabled required boolean false ​

Enabled defines if this option should be enabled.

sync required object ​

Sync contains advanced configuration for syncing cert-manager resources.

toHost required object ​
certificates required object ​

Certificates defines if certificates should get synced from the virtual cluster to the host cluster.

enabled required boolean true ​

Enabled defines if this option should be enabled.

issuers required object ​

Issuers defines if issuers should get synced from the virtual cluster to the host cluster.

enabled required boolean true ​

Enabled defines if this option should be enabled.

fromHost required object ​
clusterIssuers required object ​

ClusterIssuers defines if (and which) cluster issuers should get synced from the host cluster to the virtual cluster.

enabled required boolean true ​

Enabled defines if this option should be enabled.

selector required object ​

Selector defines what cluster issuers should be imported.

labels required object {} ​

Labels defines what labels should be looked for

istio required object ​

Istio syncs DestinationRules, Gateways and VirtualServices from virtual cluster to the host.

enabled required boolean false ​

Enabled defines if this option should be enabled.

sync required object ​

toHost required object ​
destinationRules required object ​
enabled required boolean true ​

Enabled defines if this option should be enabled.

gateways required object ​
enabled required boolean true ​

Enabled defines if this option should be enabled.

virtualServices required object ​
enabled required boolean true ​

Enabled defines if this option should be enabled.

netris required object ​

Netris integration helps configuring netris networking for vCluster.

enabled required boolean ​

Enabled defines if netris integration is enabled

connector required string ​

Connector specifies the netris connector name

kubeVip required object ​

KubeVip holds kube-vip configuration for netris

serverCluster required string ​

ServerCluster specifies the server cluster name

bridge required string ​

Bridge specifies the bridge interface name

ipRange required string ​

IPRange specifies the IP range for kube-vip