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 Scylla Enterprise 2021.x.y to 2021.x.z.
This guide covers upgrading Scylla Enterprise from the following versions: 2021.x.y to 2021.x.z on the following platform:
Ubuntu 20.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 Enterprise upgrade is a rolling procedure which does not require full cluster shutdown. For each of the nodes in the cluster, you will:
Drain node and backup the data
Check your current release
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.x.z features
Not to run administration functions, like repairs, refresh, rebuild or add or remove nodes
Not to apply schema changes
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-2021.x.z
Backup more configure files.
for conf in $(cat /var/lib/dpkg/info/scylla-*server.conffiles /var/lib/dpkg/info/scylla-*conf.conffiles /var/lib/dpkg/info/scylla-*jmx.conffiles | grep -v init ); do sudo cp -v $conf $conf.backup-2.1; done
sudo service scylla-server stop
Before upgrading, check what version you are running now using dpkg -s scylla-enterprise-server
. You should use the same version in case you want to rollback the upgrade. If you are not running a 2021.x.y version, stop right here! This guide only covers 2021.x.y to 2021.x.z upgrades.
To upgrade:
Update the Scylla Enterprise deb repo to 2021.x
Install
sudo apt-get clean all
sudo apt-get update
sudo apt-get dist-upgrade scylla-enterprise
Answer ‘y’ to the first two questions.
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 scylla version.
Check scylla-server log (check /var/log/upstart/scylla-server.log
for Ubuntu 14.04, execute journalctl _COMM=scylla
for Ubuntu 16.04) and /var/log/syslog
to validate there are no errors.
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.x.z to 2021.x.y. Apply this procedure if an upgrade from 2021.x.y to 2021.x.z failed before completing on all nodes. Use this procedure only for nodes you upgraded to 2021.x.z
Scylla rollback is a rolling procedure which does not require full cluster shutdown. For each of the nodes rollback to 2021.x.y, you will:
Gracefully shutdown Scylla
Downgrade to previous release
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
install
sudo apt-get install scylla-enterprise=2021.x.y\* scylla-enterprise-server=2021.x.y\* scylla-enterprise-jmx=2021.x.y\* scylla-enterprise-tools=2021.x.y\* scylla-enterprise-tools-core=2021.x.y\* scylla-enterprise-kernel-conf=2021.x.y\* scylla-enterprise-conf=2021.x.y\* scylla-enterprise-python3=2021.x.y\*
sudo apt-get install scylla-enterprise-machine-image=2021.x.y\* # only execute on AMI instance
Answer ‘y’ to the first two questions.
sudo rm -rf /etc/scylla/scylla.yaml
sudo cp -a /etc/scylla/scylla.yaml.backup-2021.x.z /etc/scylla/scylla.yaml
Restore more config files.
for conf in $(cat /var/lib/dpkg/info/scylla-*server.conffiles /var/lib/dpkg/info/scylla-*conf.conffiles /var/lib/dpkg/info/scylla-*jmx.conffiles | grep -v init ); do sudo cp -v $conf.backup-2.1 $conf; done
sudo systemctl daemon-reload (Ubuntu 16.04, 18.04 and Debian 9, 10)
sudo service scylla-server start
Check upgrade instruction above for validation. Once you are sure the node rollback is successful, move to the next node in the cluster.