Scylla Documentation Logo Documentation
  • Server
    • Scylla Open Source
    • Scylla Enterprise
    • Scylla Alternator
  • Cloud
    • Scylla Cloud
    • Scylla Cloud Docs
  • Tools
    • Scylla Manager
    • Scylla Monitoring Stack
    • Scylla Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu
Scylla Scylla for Administrators Procedures Scylla Best Practices Production Readiness Guidelines

Production Readiness Guidelines¶

The goal of this document is to have a checklist that production customers can use to make sure their deployment adheres to ScyllaDB’s recommendations. Before deploying to production you should follow up on each of the main bullets described below to verify they comply with the recommendations provided. Click the links for more information on each topic.

Before You Begin¶

Pre-Deployment Requirements¶

  • Scylla System Requirements - verify your instances, system, OS, etc are supported by Scylla for production machines.

  • Scylla Getting Started

Choose a Compaction Strategy¶

Each workload may require a specific strategy. Refer to Choose a Compaction Strategy for details. If you are using Scylla Enterprise, in all cases ICS is preferred over STCS.

Incremental Compaction Strategy (ICS)¶

If you are using Scylla Enterprise, we highly recommend using ICS (the default setting) for any table that you have, or considering to have STCS as a compaction strategy. You will have much less Space Amplification with ICS as it only requires 25% additional storage, as opposed to STCS which requires 50% more.

Note

ICS is the default compaction strategy setting for Scylla Enterprise versions 2020.1 and higher.

  • Refer to Incremental Compaction Strategy for an overview of the benefits.

  • Refer to Incremental Compaction Strategy Overview for a description of how it works.

Resiliency¶

When rolling out to production it is important to make sure your data is recoverable and your database can function anytime there is a power or equipment failure.

Replication Factors¶

Verify the Replication Factor is set properly for each keyspace.

We recommend using an RF of at least three.

If you have a multi-datacenter architecture we recommend to have RF=3 on each DC.

For additional information:

  • Read more about Scylla Fault Tolerance

  • Take a course at Scylla University on RF.

Consistency Levels¶

Verify the Consistency Level (CL) is set properly for each table.

We recommend using LOCAL_QUORUM across the cluster and DCs

For additional information:

  • Refer to Scylla Fault Tolerance

  • Watch a Demo

  • Take a course at Scylla University on CL

Gossip Configuration¶

  1. Choose the correct Snitch.

    Always use GossipingPropertyFileSnitch or Ec2MultiRegionSnitch Do Not use SimpleStrategy on any production machine, even if you only have a single DC.

    For additional information:

    • Refer to Gossip in Scylla

    • Follow the How to Switch Snitches procedure if required.

    • Take a course at Scylla University on Gossip

  2. Use the correct Data Replication strategy.

    Use NetworkTopologyStrategy replication-strategy as it supports multi-DC for your keyspaces.

Seed Node Redundancy¶

Scylla Open Source 4.3 and later and Scylla Enterprise 2021.1 and later are seedless. See Seedless NoSQL: Getting Rid of Seed Nodes in ScyllaDB.

If you are using an earlier Scylla version:

  • Each DC needs to have multiple seed nodes.

  • We recommend having 2-3 seed nodes per DC.

See Scylla Seed Nodes for details.

Performance¶

Verify you have run scylla_setup in order to tune ScyllaDB to your hardware.

If you are running on a physical hardware please take a look into the following configuration files:

  • perftune.yaml

  • cpuset.conf

perftune.yaml¶

If you have more than 8 cores or 16 vcpu always use mode: sq_split

cpuset.conf¶

Make sure that the configuration in /etc/scylla.d/cpuset.conf corresponds to sq_split and that the hyperthreads of physical core 0 are excluded from the CPU list.

Compression¶

Inter-node Compression¶

Enable Inter-node Compression by editing the Scylla Configuration file (/etc/scylla.yaml).

internode_compression: all

For additional information, see the Admin Guide Inter-node Compression section.

Driver Compression¶

This refers to compressing traffic between the client and Scylla. Verify your client driver is using compressed traffic when connected to Scylla. As compression is driver settings dependent, please check your client driver manual or Scylla Drivers.

Connectivity¶

Drivers Settings¶

  • Use shard aware drivers wherever possible. Scylla Drivers (not third-party drivers) are shard aware.

  • Configure connection pool - open more connections (>3 per shard) and/Or more clients. See this blog.

Management¶

You must use both Scylla Manager and Scylla Monitor.

Scylla Manager¶

Scylla Manager enables centralized cluster administration and database automation such as repair, backup, and health-check.

Repair¶

Run repairs preferably once a week and run them exclusively from Scylla Manager. Refer to Repair a Cluster

Backup and Restore¶

