Skip to content
SHC Docs

shc node leave

leave the cluster

Leave this node’s cluster when no node is named, or request the named node to leave. Stops this node’s member subsystems and moves certs, node.id, cluster_join.json, node_bootstrap.json, rqlite, shc.db and its journals, mesh, fabric, engine.json, rqlite_promote_pending, .force-rejoin, vault-envelope-identity, system-apps.initialized, leave-pending.json into a dated left-cluster directory under the state home. The output names that directory. Keeps images, deployment files and deployment volumes. The node can then join again. A node that leaves comes back active when it joins again; a drain does not outlive the leave.

With --purge this instead wipes all local SHC state and every SHC deployment’s containers, networks and volumes. All app data is destroyed. This option is self-only and requires --force. Non-SHC docker volumes are untouched.

shc node leave [node] [flags]
-f, --force force removal
-h, --help help for leave
--purge destructive self-only: wipe all local SHC state (database, certs, every deployment's containers/networks/volumes); requires --force
--resume resume a previously failed leave
-y, --yes skip confirmation prompt
--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