Values Reference - vCluster

This page provides a comprehensive reference for all available configuration options in vCluster’s values.yaml. These values control the behavior of your virtual cluster deployment.

Configuration Structure

vCluster configuration is organized into several main sections:

sync: Resource synchronization between virtual and host clusters
controlPlane: Control plane components and deployment settings
networking: Network configuration and DNS settings
rbac: Role-Based Access Control configuration
policies: Resource quotas, limits, and network policies
integrations: Third-party operator integrations
deploy: Additional components to deploy
privateNodes: Private nodes mode configuration
experimental: Experimental features

Top-Level Configuration Options

exportKubeConfig

object

Configure how vCluster exports the kubeconfig file.

Show properties

context

string

Name of the context within the generated kubeconfig.

server

string

Custom hostname for the generated kubeconfig. Overrides default https://localhost:8443.

insecure

boolean

default:"false"

Skip TLS verification for the server.

serviceAccount

object

Generate a service account token instead of default certificates.

Show properties

name

string

Service account name to use for token generation.

namespace

string

default:"kube-system"

Namespace of the service account.

clusterRole

string

ClusterRole to assign to the service account.

additionalSecrets

array

Additional host cluster secrets where vCluster stores the generated kubeconfig.

plugins

object

Define which vCluster plugins to load. This is a map of plugin configurations.

telemetry

object

Configuration related to telemetry gathered about vCluster usage.

Show properties

enabled

boolean

default:"true"

Enable telemetry for the vCluster control plane.

logging

object

Structured logging options for vCluster.

Show properties

encoding

string

default:"console"

Format of vCluster logs. Can be json or console.

Example: Basic Configuration

exportKubeConfig:
  context: my-vcluster
  server: https://vcluster.example.com
  insecure: false

telemetry:
  enabled: true

logging:
  encoding: json

Example: Service Account Authentication

exportKubeConfig:
  serviceAccount:
    name: vcluster-admin
    namespace: kube-system
    clusterRole: cluster-admin
  additionalSecrets:
    - name: vcluster-kubeconfig
      namespace: team-a
    - name: vcluster-kubeconfig-backup
      namespace: team-b

Global Values

global

object

Global values shared across all Helm (sub)charts. These values are passed to all sub-charts and can be used for consistent configuration across the deployment.

See Sync Configuration for resource synchronization options
See Control Plane for control plane settings
See Networking Options for network configuration
See RBAC Configuration for access control settings

Validation

vCluster validates the configuration on startup. Common validation rules include:

Backing store type cannot be changed after initial deployment
Namespace sync settings cannot be modified after enabling
VPN settings cannot be toggled after initial configuration

For a full list of immutable configuration options, refer to the vCluster upgrade documentation.

Reference

Documentation Index

​Configuration Structure

​Top-Level Configuration Options

​Example: Basic Configuration

​Example: Service Account Authentication

​Global Values

​Related Configuration

​Validation

Build docs developers (and LLMs) love

Configuration Structure

Top-Level Configuration Options

Example: Basic Configuration

Example: Service Account Authentication

Global Values

Related Configuration

Validation