Cluster commands

sbcli-pre cluster --help

Cluster commands

Deploys a storage nodes

sbcli-pre cluster deploy
    --storage-nodes=<STORAGE_NODES>
    --test
    --secondary-nodes=<SECONDARY_NODES>
    --ha-type=<HA_TYPE>
    --data-chunks-per-stripe=<DATA_CHUNKS_PER_STRIPE>
    --parity-chunks-per-stripe=<PARITY_CHUNKS_PER_STRIPE>
    --ifname=<IFNAME>
    --cap-warn=<CAP_WARN>
    --cap-crit=<CAP_CRIT>
    --prov-cap-warn=<PROV_CAP_WARN>
    --prov-cap-crit=<PROV_CAP_CRIT>
    --log-del-interval=<LOG_DEL_INTERVAL>
    --metrics-retention-period=<METRICS_RETENTION_PERIOD>
    --contact-point=<CONTACT_POINT>
    --chunk-size-in-bytes=<CHUNK_SIZE_IN_BYTES>
    --enable-node-affinity
    --qpair-count=<QPAIR_COUNT>
    --strict-node-anti-affinity
    --journal-partition=<JOURNAL_PARTITION>
    --data-nics=<DATA_NICS>
    --max-lvol=<MAX_LVOL>
    --max-size=<MAX_SIZE>
    --number-of-devices=<NUMBER_OF_DEVICES>
    --vcpu-count=<VCPU_COUNT>
    --is-secondary-node
    --namespace=<NAMESPACE>
    --id-device-by-nqn
    --host-id=<HOST_ID>
    --lvol-priority-class=<LVOL_PRIORITY_CLASS>

Parameter	Description	Data Type	Required	Default
--storage-nodes	comma separated ip addresses	string	False	-
--test	Test Cluster	marker	False	-
--secondary-nodes	comma separated ip addresses	string	False	-
--ha-type	Logical volume HA type (single, ha), default is cluster HA type Available Options: - single - ha	string	False	ha
--data-chunks-per-stripe	Erasure coding schema parameter k (distributed raid), default: 1	integer	False	1
--parity-chunks-per-stripe	Erasure coding schema parameter n (distributed raid), default: 1	integer	False	1
--ifname	Management interface name, e.g. eth0	string	False	-
--cap-warn	Capacity warning level in percent, default: 89	integer	False	89
--cap-crit	Capacity critical level in percent, default: 99	integer	False	99
--prov-cap-warn	Capacity warning level in percent, default: 250	integer	False	250
--prov-cap-crit	Capacity critical level in percent, default: 500	integer	False	500
--log-del-interval	Logging retention period, default: 3d	string	False	3d
--metrics-retention-period	Retention period for I/O statistics (Prometheus), default: 7d	string	False	7d
--contact-point	Email or slack webhook url to be used for alerting	string	False
--chunk-size-in-bytes	(Dev) distrb bdev chunk block size, default: 4096	integer	False	4096
--enable-node-affinity	Enable node affinity for storage nodes	marker	False	-
--qpair-count	Increase for clusters with few but very large logical volumes or decrease for clusters with a large number of very small logical volumes. Available Value Range: 1..128	integer	False	3
--strict-node-anti-affinity	Enable strict node anti affinity for storage nodes. Never more than one chunk is placed on a node. This requires a minimum of data-chunks-in-stripe + parity-chunks-in-stripe + 1 nodes in the cluster."	marker	False	-
--journal-partition	1: auto-partition nvme devices for journal. 0: use a separate nvme device for journal. The smallest NVMe device available on the host will be chosen as a journal. It should provide about 3% of the entire node’s NVMe capacity. If set to false, partitions on other devices will be auto-created to store the journal.	string	False	True
--data-nics	Storage network interface name(s). Can be more than one. Comma-separated list: e.g. eth0,eth1	string	False	-
--max-lvol	Max logical volume per storage node	integer	False	-
--max-size	Maximum amount of GB to be provisioned via all storage nodes	string	False
--number-of-devices	Number of devices per storage node if it's not supported EC2 instance	integer	False	0
--vcpu-count	Number of vCPUs used for SPDK. Remaining CPUs will be used for Linux system, TCP/IP processing, and other workloads. The default on non-Kubernetes hosts is 80%.	integer	False	-
--is-secondary-node	Adds as secondary node. A secondary node does not have any disks attached. It is only used for I/O processing in case a primary goes down.	marker	False	False
--namespace	k8s namespace to deploy on	string	False	-
--id-device-by-nqn	Use device nqn to identify it instead of serial number	marker	False	False
--host-id	Primary storage node id or hostname	string	False	-
--lvol-priority-class	Logical volume priority class	integer	False	0

