Skip to content
SHC Docs

shc node join

join a cluster

Join the cluster identified by . Bootstrap token comes from shc node token on the leader. Write - for to read it from standard input, so it is on no command line: shc node token --fields token -o text prints it alone. A node that leaves comes back active when it joins again; a drain does not outlive the leave.

shc node join <token> [flags]
--cloud string who runs this node (hetzner, aws, proxmox, or your own name); recorded on the node row, else detected from cloud metadata
--control-plane put this node in the control plane (needs the voter capability)
-f, --force wipe local cluster state before joining (rejoin / move-to-other-cluster)
-h, --help help for join
--hypervisor string the connection to the hypervisor this node runs on as a virtual machine, as <connection> or <connection>/<instance>; SHC reads the host's capacity and the other instances on it through that connection and never writes through it
--label stringArray an operator label key=value this node joins with; repeatable, one value per key
--location string this node's location as its cloud names it (hel1, us-east-1a, or your own site name); shown and selected as <cloud>/<location> (e.g. incus/home), or the bare location without a cloud; recorded on the node row, else detected from cloud metadata
-n, --name string node name
--nic string network interface for all cluster-internal traffic (enroll address, raft, internal API, mesh0 underlay); blank = auto-detect (private-preferred)
--public-address string public IP or stable public hostname internet traffic reaches this node at (recorded on the node row; managed DNS for internet exposure reads it)
--reserve string room this node keeps for work outside SHC, as cpu=<cores>,memory=<size>,disk=<size>; placement and admission never use it
-r, --runtime string container runtime to declare for this node (docker, podman, incus or apple)
--config stringArray extra YAML config file to layer on top of auto-discovered config; repeatable, later files win
-d, --debug enable debug mode (default: $SHC_DEBUG)
-e, --environment string environment name (default: "prod", or "default" on an estate with no licence and no trial; $SHC_ENVIRONMENT and shc ctx -e override it, and the "master" tenant is always "default")
--exclude string comma-separated dotted paths to drop
--fields string comma-separated columns/keys to show (and their order)
--filter string comma-separated dotted paths to keep (drops everything else)
-o, --output string output format: tty|text|json|yaml (default: $SHC_OUTPUT)
-s, --stack string stack name (default: $SHC_STACK)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)
  • shc node - manage and inspect cluster nodes