We recommend the following:

  • Run a full weekly backup from Scylla Manager

  • Run a daily backup from Scylla Manager

  • Check the bucket used for restore. This can be done by performing a restore and making sure the data is valid. This action should be done once a month, or more frequently if needed. Ask our Support team to help you with this.

  • Save backup to a bucket supported by Scylla Manager.

For additional information:

  • Backup

  • Restore a Backup

Scylla Monitor¶

Scylla Monitoring helps you monitor everything about your Scylla cluster. Scylla Support usually asks for your monitoring metrics when you open a ticket.

For information see:

  • Scylla Monitor

Configuration Management¶

Caution

All configuration settings for all nodes in the same cluster should be identical or coherent.

Using tools such as Ansible, Chef, Puppet, Salt, or Juju are recommended.

See this article for more information.

Security¶

Use the following guidelines to keep your data and database secure.

  • Enable Authentication

  • Create Roles for all users and use RBAC with or without LDAP (coming soon).

  • Use Encryption in Transit between nodes and client to node.

  • Refer to the Security Checklist for more information.

HA Testing¶

HA testing in single DC - for example:

  1. Shutdown one node from the cluster (Or scylla service if on the cloud) for 30 min.

  2. Turn it back on.

HA testing in multi DC - for example:

  1. Disconnect one DC from the other by stopping scylla service on all of these DC nodes.

  2. Reconnect the DC.

Additional Topics¶

  • Add a Node

  • Repair

  • Cleanup

  • Tech Talk: How to be successful with Scylla

