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 Enterprise 2020.1 to Scylla Enterprise 2021.1, and rollback to 2020.1 if required.
This guide covers upgrading Scylla from the following versions: 2020.1.8 or later to Scylla Enterprise version 2021.1.y on the following platform:
18.04
Note
The note is only useful when CDC is GA supported in the target Scylla. 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 2020.1 to 2021.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 2021.1.
If you are using CDC and upgrading from pre 2020.1 version to 2020.1, note the upgrading from experimental CDC.
Warning
If you are using materialized views or secondary indexes created in Scylla 2019.1.x and, while upgrading to 2020.1.x (7 or lower) updated your schema; you might have MV inconsistency. To fix: rebuild the MV.
It is recommended to avoid schema and topology updates during upgrade (mix cluster).
A Scylla upgrade is a rolling procedure that does not require a full cluster shutdown. For each of the nodes in the cluster, 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.
Note
Before upgrading to 2020.1, make sure to use Scylla Monitoring 3.3 or newer for the 2020.1 Dashboards.
Make sure that all nodes have the schema synched prior to 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 complete (all nodes), the snapshot should be removed by nodetool clearsnapshot -t <snapshot>, or you risk running out of space.
sudo cp -a /etc/scylla/scylla.yaml /etc/scylla/scylla.yaml.backup-2020.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 2020.1.x version, stop right here! This guide only covers 2020.1.x to 2021.1.y upgrades.
To upgrade:
Update the Scylla Enterprise Deb repo to 2021.1, and enable scylla/ppa repo
Ubuntu 16:
sudo add-apt-repository -y ppa:scylladb/ppa
Config java to 1.8, which is requested by Scylla Enterprise 2021.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.
Installing the New Version on Cloud
If you’re using the ScyllaDB official image (recommended), see Upgrade ScyllaDB Image for upgrade instructions. If you’re using your own image and installed ScyllaDB packages for Ubuntu or Debian, you need to apply an extended upgrade procedure:
Update the ScyllaDB deb repo (see above).
Configure Java 1.8 (see above).
Install the new ScyllaDB version with the additional scylla-enterprise-machine-image package:
sudo apt-get clean all
sudo apt-get update
sudo apt-get dist-upgrade scylla-enterprise
sudo apt-get install -y scylla-enterprise-machine-image
Run scylla_setup without running io_setup.
Run sudo /opt/scylladb/scylla-machine-image/scylla_cloud_io_setup.
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 Scylla 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.
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 2020.1.y. Apply this procedure if an upgrade from 2020.1 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 that does not require a full cluster shutdown. For each of the nodes rollback to 2020.1, 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 service scylla-server stop
Remove the old repo file.
sudo rm -rf /etc/apt/sources.list.d/scylla.list
Update the Scylla Enterprise Deb repo to 2020.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-2020.1 /etc/scylla/scylla.yaml
Restore all tables of system and system_schema from previous snapshot, 2021.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 service scylla-server start
Check the upgrade instruction above for validation. Once you are sure the node rollback is successful, move to the next node in the cluster.