ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu

Caution

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

Scylla Manager Scylla Manager

Scylla Manager¶

_images/header.png

Slack channel¶

If you have any troubles or questions regarding Scylla Manager contact us on Scylla Manager Slack channel.

Introduction¶

Scylla Manager automates database operations. With Scylla Manager you can schedule tasks such as backups and repairs, check cluster status, and more. Scylla Manager can manage multiple Scylla clusters and run cluster-wide tasks in a controlled and predictable way. It is available for Scylla Enterprise customers and Scylla Open Source users. With Scylla Open Source, Scylla Manager is limited to 5 nodes. See the Scylla Manager Proprietary Software License Agreement for details.

Scylla Manager consists of three components:

  • Server - a daemon that exposes a REST API

  • sctool - a command-line interface (CLI) for interacting with the Server

  • Agent - a daemon, installed on each Scylla node, the Server communicates with the Agent over HTTPS

The Server persists its data to a Scylla cluster which can run locally, or can run on an external cluster. Optionally, but recommended, you can add Scylla Monitoring Stack to enable reporting of Scylla Manager metrics and alerts. Scylla Manager comes with its own Scylla Monitoring Dashboard. The diagram below presents a view on Scylla Manager managing multiple Scylla Clusters. Scylla Manager Server has two connections with each Scylla node:

  • REST API connection - used to access Scylla API and Scylla Manager Agent

  • (Optional) CQL connection - used for the Scylla Health Check

_images/architecture.jpg

Installation¶

To proceed with installation go to Install Scylla Manager.

NEXT
Docker
  • 2.6
    • master
    • 3.0
    • 2.6
    • 2.5
    • 2.4
    • 2.3
    • 2.2
  • Docker
  • Install Scylla Manager
  • Install Scylla Manager Agent
  • Add a Cluster
  • Backup
    • Setup AWS S3
    • Setup S3 compatible storage
    • Setup Google Cloud Storage
    • Setup Azure Blob Storage
    • Examples
    • Specification
  • Restore
    • Download files command
  • Repair
    • Repair faster
    • Repair slower
    • Examples
  • Health Check
  • CLI sctool
    • Global flags and variables
    • Cluster
    • Backup
    • Repair
    • Status
    • Suspend & Resume
    • Task
    • Version
  • Configuration Files
    • Scylla Manager Config
    • Scylla Manager Agent Config
  • Swagger File
  • Scylla Monitoring
  • Troubleshooting
  • Older Versions
  • Slack
  • Create an issue
  • Edit this page

On this page

  • Scylla Manager
    • Slack channel
    • Introduction
    • Installation
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 15 February 2023.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.3.4