Skip to main content
Version: main 🚧

integrations

The integrations key configures integrations with tools on the control plane cluster, such as cert-manager, External Secrets Operator, Istio, KubeVirt, the control plane cluster's metrics server, Netris, and Argo CD. For setup guides, see the integration pages, such as External Secrets Operator and Istio.

integrations object ​

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

metricsServer object ​

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

enabled boolean false ​

Enabled signals the metrics server integration should be enabled.

apiService object ​

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

service object ​

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

name string ​

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

namespace string ​

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

port integer ​

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

nodes boolean true ​

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

pods boolean true ​

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

kubeVirt object ​

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

enabled boolean false ​

Enabled signals if the integration should be enabled

apiService object ​

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

service object ​

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

name string ​

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

namespace string ​

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

port integer ​

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

webhook object ​

Webhook holds configuration for enabling the webhook within the vCluster

enabled boolean true ​

Enabled defines if this option should be enabled.

sync object ​

Sync holds configuration on what resources to sync

dataVolumes object ​

If DataVolumes should get synced

enabled boolean false ​

Enabled defines if this option should be enabled.

virtualMachineInstanceMigrations object ​

If VirtualMachineInstanceMigrations should get synced

enabled boolean true ​

Enabled defines if this option should be enabled.

virtualMachineInstances object ​

If VirtualMachineInstances should get synced

enabled boolean true ​

Enabled defines if this option should be enabled.

virtualMachines object ​

If VirtualMachines should get synced

enabled boolean true ​

Enabled defines if this option should be enabled.

virtualMachineClones object ​

If VirtualMachineClones should get synced

enabled boolean true ​

Enabled defines if this option should be enabled.

virtualMachinePools object ​

If VirtualMachinePools should get synced

enabled boolean true ​

Enabled defines if this option should be enabled.

externalSecrets 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 boolean false ​

Enabled defines whether the external secret integration is enabled or not

version string ​

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

webhook object ​

Webhook defines whether the host webhooks are reused or not

enabled boolean false ​

Enabled defines if this option should be enabled.

sync object ​

Sync defines the syncing behavior for the integration

toHost object ​

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

externalSecrets 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 object ​
matchLabels object {} ​
matchExpressions object[] ​
key string ​
operator string ​
values string[] ​
stores object ​

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

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

Enabled defines if this option should be enabled.

fromHost object ​

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

clusterStores object ​

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

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

Enabled defines if this option should be enabled.

certManager 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 boolean false ​

Enabled defines if this option should be enabled.

sync object ​

Sync contains advanced configuration for syncing cert-manager resources.

toHost object ​
certificates object ​

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

enabled boolean true ​

Enabled defines if this option should be enabled.

issuers object ​

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

enabled boolean true ​

Enabled defines if this option should be enabled.

fromHost object ​
clusterIssuers object ​

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

enabled boolean true ​

Enabled defines if this option should be enabled.

selector object ​

Selector defines what cluster issuers should be imported.

labels object {} ​

Labels defines what labels should be looked for

istio object ​

Istio syncs DestinationRules, Gateways and VirtualServices from virtual cluster to the host. Deprecated: The Istio integration is deprecated and will be removed in a future release.

enabled boolean false ​

Enabled defines if this option should be enabled.

sync object ​

toHost object ​
destinationRules object ​
enabled boolean true ​

Enabled defines if this option should be enabled.

gateways object ​
enabled boolean true ​

Enabled defines if this option should be enabled.

virtualServices object ​
enabled boolean true ​

Enabled defines if this option should be enabled.

netris object ​

Netris integration helps configuring netris networking for vCluster.

enabled boolean ​

Enabled defines if netris integration is enabled

connector string ​

Connector specifies the netris connector name

kubeVip object ​

KubeVip holds kube-vip configuration for netris

serverCluster string ​

ServerCluster specifies the server cluster name

bridge string ​

Bridge specifies the bridge interface name

ipRange string ​

IPRange specifies the IP range for kube-vip

argoCD object ​

ArgoCD integration helps configuring ArgoCD for vCluster.

enabled boolean ​

Enabled defines if argo cd integration is enabled

connector string ​

Connector specifies the argo cd connector name

cluster object ​

Cluster holds settings for the cluster entry that is registered in argo cd

metadata object ​

Metadata is set on the argo cd cluster, so an ApplicationSet cluster generator can select it. On Akuity, a key removed here stays on the cluster until it is removed in Akuity.

labels object ​

Labels are set on the argo cd cluster

annotations object ​

Annotations are set on the argo cd cluster

observability object ​

Observability integration configures delivery of the platform metrics-writer credential.

enabled boolean ​

Enabled defines if the observability integration is enabled. Connector must also be set for the integration to be considered configured.

connector string ​

Connector specifies the Platform observability connector to connect to. Required when Enabled is true for the integration to be considered configured.

gatewaySecret object ​

GatewaySecret overrides where the metrics-writer Secret is delivered. When unset, the shared default target is used: namespace "observability", name "metrics-writer".

namespace string ​

Namespace is the namespace the Secret is delivered to. Required when gatewaySecret is set.

name string ​

Name is the name of the delivered Secret. Required when gatewaySecret is set.