Parameters

The parent key for all of the following parameters is vcluster_provisioner.

charts

type

dictionary
default

see class/defaults.yml

Configure the charts to deploy.

images

type

dictionary
default

see class/defaults.yml

Configure the images to use.

infrastructure

type

dictionary

Configure the infrastructure.

infrastructure.type

type

string
default

'kubernetes'

The type of infrastructure to deploy to.

Only type kubernetes and openshift are supported.

infrastructure.namespace

type

dictionary
default 
infrastructure:
  namespace:
    annotations: {}
    labels: {}
    name: target-namespace

Configure the namespace of the target infrastructure.

controlPlane

type

dictionary

Configure the vcluster statefull set.

controlPlane.resources

type

dictionary
default 
controlPlane:
  resources:
    requests:
      cpu: 50m
      memory: 512Mi
    limits:
      memory: 2Gi

Configure the resources for the vcluster component.

controlPlane.storageClass

type

string
default

''

The storage class to use for the vcluster component.

controlPlane.storageSize

type

string
default

'5Gi'

The storage size to use for the vcluster component.

distribution

type

dictionary

Configure the vcluster distribution.

distribution.type

type

string
default

'k3s'

Define the distribution to use.

Only type k8s, k3s and k0s are supported.

distribution.resources

type

dictionary
default 
distribution:
  resources:
    requests:
      cpu: 10m
      memory: 64Mi
    limits:
      memory: 256Mi

Configure the resources for the distribution.

ingress

type

dictionary

Configure the ingress component.

ingress.enabled

type

boolean
default

true

Enable the ingress component.

ingress.host

type

string
default

'api.mycluster.local'

The host to use for the ingress component.

ingress.annotations and ingress.labels

type

dictionary
default

{}

Configure the annotations and labels for the ingress component.

sync

type

dictionary
default 
sync:
  fromHost: {}
  toHost: {}

Configure the sync configuration, see vCluster Sync.

helmValues

type

dictionary
default 
helmValues:
  vcluster: {}

Override the default values for the helm chart.

Example

namespace: example-namespace