Run in Docker¶

Running with docker-compose¶

Docker compose is a tool for defining and running multi-container applications.

Procedure

1. Copy the following snippet and save it to your current working directory as docker-compose.yaml.

version: '3'

services:
  scylla-manager:
    image: scylladb/scylla-manager
    container_name: scylla-manager
    depends_on:
      - scylla-manager-db

  scylla-manager-db:
    image: scylladb/scylla
    container_name: scylla-manager-db

This file instructs Docker to create two containers, scylla-manager that runs the Scylla Manager Server, and scylla-manager-db that Scylla Manager uses to save its data.

2. Create and start the containers by running the docker-compose command.

docker-compose up -d

3. Verify that Scylla Manager started by using the docker-compose logs command.

docker-compose logs -f scylla-manager

4. Continue to using sctool.

Running with Docker¶

Procedure

1. Start a Scylla container to use as the datastore for Scylla Manager data.

docker run -d --name scylla-manager-db scylladb/scylla

More on Best Practices for Running Scylla on Docker

2. Start Scylla Manager container and link with the scylla-manager-db container.

docker run -d --name scylla-manager --link scylla-manager-db scylladb/scylla-manager

Scylla Manager expects a Scylla node available as scylla-manager-db.

3. Verify that Scylla Manager stared by using docker logs command.

docker logs -f scylla-manager

Using sctool¶

Sctool is the Scylla Manager commandline tool. To learn more about it, see sctool reference.

Use docker exec to invoke sctool in a running container.

docker exec -it scylla-manager sctool version

You can also use exec bash and run sctool from within a bash session in the container. This would give you the benefit of bash completion for sctool.

docker exec -it scylla-manager bash
[root@49910e75d06f /]# sctool
cluster  repair   status   task     version
[root@49910e75d06f /]# sctool version

Using a remote database¶

If you with to persist Scylla Manager data on a remote cluster you need to adjust the configuration options. The configuration file document covers all the Scylla Manager configuration options.

Procedure

1. Open editor and create an empty yaml file.

2. Copy the database and ssl sections from the configuration file document.

3. Follow the procedure in edit scylla manager configuration and adjust the configuration file.

4. Optionally, you can remove any comments or not changed lines leaving only relevant changes.

5. Save the file as scylla-manager-user.yaml in an appropriate location.

6. Start scylla-manager container with file scylla-manager-user.yaml you created earlier mounted as a volume. Pass it as an additional Docker command (docker run) parameter.

docker run -d --name scylla-manager --link scylla-manager-db scylladb/scylla-manager -c /etc/scylla-manager/scylla-manager-user.yaml

Exposed ports¶

Scylla Manager exposes the following ports, which are used for integrating Scylla Manager with other services such as Scylla Monitoring.

Exposed volumes¶

It is often useful to attach host files and directories to the Scylla Manager container. The following volumes are exposed from Scylla Manager.

Example for mapping Scylla Manager a volume in docker run command:

docker run -d --name scylla-manager -v certs:/var/lib/scylla-manager/.certs:Z \
-v scylla-manager-user.yaml:/etc/scylla-manager/scylla-manager-user.yaml \
--link scylla-manager-db scylladb/scylla-manager -c /etc/scylla-manager/scylla-manager-user.yaml