Scylla University Live | July 28 & 29 Free Virtual Training Event
Learn More >

Scylla Manager Agent Installation

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.

Install Scylla Manager Agent

Prerequisites

Note

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 DESCRIBE CLUSTER.

Download packages

Procedure

Download and install Scylla Manager Agent (from the Scylla Manager Download Page) according to the desired version:

Configure Scylla Manager Agent

There are three steps you need to complete:

  • Generate a token

  • Place token parameters in the Agent configuration file

  • Start or Restart Scylla Manager Agent service and confirm all is running without errors

Generate an authentication token

Procedure

  1. 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.

    Note

    Use the same token on all nodes in the same cluster.

    From one node only Run the token generator script.

    For example:

    $ 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 scyllamgr_agent_setup script

Procedure

  1. Run the setup script to set up the environment for the agent:

    Note

    This script is added in version 2.0.2, so it won’t be available for earlier versions.

    Note

    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 limiting resources that are available to the agent, and second instructs systemd to run agent on node restart.

Configure authentication token parameters

Procedure

  1. Take the authentication token you generated, and place it into /etc/scylla-manager-agent/scylla-manager-agent.yaml as part of the auth_token section.

    For Example:

    $ 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

Procedure

  1. Start Scylla Manager Agent service

    $ sudo systemctl start scylla-manager-agent

  2. 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

Oct 30 10:46:51 ip-172-31-0-11.ec2.internal systemd[1]: Started Scylla Manager Agent.
Oct 30 10:46:52 ip-172-31-0-11.ec2.internal scylla-manager-agent[14670]: {"L":"INFO","T":"2019-10-30T10:46:52.027Z","M":"Scylla Manager    Agent","version":"2.0-0.20191030.9442dd9b","_trace_id":"FaheEpqXS2CTIy2lA1fkBg"}
Oct 30 10:46:52 ip-172-31-0-11.ec2.internal scylla-manager-agent[14670]: {"L":"INFO","T":"2019-10-30T10:46:52.027Z","M":"Using config","config":   {"AuthToken":"***************************************************************...er/scylla_mana
Oct 30 10:46:52 ip-172-31-0-11.ec2.internal scylla-manager-agent[14670]: {"L":"INFO","T":"2019-10-30T10:46:52.027Z","M":"Looking for a free CPU to run on","_trace_id":"FaheEpqXS2CTIy2lA1fkBg"}
Oct 30 10:46:52 ip-172-31-0-11.ec2.internal scylla-manager-agent[14670]: {"L":"INFO","T":"2019-10-30T10:46:52.028Z","M":"Could not get a free CPU","error":"Scylla cpuset parse error run    scylla_cpuset_setup or set cpu fiel...CTIy2lA1fkBg"}
Oct 30 10:46:52 ip-172-31-0-11.ec2.internal scylla-manager-agent[14670]: {"L":"INFO","T":"2019-10-30T10:46:52.028Z","N":"rclone","M":"registered s3 provider"}
Oct 30 10:46:52 ip-172-31-0-11.ec2.internal scylla-manager-agent[14670]: {"L":"INFO","T":"2019-10-30T10:46:52.028Z","N":"rclone","M":"registered localdir provider data rooted at /var/lib/scylla/data"}
Oct 30 10:46:52 ip-172-31-0-11.ec2.internal scylla-manager-agent[14670]: {"L":"INFO","T":"2019-10-30T10:46:52.028Z","M":"Starting HTTPS    server","address":"172.31.0.11:10001","_trace_id":"FaheEpqXS2CTIy2lA1fkBg"}
Hint: Some lines were ellipsized, use -l to show in full.

  3. Enable the Scylla Manager Agent to run when the node starts.

    $ sudo systemctl enable scylla-manager-agent

  4. 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.

Prepare nodes for backup

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.

Procedure

  1. Create a storage location for the backup. Currently, Scylla Manager 2.0 supports S3 buckets created on AWS. You can use an S3 bucket that you already created.

  2. 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:

      1. Create an IAM role for the S3 bucket which adheres to your company security policy. You can use the role you already created.

      2. Attach the IAM role to each EC2 instance (node) in the cluster.

    • To add your AWS credentials the Scylla Manager Agent configuration file:

      1. Edit the /etc/scylla-manager-agent/scylla-manager-agent.yaml in the S3 section your authentication information about the S3 bucket. Refer to AWS Credentials Configuration for details.

  3. 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>

Register a cluster

Continue with Add a Cluster.