Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/loft-sh/vcluster/llms.txt

Use this file to discover all available pages before exploring further.

​
Synopsis

Manage nodes in a virtual cluster. 
vcluster node [command] [flags]

​
Subcommands

  • join - Join a node to a virtual cluster
  • delete - Remove a node from a virtual cluster

​
vcluster node join

Join a physical node to a virtual cluster (used with private nodes or standalone mode).

​
Synopsis

vcluster node join [flags]

​
Examples

# Join node to vCluster (run on the node)
vcluster node join \
  --server https://vcluster.example.com:443 \
  --token eyJhbGc...

# Join with custom kubelet config
vcluster node join \
  --server https://vcluster.example.com:443 \
  --token eyJhbGc... \
  --kubelet-config /etc/kubelet/config.yaml

​
Flags

​
--server
string
required
The vCluster API server URL.
​
--token
string
required
Bootstrap token for joining.
​
--kubelet-config
string
Path to kubelet configuration file.
​
--kubelet-extra-args
string
Additional kubelet arguments.

​
Getting Join Tokens

To get a join token from your vCluster: 
# Connect to vCluster
vcluster connect my-vcluster -n team-x

# Create token
vcluster token create node-join-token

​
Complete Example

​
Private Nodes Setup

# On control plane
vcluster create my-vcluster -n team-x --values private-nodes.yaml

# Get join command
vcluster token create node-join

# On worker node
curl -L https://github.com/loft-sh/vcluster/releases/latest/download/vcluster-linux-amd64 -o /usr/local/bin/vcluster
chmod +x /usr/local/bin/vcluster

vcluster node join \
  --server https://my-vcluster.example.com:443 \
  --token <token-from-above>

​
See Also

Build docs developers (and LLMs) love

Get started for freeTalk to us