Creates a new cluster

Created a new control plane cluster with the current node as the primary control plane node.

sbcli-pre cluster create
    --cap-warn=<CAP_WARN>
    --cap-crit=<CAP_CRIT>
    --prov-cap-warn=<PROV_CAP_WARN>
    --prov-cap-crit=<PROV_CAP_CRIT>
    --ifname=<IFNAME>
    --log-del-interval=<LOG_DEL_INTERVAL>
    --metrics-retention-period=<METRICS_RETENTION_PERIOD>
    --contact-point=<CONTACT_POINT>
    --grafana-endpoint=<GRAFANA_ENDPOINT>
    --data-chunks-per-stripe=<DATA_CHUNKS_PER_STRIPE>
    --parity-chunks-per-stripe=<PARITY_CHUNKS_PER_STRIPE>
    --ha-type=<HA_TYPE>
    --enable-node-affinity
    --qpair-count=<QPAIR_COUNT>
    --strict-node-anti-affinity

Parameter	Description	Data Type	Required	Default
--cap-warn	Capacity warning level in percent, default: 89	integer	False	89
--cap-crit	Capacity critical level in percent, default: 99	integer	False	99
--prov-cap-warn	Capacity warning level in percent, default: 250	integer	False	250
--prov-cap-crit	Capacity critical level in percent, default: 500	integer	False	500
--ifname	Management interface name, e.g. eth0	string	False	-
--log-del-interval	Logging retention policy, default: 3d	string	False	3d
--metrics-retention-period	Retention period for I/O statistics (Prometheus), default: 7d	string	False	7d
--contact-point	Email or slack webhook url to be used for alerting	string	False
--grafana-endpoint	Endpoint url for Grafana	string	False
--data-chunks-per-stripe	Erasure coding schema parameter k (distributed raid), default: 1	integer	False	1
--parity-chunks-per-stripe	Erasure coding schema parameter n (distributed raid), default: 1	integer	False	1
--ha-type	Logical volume HA type (single, ha), default is cluster ha type Available Options: - single - ha	string	False	ha
--enable-node-affinity	Enable node affinity for storage nodes	marker	False	-
--qpair-count	Increase for clusters with few but very large logical volumes or decrease for clusters with a large number of very small logical volumes. Available Value Range: 0..128	integer	False	0
--strict-node-anti-affinity	Enable strict node anti affinity for storage nodes. Never more than one chunk is placed on a node. This requires a minimum of data-chunks-in-stripe + parity-chunks-in-stripe + 1 nodes in the cluster.	marker	False	-

Adds a new cluster

sbcli-pre cluster add
    --cap-warn=<CAP_WARN>
    --cap-crit=<CAP_CRIT>
    --prov-cap-warn=<PROV_CAP_WARN>
    --prov-cap-crit=<PROV_CAP_CRIT>
    --data-chunks-per-stripe=<DATA_CHUNKS_PER_STRIPE>
    --parity-chunks-per-stripe=<PARITY_CHUNKS_PER_STRIPE>
    --ha-type=<HA_TYPE>
    --enable-node-affinity
    --qpair-count=<QPAIR_COUNT>
    --strict-node-anti-affinity

