Was this page helpful?
Caution
You're viewing documentation for a previous version of ScyllaDB Enterprise. Switch to the latest stable version.
This document is a step-by-step procedure for upgrading from ScyllaDB Enterprise 2021.1 to Scylla Enterprise 2022.1, and rollback to 2021.1 if required.
This guide covers upgrading ScyllaDB from version 2021.1.8 or later to ScyllaDB Enterprise version 2022.1.y, on the following platforms:
Red Hat Enterprise Linux, version 7 and later
CentOS, version 7 and later
We no longer provide packages for Fedora.
A ScyllaDB upgrade is a rolling procedure that does not require a full cluster shutdown. For each of the nodes in the cluster, serially (i.e. one at a time), you will:
Check the cluster schema
Drain the node and backup the data
Backup the configuration file
Stop ScyllaDB
Download and install the 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 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 ScyllaDB 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.
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
Before any major procedure, like an upgrade, it is recommended to backup all the data to an external device. In Scylla, 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 to prevent running out of space.
sudo cp -a /etc/scylla/scylla.yaml /etc/scylla/scylla.yaml.backup-2021.1
sudo systemctl stop scylla-server
Before upgrading, check what version you are running now using rpm -qa scylla\*server. You should use the same version in case you want to rollback the upgrade. If you are not running a 2021.1.x version, stop right here! This guide only covers 2021.1.x to 2022.1.y upgrades.
To upgrade ScyllaDB:
Update the Scylla RPM Enterprise repo to 2022.1.
Install:
sudo yum clean all sudo yum update scylla\* -y
Installing the New Version on Cloud
If you’re using the ScyllaDB official image (recommended), see Upgrade Guide - ScyllaDB Image 2021.1 to 2022.1 for upgrade instructions. If you’re using your own image and installed ScyllaDB packages for CentOS/RHEL, you need to apply an extended upgrade procedure:
Update the ScyllaDB deb repo (see above).
Install the new ScyllaDB version with the additional scylla-enterprise-machine-image package:
sudo yum clean all
sudo yum update scylla\* -y
sudo yum update scylla-enterprise-machine-image
Run scylla_setup without running io_setup.
Run sudo /opt/scylladb/scylla-machine-image/scylla_cloud_io_setup.
A 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 systemctl start scylla-server
Check cluster status with nodetool status and make sure all nodes, including the one you just upgraded, are in UN status.
Use curl -X GET "http://localhost:10000/storage_service/scylla_release_version" to check the ScyllaDB version.
Use journalctl _COMM=scylla to validate there are no new errors in the log.
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.
See Scylla Metrics Update - Scylla Enterprise 2021.1 to 2022.1 for more information.
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 2021.1.y. Apply this procedure if an upgrade from 2021.1 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 you rollback to 2021.1, 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 the node is up and running the new version.
nodetool drain sudo systemctl stop scylla-server
Remove the old repo file:
sudo rm -rf /etc/yum.repos.d/scylla.repo
Update the Scylla RPM Enterprise 2022.1 repo to 2022.1
Install:
sudo yum clean all sudo rm -rf /var/cache/yum sudo yum remove scylla\*tools-core sudo yum downgrade scylla\* -y sudo yum install scylla-enterprise
sudo rm -rf /etc/scylla/scylla.yaml
sudo cp -a /etc/scylla/scylla.yaml.backup-2021.1 /etc/scylla/scylla.yaml
Restore all tables of system and system_schema from the previous snapshot - 2022.1 uses a different set of system tables. Reference doc: Restore from a Backup and Incremental Backup.
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/
sudo systemctl start scylla-server
Check the upgrade instructions above for validation. Once you are sure the node rollback is successful, move to the next node in the cluster.