Add a cluster or a node to Scylla Manager¶

Prerequisites¶

For each node in the cluster, the same authentication token needs to be identified in /etc/scylla-manager-agent/scylla-manager-agent.yaml

Create a Managed Cluster¶

Procedure

1. From the Scylla Manager Server, provide the broadcast_address of one of the nodes and the generated auth_token (if used) and a custom name if desired.

   Where:

   • --host is hostname or IP of one of the cluster nodes. You can use an IPv6 or an IPv4 address.

   • --name is an alias you can give to your cluster. Using an alias means you do not need to use the ID of the cluster in all other operations.

   • --auth-token is the authentication token you identified in /etc/scylla-manager-agent/scylla-manager-agent.yaml

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

   • --username and --password - optionally, you can provide CQL credentials to the cluster. For security reasons, the user should NOT have access to your data. This enables CQL query-based health check compared to credentials agnostic health check if you do not specify the credentials. This also enables CQL schema backup, which isn’t performed if credentials aren’t provided.

   Example (IPv4):

   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
   

   Each cluster has a unique ID. You will use this ID in all commands where the cluster ID is required. Each cluster is automatically registered with a repair task that runs once a week. This can be canceled using --without-repair. To use a different repair schedule, see Schedule a Repair.

2. Verify that the cluster you added has a registered repair task by running the sctool task list -c <cluster-name> command, adding the name of the cluster you created in step 1 (with the --name flag).

   sctool task list -c prod-cluster
   ╭───────────────────────────────────────────────────────┬───────────┬────────────────────────────────┬────────╮
   │ Task                                                  │ Arguments │ Next run                       │ Status │
   ├───────────────────────────────────────────────────────┼───────────┼────────────────────────────────┼────────┤
   │ healthcheck/8988932e-de2f-4c42-a2f8-ae3b97fd7126      │           │ 02 Apr 20 12:28:10 CEST (+15s) │ NEW    │
   │ healthcheck_rest/9b7e694d-a1e3-42f1-8ca6-d3dfd9f0d94f │           │ 02 Apr 20 12:28:40 CEST (+1h)  │ NEW    │
   │ repair/0fd8a43b-eacf-4df8-9376-2a31b0dee6cc           │           │ 03 Apr 20 00:00:00 CEST (+7d)  │ NEW    │
   ╰───────────────────────────────────────────────────────┴───────────┴────────────────────────────────┴────────╯
   

   You will see 3 tasks which are created by adding the cluster:

   • Healthcheck - which checks the Scylla CQL, starting immediately, repeating every 15 seconds. See Scylla Health Check

   • Healthcheck REST - which checks the Scylla REST API, starting immediately, repeating every hour. See Scylla Health Check

   • Repair - an automated repair task, starting at midnight tonight, repeating every seven days at midnight. See Run a Repair

   Note

   If you want to change the schedule for the repair, see Reschedule a repair.

Remove a Node/Datacenter from Scylla Manager¶

There is no need to perform any action in Scylla Manager after removing a node or datacenter from a Scylla cluster.