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 Enterprise 2021.1 to ScyllaDB Enterprise 2022.1, and rollback to 2021.1 if required.
This guide covers upgrading ScyllaDB Enterprise from version 2021.1.8 or later to ScyllaDB Enterprise version 2022.1.y on Debian. See OS Support by Platform and Version for information about supported versions.
Note
The note is only useful when CDC is GA supported in the target ScyllaDB. Execute the following commands one node at a time, moving to the next node only after the upgrade procedure completed successfully.
Warning
If you are using CDC and upgrading ScyllaDB 2021.1 to 2022.1, 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 2022.1.
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 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 the node that 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 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 to prevent running out of space.
sudo cp -a /etc/scylla/scylla.yaml /etc/scylla/scylla.yaml.backup-2021.1
sudo service scylla-server stop
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 2021.1.x version, stop right here! This guide only covers 2021.1.x to 2022.1.y upgrades.
To upgrade ScyllaDB:
Update the ScyllaDB Enterprise Deb repo to 2022.1 and enable scylla/ppa repo.
Ubuntu 16:
sudo add-apt-repository -y ppa:scylladb/ppa
Configure Java 1.8, which is requested by ScyllaDB Enterprise 2022.1.
sudo apt-get update
sudo apt-get install -y openjdk-8-jre-headless
sudo update-java-alternatives -s java-1.8.0-openjdk-amd64
Install:
sudo apt-get clean all
sudo apt-get update
sudo apt-get dist-upgrade scylla-enterprise
Answer ‘y’ to the first two questions.
A 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 service scylla-server start
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.
Check scylla-server log (by journalctl _COMM=scylla) and /var/log/syslog to validate there are no errors.
Check again after two 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 2022.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 Scylla 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 with the new version.
nodetool drain
sudo service scylla-server stop
Remove the old repo file.
sudo rm -rf /etc/apt/sources.list.d/scylla.list
Update the ScyllaDB Enterprise Deb repo to 2021.1.
Install:
sudo apt-get clean all sudo apt-get update sudo apt-get remove scylla\* -y sudo apt-get install scylla-enterprise
Answer ‘y’ to the first two questions.
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. Refer to 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 service scylla-server start
Check the upgrade instructions above for validation. Once you are sure the node rollback is successful, move to the next node in the cluster.