ScyllaDB Docs Scylla Manager Install ScyllaDB Manager

Caution

You're viewing documentation for an unstable version of Scylla Manager. Switch to the latest stable version.

Install ScyllaDB Manager¶

Note

If you need to upgrade ScyllaDB Manager from a previous version please see the Upgrade guide.

System requirements ¶

While a minimal server can run on a system with 2 cores and 1GB RAM, the following configuration is recommended:

CPU - 2vCPUs
Memory - 8GB+ DRAM

Note

If you are running ScyllaDB Monitoring Stack on the same server as ScyllaDB Manager, your system should also meet the minimal Monitoring requirements.

Install package ¶

Best practice is to install ScyllaDB Manager Server on a dedicated machine, not on a ScyllaDB production node.

Import the ScyllaDB GPG signing key.

sudo mkdir -p /etc/apt/keyrings
sudo gpg --homedir /tmp --no-default-keyring --keyring /etc/apt/keyrings/scylladb.gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys a43e06657bac99e3

Add the ScyllaDB Manager APT repository to your system.

sudo curl -o /etc/apt/sources.list.d/scylla-manager.list -L https://downloads.scylladb.com/deb/debian/scylladb-manager-3.8.list

Install ScyllaDB Manager packages.

sudo apt update
sudo apt install -y scylla-manager-server
sudo apt install -y scylla-manager-client

Add the ScyllaDB Manager RPM repository to your system.

sudo curl -o /etc/yum.repos.d/scylla-manager.repo -L https://downloads.scylladb.com/rpm/centos/scylladb-manager-3.8.repo

Install ScyllaDB Manager packages.

sudo yum install scylla-manager-server
sudo yum install scylla-manager-client

Configure storage ¶

ScyllaDB Manager uses ScyllaDB to store its data. You can either use a local one-node ScyllaDB cluster (recommended) or connect ScyllaDB Manager to a remote cluster.

On the same node as you are installing ScyllaDB Manager, download and install ScyllaDB Server package. There is no need to run the ScyllaDB setup, it is taken care of later, by the scyllamgr_setup script. When it’s installed you can jump to Run the scyllamgr_setup script section.

Remote cluster ¶

ScyllaDB Manager configuration file /etc/scylla-manager/scylla-manager.yaml contains a database configuration section.

# ScyllaDB Manager database, used to store management data.
database:
  hosts:
    - 127.0.0.1
# Override default 9042 CQL port
#  port: 5555
#
# Enable or disable client/server encryption.
#  ssl: false
#
# Database credentials.
#  user: user
#  password: password
#
# Local datacenter name, specify if using a remote, multi-dc cluster.
#  local_dc:
#
# Database connection timeout.
#  timeout: 600ms
#
# Keyspace for management data, for create statement see /etc/scylla-manager/create_keyspace.cql.tpl.
#  keyspace: scylla_manager

Using an editor open the file and change relevant parameters.

Procedure

Edit the hosts parameter, change the IP address to the IP address or addressees of the remote cluster.
If authentication is needed, uncomment and edit the user and password parameters.
If it’s a single DC cluster, ScyllaDB Manager keyspace using NetworkTopologyStrategy would be created. Refer to ScyllaDB Architecture - Fault Tolerance for more information on replication. It would have replication factor equal to the amount of racks in each data center. In case where this setup could lead to reduced availability (total replication factor smaller than 3), replication factor will be increased up to 3 (depending on node count) regardless of the rack count.
If it’s a multi DC cluster, create a keyspace named scylla_manager yourself. You can use a different keyspace name, just remember to adjust the keyspace parameter value. Set local_dc parameter to DC the closest to ScyllaDB Manager Server.
If client/server encryption is enabled, uncomment and set the ssl parameter to true. Additional SSL configuration options can be set in the ssl configuration section.

# Optional custom client/server encryption options.
#ssl:
# CA certificate used to validate server cert. If not set will use he host's root CA set.
#  cert_file:
#
# Verify the hostname and server cert.
#  validate: true
#
# Client certificate and key in PEM format. It has to be provided when
# client_encryption_options.require_client_auth=true is set on server.
#  user_cert_file:
#  user_key_file

Sample configuration of ScyllaDB Manager working with a remote cluster with authentication and replication factor 3 could look like this.

database:
  hosts:
    - 198.100.51.11
    - 198.100.51.12
  user: user
  password: password

Run the scyllamgr_setup script ¶

The ScyllaDB Manager setup script automates configuration of ScyllaDB Manager by asking you some questions. It can be run in non-interactive mode by using flags.

scyllamgr_setup -h
Usage: scyllamgr_setup [-y][--no-scylla-setup][--no-enable-service][--no-check-for-updates]

Options:
  -y, --assume-yes          assume that the answer to any question which would be asked is yes
  --no-scylla-setup         skip setting up and enabling local Scylla instance as a storage backend for ScyllaDB Manager
  --no-enable-service       skip enabling service
  --no-check-for-updates    skip enabling periodic check for updates
  -h, --help                print this help

Interactive mode is enabled when no flags are provided.

Run the scyllamgr_setup script to configure the service.

Enable bash script completion ¶

Enable bash completion for sctool (the ScyllaDB Manager CLI) in the current bash session. Alternatively, you can just open a new terminal.

source /etc/bash_completion.d/sctool.bash

Start ScyllaDB Manager service ¶

ScyllaDB Manager integrates with systemd and can be started and stopped using systemctl command.

Procedure

Start the ScyllaDB Manager server service.

sudo systemctl start scylla-manager.service

Verify the ScyllaDB Manager server service is running.

sudo systemctl status scylla-manager.service -l
● scylla-manager.service - ScyllaDB Manager Server
   Loaded: loaded (/usr/lib/systemd/system/scylla-manager.service; enabled; vendor preset: disabled)
   Active: active (running) since Wed 2019-10-30 11:00:01 UTC; 20s ago
 Main PID: 5805 (scylla-manager)
   CGroup: /system.slice/scylla-manager.service
           └─5805 /usr/bin/scylla-manager

Note

The first time you start ScyllaDB Manager it may take a while. It creates a database schema. Follow the logs to see the progress.

Confirm sctool is running by displaying the sctool version.

sctool version
Client version: 2.1-0.20200401.ce91f2ad
Server version: 2.1-0.20200401.ce91f2ad

Next steps ¶

Install ScyllaDB Manager Agent

Was this page helpful?