Parameter	Description	Data Type	Required	Default
--cap-warn	Capacity warning level in percent, default: 89	integer	False	89
--cap-crit	Capacity critical level in percent, default: 99	integer	False	99
--prov-cap-warn	Capacity warning level in percent, default: 250	integer	False	250
--prov-cap-crit	Capacity critical level in percent, default: 500	integer	False	500
--data-chunks-per-stripe	Erasure coding schema parameter k (distributed raid), default: 1	integer	False	0
--parity-chunks-per-stripe	Erasure coding schema parameter n (distributed raid), default: 1	integer	False	0
--ha-type	Logical volume HA type (single, ha), default is cluster single type Available Options: - single - ha	string	False	ha
--enable-node-affinity	Enables node affinity for storage nodes	marker	False	-
--qpair-count	Increase for clusters with few but very large logical volumes or decrease for clusters with a large number of very small logical volumes. Available Value Range: 0..128	integer	False	0
--strict-node-anti-affinity	Enable strict node anti affinity for storage nodes. Never more than one chunk is placed on a node. This requires a minimum of data-chunks-in-stripe + parity-chunks-in-stripe + 1 nodes in the cluster."	marker	False	-

Activates a cluster.

Once a cluster has sufficient nodes added, it needs to be activated. Can also be used to re-activate a suspended cluster.

sbcli-pre cluster activate
    <CLUSTER_ID>
    --force
    --force-lvstore-create

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster id	string	True

Parameter	Description	Data Type	Required	Default
--force	Force recreate distr and lv stores	marker	False	-
--force-lvstore-create	Force recreate lv stores	marker	False	-

Shows the cluster list

sbcli-pre cluster list

Shows a cluster's status

sbcli-pre cluster status
    <CLUSTER_ID>

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster id	string	True

Shows a cluster's statistics

sbcli-pre cluster show
    <CLUSTER_ID>

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster id	string	True

Gets a cluster's information

sbcli-pre cluster get
    <CLUSTER_ID>

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster id	string	True

Gets a cluster's capacity

sbcli-pre cluster get-capacity
    <CLUSTER_ID>
    --json
    --history=<HISTORY>

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster id	string	True

Parameter	Description	Data Type	Required	Default
--json	Print json output	marker	False	-
--history	(XXdYYh), list history records (one for every 15 minutes) for XX days and YY hours (up to 10 days in total).	string	False	-

Gets a cluster's I/O statistics

sbcli-pre cluster get-io-stats
    <CLUSTER_ID>
    --records=<RECORDS>
    --history=<HISTORY>

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster id	string	True

Parameter	Description	Data Type	Required	Default
--records	Number of records, default: 20	integer	False	20
--history	(XXdYYh), list history records (one for every 15 minutes) for XX days and YY hours (up to 10 days in total).	string	False	-

Returns a cluster's status logs

sbcli-pre cluster get-logs
    <CLUSTER_ID>

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster id	string	True

Gets a cluster's secret

sbcli-pre cluster get-secret
    <CLUSTER_ID>

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster id	string	True

Updates a cluster's secret

sbcli-pre cluster update-secret
    <CLUSTER_ID>
    <SECRET>

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster id	string	True
SECRET	new 20 characters password	string	True

Checks a cluster's health

sbcli-pre cluster check
    <CLUSTER_ID>

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster id	string	True

Updates a cluster to new version

Updates a the control plane to a new version. To update the storage nodes, they have to be shutdown and restarted. This can be done in a rolling manner. Attention: verify that an upgrade path is available and has been tested!"

sbcli-pre cluster update
    <CLUSTER_ID>
    --cp-only=<CP_ONLY>
    --restart=<RESTART>

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster id	string	True

Parameter	Description	Data Type	Required	Default
--cp-only	Update the control plane only	boolean	False	False
--restart	Restart the management services	boolean	False	False

Lists tasks of a cluster

sbcli-pre cluster list-tasks
    <CLUSTER_ID>

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster id	string	True

Cancels task by task id

sbcli-pre cluster cancel-task
    <TASK_ID>

Argument	Description	Data Type	Required
TASK_ID	Task id	string	True

Deletes a cluster

This is only possible, if no storage nodes and pools are attached to the cluster

sbcli-pre cluster delete
    <CLUSTER_ID>

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster id	string	True