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 Scylla 4.3 to Scylla Enterprise 2021.1, and rollback to 4.3 if required.
This guide covers upgrading Scylla from the following versions: 4.3.x to Scylla Enterprise version 2021.1.y, on the following platforms:
Red Hat Enterprise Linux, version 7 and later
CentOS, version 7 and later
No longer provide packages for Fedora
Note
Before upgrading to 2020.1, make sure to use Scylla Monitoring 3.3 or newer for the 2020.1 Dashboards.
Note
Execute the following commands one node at the time, moving to the next node only after the upgrade procedure completed successfully.
Warning
If you are using CDC and upgrading Scylla 4.3 to 4.4, please review the API updates in querying CDC streams and CDC stream generations. In particular, you should update applications that use CDC according to CDC Upgrade notes before upgrading the cluster to 4.4.
If you are using CDC and upgrading from pre 4.3 version to 4.3, note the upgrading from experimental CDC.
A Scylla upgrade is a rolling procedure which does not require full cluster shutdown. For each of the nodes in the cluster, serially (i.e. one at a time), you will:
Check cluster schema
Drain node and backup the data
Backup configuration file
Stop Scylla
Download and install new Scylla packages
Start Scylla
Validate that the upgrade was successful
Apply the following procedure serially on each node. Do not move to the next node before validating the node is up and running with the new version.
During the rolling upgrade it is highly recommended:
Not to use new 2021.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 prior to upgrade, we won’t survive an upgrade that has 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 complete (all nodes), the snapshot should be removed by nodetool clearsnapshot -t <snapshot>
, 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-4.3; 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 4.3.x version, stop right here! This guide only covers 4.3.x to 2021.1.y upgrades.
To upgrade:
Update the Scylla RPM Enterprise repo to 2021.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-4.3 $conf; done
New io.conf format was introduced in Scylla 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 scylla 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 Scylla Enterprise release 2021.1.x to 4.3.y. Apply this procedure if an upgrade from 4.3 to 2021.1 failed before completing on all nodes. Use this procedure only for nodes you upgraded to 2021.1
Scylla rollback is a rolling procedure which does not require full cluster shutdown. For each of the nodes rollback to 4.3, you will:
Drain the node and stop Scylla
Retrieve the old Scylla packages
Restore the configuration file
Restart Scylla
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 with 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 repo to 4.3
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-4.3 $conf; done
Restore all tables of system and system_schema from the previous snapshot because 2021.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 upgrade instruction above for validation. Once you are sure the node rollback is successful, move to the next node in the cluster.