Cluster

The cluster commands allow you to add, delete, list, and update clusters. A Scylla cluster must be added (cluster add) before management tasks can be initiated.

sctool cluster <command> [flags] [global flags]

Subcommands

Subcommand

Usage

cluster add

Add a cluster to manager.

cluster delete

Delete a cluster from manager.

cluster list

Show managed clusters.

cluster update

Modify a cluster.

cluster add

This command adds the specified cluster to the manager. Once a Scylla cluster is added, a weekly repair task is also added.

Before continuing make sure the cluster that you want to add is prepared for it, see Add a cluster to Scylla Manager for instructions.

Syntax:

sctool cluster add --host <node IP> --auth-token <token>[--name <alias>][--without-repair][global flags]

cluster add parameters

In addition to the Global flags, cluster add takes the following parameters:


--host <node IP>

Specifies the hostname or IP of the node that will be used to discover other nodes belonging to the cluster. Note that this will be persisted and used every time Scylla Manager starts. You can use either an IPv4 or IPv6 address.


-n, --name <alias>

When a cluster is added, it is assigned a unique identifier. Use this parameter to identify the cluster by an alias name which is more meaningful. This alias name can be used with all commands that accept -c, --cluster parameter.


--auth-token <token>

Specifies the authentication token you identified in /etc/scylla-manager-agent/scylla-manager-agent.yaml


-u, --username <cql username>

Optional CQL username, for security reasons this user should NOT have access to your data. If you specify the CQL username and password, the CQL health check you see in status would try to login and execute a query against system keyspace. Otherwise CQL health check is based on sending CQL OPTIONS frame and does not start a CQL session.


-p, --password <password>

CQL password associated with username.


--without-repair

When cluster is added, Manager schedules repair to repeat every 7 days. To create a cluster without a scheduled repair, use this flag.


Example: cluster add

This example is only the command that you use to add the cluster to Scylla Manager, not the entire procedure for adding a cluster. The procedure is detailed in Add a cluster to Scylla Manager.

sctool cluster add --host 34.203.122.52 --auth-token "6Es3dm24U72NzAu9ANWmU3C4ALyVZhwwPZZPWtK10eYGHJ24wMoh9SQxRZEluWMc0qDrsWCCshvfhk9uewOimQS2x5yNTYUEoIkO1VpSmTFu5fsFyoDgEkmNrCJpXtfM" --name prod-cluster
c1bbabf3-cad1-4a59-ab8f-84e2a73b623f
 __
/  \     Cluster added! You can set it as default, by exporting env variable.
@  @     $ export SCYLLA_MANAGER_CLUSTER=c1bbabf3-cad1-4a59-ab8f-84e2a73b623f
|  |     $ export SCYLLA_MANAGER_CLUSTER=prod-cluster
|| |/
|| ||    Now run:
|\_/|    $ sctool status -c prod-cluster
\___/    $ sctool task list -c prod-cluster

Example (IPv6):

sctool cluster add --host 2a05:d018:223:f00:971d:14af:6418:fe2d --auth-token       "6Es3dm24U72NzAu9ANWmU3C4ALyVZhwwPZZPWtK10eYGHJ24wMoh9SQxRZEluWMc0qDrsWCCshvfhk9uewOimQS2x5yNTYUEoIkO1VpSmTFu5fsFyoDgEkmNrCJpXtfM" --name prod-cluster

cluster delete

This command deletes the specified cluster from the manager. Note that there is no confirmation or warning to confirm. If you deleted the cluster by mistake, you will need to add it again.

Syntax:

sctool cluster delete --cluster <id|name> [global flags]

Note

If you are removing the cluster from Scylla Manager and you are using Scylla Monitoring, remove the target from Prometheus Target list </operating-scylla/monitoring/monitoring_stack/#procedure>`_ in the prometheus/scylla_manager_servers.yml file.

cluster delete parameters

In addition to Global flags, cluster delete takes the following parameter:


-c , --cluster

The cluster name. This is the name you assigned to the cluster when you created it with cluster add. You can see the cluster name and ID by running the command ref:cluster-list.


Example: cluster delete

sctool cluster delete -c prod-cluster

cluster list

Lists the managed clusters.

Syntax:

sctool cluster list [global flags]

cluster list parameters

cluster list takes the Global flags.

Example: cluster list

sctool cluster list
╭──────────────────────────────────────┬──────────────╮
│ ID                                   │ Name         │
├──────────────────────────────────────┼──────────────┤
│ db7faf98-7cc4-4a08-b707-2bc59d65551e │ prod-cluster │
╰──────────────────────────────────────┴──────────────╯

cluster update

This command modifies managed cluster parameters.

Syntax:

sctool cluster update --cluster <id|name> [--host <node IP>] [--auth-token <token>] [--name <alias>] [--without-repair] [global flags]

cluster update parameters

In addition to the Global flags, cluster update takes all the cluster add parameters.


-c , --cluster

The cluster name. This is the name you assigned to the cluster when you created it with cluster add. You can see the cluster name and ID by running the command ref:cluster-list.


--host <node IP>

Specifies the hostname or IP of the node that will be used to discover other nodes belonging to the cluster. Note that this will be persisted and used every time Scylla Manager starts. You can use either an IPv4 or IPv6 address.


-n, --name <alias>

When a cluster is added, it is assigned a unique identifier. Use this parameter to identify the cluster by an alias name which is more meaningful. This alias name can be used with all commands that accept -c, --cluster parameter.


--auth-token <token>

Specifies the authentication token you identified in /etc/scylla-manager-agent/scylla-manager-agent.yaml


-u, --username <cql username>

Optional CQL username, for security reasons this user should NOT have access to your data. If you specify the CQL username and password, the CQL health check you see in status would try to login and execute a query against system keyspace. Otherwise CQL health check is based on sending CQL OPTIONS frame and does not start a CQL session.


-p, --password <password>

CQL password associated with username.


--without-repair

When cluster is added, Manager schedules repair to repeat every 7 days. To create a cluster without a scheduled repair, use this flag.


Example: cluster update

In this example, the cluster named cluster has been renamed to prod-cluster.

sctool cluster update --prod-cluster cluster --name prod-cluster