ScyllaDB University LIVE, FREE Virtual Training Event | March 21
Register for Free
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs ScyllaDB Open Source Scylla for Administrators Upgrade Scylla Upgrade from Scylla Open Source to Scylla Enterprise Upgrade - ScyllaDB 5.0 to ScyllaDB Enterprise 2022.1 Upgrade Guide - ScyllaDB 5.0 to ScyllaDB Enterprise 2022.1 for Ubuntu

Caution

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

Upgrade Guide - ScyllaDB 5.0 to ScyllaDB Enterprise 2022.1 for UbuntuCopy

This document is a step-by-step procedure for upgrading from ScyllaDB Open Source 5.0 to ScyllaDB Enterprise 2022.1 and rollback to 5.0 if required.

Applicable VersionsCopy

This guide covers upgrading ScyllaDB from version 5.0.x to ScyllaDB Enterprise version 2022.1.y on Ubuntu. See OS Support by Platform and Version for information about supported Ubuntu versions.

Upgrade ProcedureCopy

A ScyllaDB upgrade is a rolling procedure that does not require a full cluster shutdown. For each of the nodes in the cluster, you will:

  • Check the cluster schema

  • Drain the node and backup the data

  • Backup the configuration file

  • Stop ScyllaDB

  • Download and install new ScyllaDB packages

  • Start ScyllaDB

  • Validate that the upgrade was successful

Apply the following procedure serially on each node. Do not move to the next node before validating that the node you upgraded the node is up and running the new version.

During the rolling upgrade, it is highly recommended:

  • Not to use new 2022.1 features.

  • Not to run administration functions, like repairs, refresh, rebuild or add or remove nodes. See sctool for suspending Scylla Manager’s scheduled or running repairs.

  • Not to apply schema changes.

Note

Before upgrading to 2022.1, make sure to use Scylla Monitoring 4.0 or newer for the 2022.1 dashboards.

Upgrade StepsCopy

Check the cluster schemaCopy

Make sure that all nodes have the schema synched before the upgrade. The upgrade will fail if there is a schema disagreement between nodes.

nodetool describecluster

Drain the nodes and backup the dataCopy

Before any major procedure, like an upgrade, it is recommended to backup all the data to an external device. In ScyllaDB, backup is done using the nodetool snapshot command. For each node in the cluster, run the following command:

nodetool drain
nodetool snapshot

Take note of the directory name that nodetool gives you, and copy all the directories having this name under /var/lib/scylla to a backup device.

When the upgrade is completed on all nodes, the snapshot should be removed with the nodetool clearsnapshot -t <snapshot> command, or you risk running out of space.

Backup the configuration filesCopy

for conf in $(cat /var/lib/dpkg/info/scylla-*server.conffiles /var/lib/dpkg/info/scylla-*conf.conffiles /var/lib/dpkg/info/scylla-*jmx.conffiles | grep -v init ) /etc/systemd/system/{var-lib-scylla,var-lib-systemd-coredump}.mount; do sudo cp -v $conf $conf.backup-5.0; done

Gracefully stop the nodeCopy

sudo service scylla-server stop

Download and install the new releaseCopy

Before upgrading, check what version you are running now using dpkg -l scylla\*server. You should use the same version in case you want to rollback the upgrade. If you are not running a 5.0.x version, stop right here! This guide only covers 5.0.x to 2022.1.y upgrades.

To upgrade:

  1. Update the Scylla Enterprise Deb repo to 2022.1.

  2. Install:

    sudo apt-get clean all
    sudo apt-get update
    sudo apt-get remove scylla\*
    sudo apt-get install scylla-enterprise
    for conf in $(cat /var/lib/dpkg/info/scylla-*server.conffiles /var/lib/dpkg/info/scylla-*conf.conffiles /var/lib/dpkg/info/scylla-*jmx.conffiles | grep -v init ) /etc/systemd/system/{var-lib-scylla,var-lib-systemd-coredump}.mount; do sudo cp -v $conf.backup-5.0 $conf; done
    sudo systemctl daemon-reload
    

    Answer ‘y’ to the first two questions.

    If you use a cloud image with a preinstalled version of ScyllaDB (for example, AMI), you need to install an additional package scylla-enterprise-machine-image:

    sudo apt-get install scylla-enterprise-machine-image
    sudo systemctl daemon-reload
    

Start the nodeCopy

New io.conf format was introduced in ScyllaDB 2.3 and 2019.1. If your io.conf doesn’t contain –io-properties-file option, then it’s still the old format. You need to re-run the io setup to generate new io.conf.

sudo scylla_io_setup
sudo service scylla-server start

ValidateCopy

  1. Check cluster status with nodetool status and make sure all nodes, including the one you just upgraded, are in UN status.

  2. Use curl -X GET "http://localhost:10000/storage_service/scylla_release_version" to check the ScyllaDB version.

  3. Check scylla-server log (by journalctl _COMM=scylla) and /var/log/syslog to validate there are no errors.

  4. Check again after 2 minutes to validate no new issues are introduced.

Once you are sure the node upgrade is successful, move to the next node in the cluster.

More on ScyllaDB Metrics Update - ScyllaDB 5.0 to 2022.1

Rollback ProcedureCopy

Note

Execute the following commands one node at the time, moving to the next node only after the rollback procedure completed successfully.

