Skip to content

Control plane commands

sbctl control-plane --help

Aliases: cp mgmt

Control plane commands

Adds a control plane to the cluster (local run)

Adds a control plane to the cluster (local run)

sbctl control-plane add
    <CLUSTER_IP>
    <CLUSTER_ID>
    <CLUSTER_SECRET>
    --ifname=<IFNAME>
    --mgmt-ip=<MGMT_IP>
    --mode=<MODE>
Argument Description Data Type Required
CLUSTER_IP Cluster IP address string True
CLUSTER_ID Cluster id string True
CLUSTER_SECRET Cluster secret string True
Parameter Description Data Type Required Default
--ifname Management interface name string False -
--mgmt-ip Management IP address to use for the node (e.g., 192.168.1.10) string False -
--mode Environment to deploy management services, default: docker

Available Options:
- docker
- kubernetes
string False docker

Lists all control plane nodes

Lists all control plane nodes

sbctl control-plane list
    --json
Parameter Description Data Type Required Default
--json Print outputs in json format marker False -

Removes a control plane node

Removes a control plane node

sbctl control-plane remove
    <NODE_ID>
Argument Description Data Type Required
NODE_ID Control plane node id string True