PREVIOUS
Best Practices for Running Scylla on Docker
NEXT
How to Avoid Node Mismanagement
  • Getting Started
    • Install Scylla
      • Scylla Unified Installer (relocatable executable)
      • Air-gapped Server Installation
      • What is in each RPM
      • Scylla Housekeeping and how to disable it
      • Scylla Developer Mode
      • Scylla Configuration Reference
    • Configure Scylla
    • Scylla Requirements
      • System Requirements
      • OS Support by Platform and Version
      • Scylla in a Shared Environment
    • Cassandra Query Language (CQL)
      • CQLSh the CQL shell
      • Data Definition
      • Data Manipulation
      • Expiring Data with Time to Live (TTL)
      • Additional Information
      • Security
      • Data Types
      • Appendices
      • Definitions
      • Materialized Views
      • Functions
      • JSON
      • Global Secondary Indexes
      • Additional Information
      • Compaction
      • Consistency Levels
      • Reserved Keywords
      • Non-reserved Keywords
    • CQLSh: the CQL shell
    • Scylla Drivers
      • Scylla CQL Drivers
      • Scylla DynamoDB Drivers
    • Migrate to Scylla
      • Migration Process from Cassandra to Scylla
      • Scylla and Apache Cassandra Compatibility
      • Migration Tools Overview
    • Integration Solutions
      • Integrate Scylla with Spark
      • Integrate Scylla with KairosDB
      • Integrate Scylla with Presto
      • Integrate Scylla with Elasticsearch
      • Integrate Scylla with Kubernetes
      • Integrate Scylla with the JanusGraph Graph Data System
      • Integrate Scylla with DataDog
      • Integrate Scylla with Kafka
      • Integrate Scylla with IOTA Chronicle
      • Integrate Scylla with Spring
      • Shard-Aware Kafka Connector for Scylla
      • Install Scylla with Ansible
      • Integrate Scylla with Databricks
    • Tutorials
  • Scylla for Administrators
    • Administration Guide
    • Procedures
      • Cluster Management
      • Backup & Restore
      • Change Configuration
      • Maintenance
      • Best Practices
      • Benchmarking Scylla
      • Migrate from Cassandra to Scylla
      • Disable Housekeeping
    • Security
      • Scylla Security Checklist
      • Enable Authentication
      • Enable and Disable Authentication Without Downtime
      • Generate a cqlshrc File
      • Reset Authenticator Password
      • Enable Authorization
      • Grant Authorization CQL Reference
      • Role Based Access Control (RBAC)
      • Scylla Auditing Guide
      • Encryption: Data in Transit Client to Node
      • Encryption: Data in Transit Node to Node
      • Generating a self-signed Certificate Chain Using openssl
      • Encryption at Rest
      • LDAP Authentication
      • LDAP Authorization (Role Management)
    • Admin Tools
      • Nodetool Reference
      • CQLSh
      • REST
      • Tracing
      • scylla-sstable
      • scylla-types
      • SSTableLoader
      • cassandra-stress
      • SSTabledump
      • SSTable2json
      • SSTable Index
      • Scylla Logs
      • Seastar Perftune
    • Scylla Manager
      • Scylla Manager Docs
      • Upgrade Scylla Manager
      • Monitoring Support Matrix
    • Scylla Monitoring Stack
      • Latest Version
      • Upgrade Scylla Monitoring Stack
      • Monitoring Support Matrix
    • Scylla Operator
    • Upgrade Procedures
      • Scylla Enterprise
      • Scylla Open Source
      • Scylla Open Source to Scylla Enterprise
      • Scylla Manager
      • Scylla Monitoring
      • Scylla AMI
    • System Configuration
      • System Configuration Guide
      • scylla.yaml
      • Scylla Snitches
    • Benchmarking Scylla
  • Scylla for Developers
    • Learn To Use Scylla
      • Scylla University
      • Course catalog
      • Scylla Essentials
      • Basic Data Modeling
      • Advanced Data Modeling
      • MMS - Learn by Example
      • Care-Pet an IoT Use Case and Example
    • CQLSh
    • Apache Cassandra Query Language (CQL)
    • Scylla Alternator
    • Scylla Features
      • Scylla Open Source Features
      • Scylla Enterprise Features
    • Scylla Drivers
      • Scylla CQL Drivers
      • Scylla DynamoDB Drivers
  • Scylla Architecture
    • Scylla Ring Architecture
    • Scylla Fault Tolerance
    • Consistency Level Console Demo
    • Scylla Anti-Entropy
      • Scylla Hinted Handoff
      • Scylla Read Repair
      • Scylla Repair
    • SSTable
      • Scylla SSTable - 2.x
      • Scylla SSTable - 3.x
    • Compaction Strategies
    • Raft Consensus Algorithm in ScyllaDB
  • Troubleshooting Scylla
    • Errors and Support
      • Report a Scylla problem
      • Error Messages
      • Change Log Level
    • Scylla Startup
      • Ownership Problems
      • Scylla will not Start
      • Scylla Python Script broken
    • Cluster and Node
      • Failed Decommission Problem
      • Cluster Timeouts
      • Node Joined With No Data
      • SocketTimeoutException
      • NullPointerException
    • Data Modeling
      • Scylla Large Partitions Table
      • Scylla Large Rows and Cells Table
      • Large Partitions Hunting
    • Data Storage and SSTables
      • Space Utilization Increasing
      • Disk Space is not Reclaimed
      • SSTable Corruption Problem
      • Pointless Compactions
      • Limiting Compaction
    • CQL
      • Time Range Query Fails
      • COPY FROM Fails
      • CQL Connection Table
      • Reverse queries fail
    • Scylla Monitor and Manager
      • Manager and Monitoring integration
      • Manager lists healthy nodes as down
  • Knowledge Base
    • Upgrading from experimental CDC
    • Compaction
    • Counting all rows in a table is slow
    • CQL Query Does Not Display Entire Result Set
    • When CQLSh query returns partial results with followed by “More”
    • Run Scylla and supporting services as a custom user:group
    • Decoding Stack Traces
    • Snapshots and Disk Utilization
    • DPDK mode
    • Debug your database with Flame Graphs
    • How to Change gc_grace_seconds for a Table
    • Gossip in Scylla
    • Increase Permission Cache to Avoid Non-paged Queries
    • How does Scylla LWT Differ from Apache Cassandra ?
    • Map CPUs to Scylla Shards
    • Scylla Memory Usage
    • NTP Configuration for Scylla
    • POSIX networking for Scylla
    • Scylla consistency quiz for administrators
    • Recreate RAID devices
    • How to Safely Increase the Replication Factor
    • Scylla and Spark integration
    • Increase Scylla resource limits over systemd
    • Scylla Seed Nodes
    • How to Set up a Swap Space
    • Scylla Snapshots
    • Stopping a local repair
    • System Limits
    • How to flush old tombstones from a table
    • Time to Live (TTL) and Compaction
    • Scylla Nodes are Unresponsive
    • Update a Primary Key
    • Using the perf utility with Scylla
    • Configure Scylla Networking with Multiple NIC/IP Combinations
  • Scylla University
  • Scylla FAQ
  • Contribute to Scylla
  • Glossary
  • Create an issue

On this page

  • Production Readiness Guidelines
    • Before You Begin
      • Pre-Deployment Requirements
      • Choose a Compaction Strategy
        • Incremental Compaction Strategy (ICS)
    • Resiliency
      • Replication Factors
      • Consistency Levels
      • Gossip Configuration
      • Seed Node Redundancy
    • Performance
      • perftune.yaml
      • cpuset.conf
    • Compression
      • Inter-node Compression
      • Driver Compression
    • Connectivity
      • Drivers Settings
    • Management
      • Scylla Manager
        • Repair
        • Backup and Restore
      • Scylla Monitor
      • Configuration Management
    • Security
    • HA Testing
    • Additional Topics
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon
© 2022, ScyllaDB. All rights reserved.
Last updated on 06 June 2022.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.2.2