The following procedure describes a rollback from ScyllaDB Enterprise release 2022.1.x to ScyllaDB 5.0.y. Apply this procedure if an upgrade from 5.0 to 2022.1 failed before completing on all nodes. Use this procedure only for nodes you upgraded to 2022.1.

ScyllaDB rollback is a rolling procedure that does not require a full cluster shutdown. For each of the nodes to rollback to 5.0, you will:

  • Drain the node and stop ScyllaDB

  • Retrieve the old ScyllaDB packages

  • Restore the configuration file

  • Restart ScyllaDB

  • Validate the rollback success

Apply the following procedure serially on each node. Do not move to the next node before validating that the node is up and running the new version.

Rollback StepsCopy

Gracefully shutdown ScyllaDBCopy

nodetool drain
sudo service scylla-server stop

Download and install the old releaseCopy

  1. Remove the old repo file.

    sudo rm -rf /etc/apt/sources.list.d/scylla.list
    
  2. Update the ScyllaDB deb repo to 5.0.

  3. Install:

    sudo apt-get clean all
    sudo apt-get update
    sudo apt-get remove scylla\* -y
    sudo apt-get install scylla
    

Answer ‘y’ to the first two questions.

Restore the configuration filesCopy

for conf in $(cat /var/lib/dpkg/info/scylla-*server.conffiles /var/lib/dpkg/info/scylla-*conf.conffiles /var/lib/dpkg/info/scylla-*jmx.conffiles | grep -v init ) /etc/systemd/system/{var-lib-scylla,var-lib-systemd-coredump}.mount; do sudo cp -v $conf.backup-5.0 $conf; done
sudo systemctl daemon-reload

Restore system tablesCopy

Restore all tables of system and system_schema from the previous snapshot because 2022.1 uses a different set of system tables. See Restore from a Backup and Incremental Backup for reference.

cd /var/lib/scylla/data/keyspace_name/table_name-UUID/
sudo find . -maxdepth 1 -type f  -exec sudo rm -f "{}" +
cd /var/lib/scylla/data/keyspace_name/table_name-UUID/snapshots/<snapshot_name>/
sudo cp -r * /var/lib/scylla/data/keyspace_name/table_name-UUID/
sudo chown -R scylla:scylla /var/lib/scylla/data/keyspace_name/table_name-UUID/

Start the nodeCopy

sudo service scylla-server start

ValidateCopy

Check the upgrade instruction above for validation. Once you are sure the node rollback is successful, move to the next node in the cluster.

Was this page helpful?

PREVIOUS
Upgrade Guide - ScyllaDB 5.0 to 2022.1 for Red Hat Enterprise Linux 7/8 or CentOS 7/8
NEXT
Upgrade Guide - ScyllaDB 5.0 to ScyllaDB Enterprise 2022.1 for Debian 10
  • Create an issue
  • Edit this page

On this page

  • Upgrade Guide - ScyllaDB 5.0 to ScyllaDB Enterprise 2022.1 for Ubuntu
    • Applicable Versions
    • Upgrade Procedure
    • Upgrade Steps
      • Check the cluster schema
      • Drain the nodes and backup the data
      • Backup the configuration files
      • Gracefully stop the node
      • Download and install the new release
      • Start the node
      • Validate
    • Rollback Procedure
    • Rollback Steps
      • Gracefully shutdown ScyllaDB
      • Download and install the old release
      • Restore the configuration files
      • Restore system tables
      • Start the node
      • Validate
ScyllaDB Open Source
  • 5.1
    • master
    • 6.2
    • 6.1
    • 6.0
    • 5.4
    • 5.2
    • 5.1
  • Getting Started
    • Install Scylla
      • ScyllaDB Web Installer for Linux
      • 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
    • ScyllaDB Requirements
      • System Requirements
      • OS Support by Platform and Version
      • Scylla in a Shared Environment
    • Migrate to ScyllaDB
      • 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
      • Virtual Tables
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
    • ScyllaDB Manager
    • Upgrade Procedures
      • Scylla Enterprise
      • Scylla Open Source
      • Scylla Open Source to Scylla Enterprise
      • 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
    • Scylla Alternator
    • Scylla Features
      • Scylla Open Source Features
      • Scylla Enterprise Features
    • Scylla Drivers
      • Scylla CQL Drivers
      • Scylla DynamoDB Drivers
  • CQL Reference
    • CQLSh: the CQL shell
    • Appendices
    • Compaction
    • Consistency Levels
    • Consistency Level Calculator
    • Data Definition
    • Data Manipulation
    • Data Types
    • Definitions
    • Global Secondary Indexes
    • Additional Information
    • Expiring Data with Time to Live (TTL)
    • Additional Information
    • Functions
    • JSON Support
    • Materialized Views
    • Non-Reserved CQL Keywords
    • Reserved CQL Keywords
    • ScyllaDB CQL Extensions
  • 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
      • ScyllaDB 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
    • Updating the Mode in perftune.yaml After a ScyllaDB Upgrade
    • 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
    • Scylla payload sent duplicated static columns
    • 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
  • ScyllaDB University
  • Scylla FAQ
  • Contribute to ScyllaDB
  • Glossary
  • Alternator: DynamoDB API in Scylla
    • Getting Started With ScyllaDB Alternator
    • Scylla Alternator for DynamoDB users
Docs Tutorials University Contact Us About Us
© 2025, ScyllaDB. All rights reserved. | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 08 May 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6
Yes
No
User Slack channel
Community forum
Collapse