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 2019.x.y to 2019.x.z.
This guide covers upgrading Scylla Enterprise from the following versions: 2019.x.y to 2019.x.z on the following platform:
Ubuntu 16.04 or 18.04
Note
Ubuntu 14 is not supported in the following versions of Scylla Enterprise 2019.1.0 and above
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.
Note
If any of your instances are running Scylla Enterprise 2019.1.6 or earlier, and one of your Scylla nodes is up for more than a year, you might have been exposed to issue #6063. One way to check this is by comparing Generation No (from nodetool gossipinfo output) with the current time in Epoch format (date +%s), and check if the difference is higher than one year (31536000 seconds). See scylla-check-gossiper-generation for a script to do just that.
If this is the case, do not initiate the upgrade process before consulting with Scylla Support for further instructions.
Note
Scylla Enterprise 2019.1.6 added a new configuration to restrict the memory usage cartesian product IN queries. If you are using IN in SELECT operations and hitting a “cartesian product size … is greater than maximum” error, you can either update the query (recommended) or bypass the warning temporarily by adding the following parameters to scylla.yaml:
max_clustering_key_restrictions_per_query: 1000
max_partition_key_restrictions_per_query: 1000
The higher the values, the more likely you will hit an out of memory issue.
Note
Scylla Enterprise 2019.1.8 added a new configuration to restrict the memory usage of reverse queries. If you are using reverse queries and hitting an error “Aborting reverse partition read because partition … is larger than the maximum safe size of … for reversible partitions” see the reverse queries FAQ section.
A Scylla Enterprise upgrade is a rolling procedure that does not require a 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 2019.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-2019.x.z
If you upgrade from 2019.1.x(x<5) to 2019.1.y(y>=5), you need to 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 2019.x.y version, stop right here! This guide only covers 2019.x.y to 2019.x.z upgrades.
To upgrade:
Update the Scylla Enterprise deb repo to 2019.x
Install
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 the 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 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 2019.x.z to 2019.x.y. Apply this procedure if an upgrade from 2019.x.y to 2019.x.z failed before completing on all nodes. Use this procedure only for nodes you upgraded to 2019.x.z
Scylla rollback is a rolling procedure that does not require a full cluster shutdown. For each of the nodes rollback to 2019.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=2019.x.y\* scylla-enterprise-server=2019.x.y\* scylla-enterprise-jmx=2019.x.y\* scylla-enterprise-tools=2019.x.y\* scylla-enterprise-tools-core=2019.x.y\* scylla-enterprise-kernel-conf=2019.x.y\* scylla-enterprise-conf=2019.x.y\*
Answer ‘y’ to the first two questions.
sudo rm -rf /etc/scylla/scylla.yaml
sudo cp -a /etc/scylla/scylla.yaml.backup-2019.x.z /etc/scylla/scylla.yaml
If you upgrade from 2019.1.x(x<5) to 2019.1.y(y>=5), you need to 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)
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.