Skip to main content

Standalone

Supported Configurations
Running the control plane as a binary with vCluster Standalone. When scaling with additional worker nodes, they are joined as private nodes.

vCluster Standalone is a different architecture model for vCluster where the control plane runs directly on your infrastructure with no dependency on an existing Control Plane Cluster. vCluster is deployed directly onto nodes like other Kubernetes distributions. vCluster Standalone can run on any type of node, whether that is a bare-metal node or VM. It provides the strictest tenant isolation as there is no shared Control Plane Cluster for the control plane or worker nodes.

When using vCluster Standalone, the control plane runs on its own independent node rather than as a pod on a shared cluster. Worker nodes must be private nodes.


Comparison of traditional vCluster (control plane as pod) versus vCluster Standalone (control plane as binary on dedicated nodes)

For more information see the full Standalone Documentation

Config reference​

standalone object ​

Standalone holds configuration for standalone mode. Standalone mode is set automatically when no container is detected and also implies privateNodes.enabled.

enabled boolean ​

Enabled defines if standalone mode should be enabled.

dataDir string /var/lib/vcluster ​

DataDir defines the data directory for the standalone mode.

autoNodes object ​

AutoNodes automatically deploys nodes for standalone mode.

provider string ​

Provider is the node provider of the nodes in this pool.

quantity integer ​

Quantity is the number of nodes to deploy for standalone mode.

nodeTypeSelector object[] ​

NodeTypeSelector filters the types of nodes that can be provisioned by this pool. All requirements must be met for a node type to be eligible.

property required string ​

Property is the property on the node type to select.

operator string ​

Operator is the comparison operator, such as "In", "NotIn", "Exists". If empty, defaults to "In".

values string[] ​

Values is the list of values to use for comparison. This is mutually exclusive with value.

value string ​

Value is the value to use for comparison. This is mutually exclusive with values.

joinNode object ​

JoinNode holds configuration for the standalone control plane node.

enabled boolean true ​

Enabled defines if the standalone node should be joined into the cluster. If false, only the control plane binaries will be executed and no node will show up in the actual cluster.

preInstallCommands string[] ​

PreInstallCommands are commands that will be executed before containerd, kubelet etc. is installed.

preJoinCommands string[] ​

PreJoinCommands are commands that will be executed before kubeadm join is executed.

postJoinCommands string[] ​

PostJoinCommands are commands that will be executed after kubeadm join is executed.

containerd object ​

Containerd holds configuration for the containerd join process.

enabled boolean true ​

Enabled defines if containerd should be installed and configured by vCluster.

registry object ​

Registry holds configuration for how containerd should be configured to use a registries.

configPath string ​

ConfigPath is the path to the containerd registry config.

mirrors {key: object} ​

Mirrors holds configuration for the containerd registry mirrors. E.g. myregistry.io:5000 or docker.io. See https://github.com/containerd/containerd/blob/main/docs/hosts.md for more details.

server string ​

Server is the fallback server to use for the containerd registry mirror. E.g. https://registry-1.docker.io. See https://github.com/containerd/containerd/blob/main/docs/hosts.md for more details.

caCert string[] ​

CACert are paths to CA certificates to use for the containerd registry mirror.

skipVerify boolean ​

SkipVerify is a boolean to skip the certificate verification for the containerd registry mirror and allows http connections.

capabilities string[] ​

Capabilities is a list of capabilities to enable for the containerd registry mirror. If empty, will use pull and resolve capabilities.

overridePath boolean ​

OverridePath is a boolean to override the path for the containerd registry mirror.

hosts object[] ​

Hosts holds configuration for the containerd registry mirror hosts. See https://github.com/containerd/containerd/blob/main/docs/hosts.md for more details.

server string ​

Server is the server to use for the containerd registry mirror host. E.g. http://192.168.31.250:5000.

caCert string[] ​

CACert are paths to CA certificates to use for the containerd registry mirror host.

skipVerify boolean ​

SkipVerify is a boolean to skip the certificate verification for the containerd registry mirror and allows http connections.

capabilities string[] ​

Capabilities is a list of capabilities to enable for the containerd registry mirror. If empty, will use pull and resolve capabilities.

overridePath boolean ​

OverridePath is a boolean to override the path for the containerd registry mirror.

auth {key: object} ​

Auth holds configuration for the containerd registry auth. See https://github.com/containerd/containerd/blob/main/docs/cri/registry.md#configure-registry-credentials for more details.

username string ​

Username is the username for the containerd registry.

password string ​

Password is the password for the containerd registry.

identityToken string ​

IdentityToken is the token for the containerd registry.

auth string ​

Auth is the auth config for the containerd registry.

pauseImage string ​

PauseImage is the image for the pause container.

caCertPath string ​

CACertPath is the path to the SSL certificate authority used to secure communications between node and control-plane. Defaults to "/etc/kubernetes/pki/ca.crt".

skipPhases string[] ​

SkipPhases is a list of phases to skip during command execution. The list of phases can be obtained with the "kubeadm join --help" command.

nodeRegistration object ​

NodeRegistration holds configuration for the node registration similar to the kubeadm node registration.

criSocket string ​

CRI socket is the socket for the CRI.

kubeletExtraArgs object[] ​

KubeletExtraArgs passes through extra arguments to the kubelet. The arguments here are passed to the kubelet command line via the environment file kubeadm writes at runtime for the kubelet to source. This overrides the generic base-level configuration in the kubelet-config ConfigMap Flags have higher priority when parsing. These values are local and specific to the node kubeadm is executing on. An argument name in this list is the flag name as it appears on the command line except without leading dash(es). Extra arguments will override existing default arguments. Duplicate extra arguments are allowed.

name string ​

Name is the name of the argument.

value string ​

Value is the value of the argument.

taints object[] ​

Taints are additional taints to set for the kubelet.

key string ​

Required. The taint key to be applied to a node.

value string ​

The taint value corresponding to the taint key.

effect string ​

Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.

ignorePreflightErrors string[] ​

IgnorePreflightErrors provides a slice of pre-flight errors to be ignored when the current node is registered, e.g. 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.

imagePullPolicy string ​

ImagePullPolicy specifies the policy for image pulling during kubeadm "init" and "join" operations. The value of this field must be one of "Always", "IfNotPresent" or "Never". If this field is unset kubeadm will default it to "IfNotPresent", or pull the required images if not present on the host.