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 The cluster IP address. string True
CLUSTER_ID The cluster id. string True
CLUSTER_SECRET The cluster secret. string True
Parameter Description Data Type Required Default
--ifname The management interface name. string False -
--mgmt-ip Management IP address to use for the node (e.g., 192.168.1.10). string False -
--mode The 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 The control plane node id. string True