Scylla Manager Agent Installation¶
You are not reading the most recent version of this documentation. Go to the latest version of Scylla Manager Documentation.
Scylla Manager Agent is an executable, installed on each Scylla node. The Server communicates with the Agent over REST/HTTPS. The Agent communicates with the local Scylla node over the REST/HTTP.
Scylla cluster running on any OS supported by Scylla Manager 2.0
Traffic on port 10001 unblocked to Scylla nodes from the dedicated host
Scylla Manager only works with Scylla clusters that are using the Murmur3 partitioner (Scylla default partitioner). To check your cluster’s partitioner, run the cqlsh command
Download and install Scylla Manager Agent (from the Scylla Manager Download Page) according to the desired version:
There are three steps you need to complete:
Place the token parameters from Configure authentication token parameters in the Agent configuration file
Start Scylla Manager Agent service or restart if already running. Confirm the service starts / restarts and runs without errors
Generate an authentication token to be used to authenticate Scylla Manager with Scylla nodes. This procedure is done once for each cluster. It is recommended to use a different token for each cluster.
Use the same token on all nodes in the same cluster.
From one node only Run the token generator script.
$ scyllamgr_auth_token_gen 6Es3dm24U72NzAu9ANWmU3C4ALyVZhwwPZZPWtK10eYGHJ24wMoh9SQxRZEluWMc0qDrsWCCshvfhk9uewOimQS2x5yNTYUEoIkO1VpSmTFu5fsFyoDgEkmNrCJpXtfM
If you want to change the token, you will need to repeat this procedure and place the new token on all nodes. This procedure sets up the Scylla agent on each node. Repeat the procedure for every Scylla node in the cluster that you want to be managed under Scylla Manager.
Run the setup script to setup environment for the agent:
Script requires sudo rights
$ sudo scyllamgr_agent_setup Do you want to create scylla-helper.slice if it does not exist? Yes - limit Scylla Manager Agent and other helper programs memory. No - skip this step. [YES/no] YES Do you want the Scylla Manager Agent service to automatically start when the node boots? Yes - automatically start Scylla Manager Agent when the node boots. No - skip this step. [YES/no] YES
The first step relates to limited resources that are available to the agent, and second instructs systemd to run agent on node restart.
$ cat /etc/scylla-manager-agent/scylla-manager-agent.yaml # Scylla Manager Agent config YAML # Specify authentication token, the auth_token needs to be the same for all the # nodes in a cluster. Use scyllamgr_auth_token_gen to generate the auth_token # value. auth_token: 6Es3dm24U72NzAu9ANWmU3C4ALyVZhwwPZZPWtK10eYGHJ24wMoh9SQxRZEluWMc0qDrsWCCshvfhk9uewOimQS2x5yNTYUEoIkO1VpSmTFu5fsFyoDgEkmNrCJpXtfM
Start Scylla Manager Agent service
$ sudo systemctl start scylla-manager-agent
Validate Scylla Manager Agent is running
$ sudo systemctl status scylla-manager-agent ● scylla-manager-agent.service - Scylla Manager Agent Loaded: loaded (/usr/lib/systemd/system/scylla-manager-agent.service; disabled; vendor preset: disabled) Active: active (running) since Wed 2019-10-30 10:46:51 UTC; 7s ago Main PID: 14670 (scylla-manager-) CGroup: /system.slice/scylla-manager-agent.service └─14670 /usr/bin/scylla-manager-agent
Enable the Scylla Manager Agent to run when the node starts.
$ sudo systemctl enable scylla-manager-agent
Repeat the procedure for every Scylla node in the cluster that you want to be managed under Scylla Manager, starting with Configure authentication token parameters.
Adding the cluster to Scylla Manager automatically creates a backup task. Validate the connection to your backup location is accessible from Scylla Manager before adding the cluster to avoid errors.
Create a storage location for the backup. Currently, Scylla Manager 2.1 supports S3 buckets created on AWS. You can use an S3 bucket that you already created.
Choose how you want to configure access to the S3 Bucket. You can use an IAM role (recommended), or you can add your AWS credentials to the agent configuration file. This method is less secure as you will be propagating each node with this security information, and in cases where you need to change the key, you will have to replace it on each node.
To use an IAM Role:
To add your AWS credentials the Scylla Manager Agent configuration file:
S3section your authentication information about the S3 bucket. Refer to AWS Credentials Configuration for details.
Validate that the manager has access to the backup location. If there is no response, the S3 bucket is accessible. If not, you will see an error.
$ scylla-manager-agent check-location --location s3:<your S3 bucket name>
Continue with Add a Cluster.