Was this page helpful?
Caution
You're viewing documentation for a previous version. Switch to the latest stable version.
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¶
ScyllaDB System Requirements - verify your instances, system, OS, etc are supported by ScyllaDB for production machines.
Choose a Compaction Strategy¶
Each workload may require a specific strategy. Refer to Choose a Compaction Strategy for details.
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 ScyllaDB Fault Tolerance
Take a course at ScyllaDB 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 ScyllaDB Fault Tolerance
Watch a Demo
Take a course at ScyllaDB University on CL
Gossip Configuration¶
Choose the correct Snitch.
Always use
GossipingPropertyFileSnitchorEc2MultiRegionSnitchDo Not use SimpleStrategy on any production machine, even if you only have a single DC.For additional information:
Refer to Gossip in ScyllaDB
Follow the How to Switch Snitches procedure if required.
Take a course at ScyllaDB University on Gossip
Use the correct Data Replication strategy.
Use
NetworkTopologyStrategyreplication-strategy as it supports multi-DC for your keyspaces.
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¶
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 ScyllaDB 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 ScyllaDB. Verify your client driver is using compressed traffic when connected to ScyllaDB. As compression is driver settings dependent, please check your client driver manual or ScyllaDB Drivers.
Connectivity¶
Drivers Settings¶
Use shard aware drivers wherever possible. ScyllaDB 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 ScyllaDB Manager and ScyllaDB Monitor.
ScyllaDB Manager¶
ScyllaDB 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 ScyllaDB Manager. Refer to Repair a Cluster
Backup and Restore¶
We recommend the following:
Run a full weekly backup from ScyllaDB Manager
Run a daily backup from ScyllaDB 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 ScyllaDB Manager.
For additional information:
ScyllaDB Monitoring Stack¶
ScyllaDB Monitoring Stack helps you monitor everything about your ScyllaDB cluster. ScyllaDB Support team usually asks for your monitoring metrics when you open a ticket.
See ScyllaDB Monitoring Stack for details.
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:
Shutdown one node from the cluster (Or scylla service if on the cloud) for 30 min.
Turn it back on.
HA testing in multi DC - for example:
Disconnect one DC from the other by stopping scylla service on all of these DC nodes.
Reconnect the DC.