Skip to content
SHC Docs

shc node update

update node metadata

Update a node’s public metadata in place (no reinstall, no rejoin): --public-address, the public IP or stable public hostname internet traffic reaches the node at, --location / --cloud, where the node is, --control-plane, whether the node is in the control plane, --reserve, the cpu, memory and disk the node keeps for work outside SHC, which placement and admission never use, --hypervisor, the connection the host of a node that is a virtual machine is read through, and --store, the store role the node is held to. An empty value clears a metadata field; a cleared location or cloud is detected again (SHC_NODE_LOCATION / SHC_NODE_CLOUD, then cloud metadata) when the node next starts. The control plane keeps at least one node.

shc node update <node> [flags]
shc node update home01 --reserve cpu=1,memory=4Gi,disk=50Gi
shc node update home01 --reserve disk=0
shc node update shc01 --hypervisor ogden-view
shc node update edge07 --store client
--cloud string who runs this node (hetzner, aws, proxmox, or your own name); empty clears it until the node next starts and detects it
--control-plane whether this node is in the control plane; true adds it (it must be able to vote), false takes it off, and the last node cannot leave
-h, --help help for update
--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, never writes through it, and takes off the node's room what the host cannot give it; empty clears it
--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; empty clears it until the node next starts and detects it
--public-address string public IP or stable public hostname internet traffic reaches this node at; empty clears it (managed DNS for internet exposure reads this)
--reserve string room this node keeps for work outside SHC, as cpu=<cores>,memory=<size>,disk=<size>; placement and admission never use it; a resource set to 0 clears it
--store string the store role this node is held to: voter (it runs the store and votes; control plane only), replica (it runs the store and serves the clients near it) or client (it runs no store and reaches one through a replica); empty lets the leader choose it again
--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