Was this page helpful?
Caution
You're viewing documentation for a previous version of ScyllaDB Open Source. Switch to the latest stable version.
This document is a step-by-step procedure for upgrading from ScyllaDB 5.0 to ScyllaDB Enterprise 2022.1 and rollback to 5.0 if required.
This guide covers upgrading ScyllaDB from version 5.0.x to ScyllaDB Enterprise version 2022.1.y, on the following platforms:
Red Hat Enterprise Linux 7 and 8
CentOS 7 and 8
Packages for Fedora are no longer provided.
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 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 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 scheduled or running repairs.
Not to apply schema changes.
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 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.
for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ) /etc/systemd/system/{var-lib-scylla,var-lib-systemd-coredump}.mount; do sudo cp -v $conf $conf.backup-5.0; done
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 5.0.x version, stop right here! This guide only covers 5.0.x to 2022.1.y upgrades.
To upgrade:
Update the ScyllaDB RPM Enterprise repo to 2022.1.
Install:
sudo yum clean all sudo rm -rf /var/cache/yum sudo yum remove scylla\* sudo yum install scylla-enterprise for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ) /etc/systemd/system/{var-lib-scylla,var-lib-systemd-coredump}.mount; do sudo cp -v $conf.backup-5.0 $conf; done
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 with the sudo yum install scylla-enterprise-machine-image command.
A new io.conf format was introduced in ScyllaDB 2.3 and 2019.1. If your io.conf doesn’t contain the –io-properties-file option, then it’s still the old format. You need to re-run the io setup to generate a 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 check 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.
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 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 you upgraded 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 ScyllaDB RPM repo to 5.0.
Install:
sudo yum clean all sudo yum remove scylla\* sudo yum install scylla
for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ) /etc/systemd/system/{var-lib-scylla,var-lib-systemd-coredump}.mount; do sudo cp -v $conf.backup-5.0 $conf; done
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/
sudo systemctl start scylla-server
Check the upgrade instruction above for validation. Once you are sure the node rollback is successful, move to the next node in the cluster.