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 ScyllaDB Enterprise 2022.x to ScyllaDB Enterprise 2023.1, and rollback to version 2022.x if required.
This guide covers upgrading ScyllaDB on Red Hat Enterprise Linux (RHEL) CentOS, Debian, and Ubuntu. See OS Support by Platform and Version for information about supported versions.
This guide also applies when you’re upgrading ScyllaDB Enterprise official image on EC2, GCP, or Azure. The image is based on Ubuntu 22.04.
A ScyllaDB upgrade is a rolling procedure which does not require full cluster shutdown. For each of the nodes in the cluster you will:
Check that the cluster’s schema is synchronized
Drain the node and backup the data
Backup the configuration file
Stop ScyllaDB
Download and install new ScyllaDB packages
(Optional) Enable consistent cluster management in the configuration file
Start ScyllaDB
Validate that the upgrade was successful
Caution
Apply the procedure serially on each node. Do not move to the next node before validating that the node you upgraded is up and running the new version.
During the rolling upgrade, it is highly recommended:
Not to use the new 2023.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, make sure to use the latest ScyllaDB Monitoring stack.
If you enabled consistent cluster management in each node’s configuration file, then as soon as every node has been upgraded to the new version, the cluster will start a procedure that initializes the Raft algorithm for consistent cluster metadata management. You must then verify that this procedure successfully finishes.
Make sure that all nodes have the schema synchronized before upgrade. The upgrade procedure 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. You can use ScyllaDB Manager for creating backups.
sudo cp -a /etc/scylla/scylla.yaml /etc/scylla/scylla.yaml.backup-src
sudo service scylla-server stop
Before upgrading, check what version you are running now using scylla --version. You should use the same version as this version in case you want to rollback the upgrade. If you are not running a 2022.x.x version, stop right here! This guide only covers 2022.x.x to 2023.1.y upgrades.
To upgrade ScyllaDB Enterprise:
Update the ScyllaDB deb repo (Debian, Ubuntu) to 2023.1 and and enable scylla/ppa repo:
sudo add-apt-repository -y ppa:scylladb/ppa
Configure Java 1.8:
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 the new ScyllaDB version:
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 the EC2/GCP/Azure Ubuntu Image tab 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 dist-upgrade scylla-enterprise-machine-image
Run scylla_setup without running io_setup (note that running
scylla_setup during the upgrade may trigger resharding).
Run sudo /opt/scylladb/scylla-machine-image/scylla_cloud_io_setup.
Before upgrading, check what version you are running now using scylla --version. You should use the same version as this version in case you want to rollback the upgrade. If you are not running a 2022.x.x version, stop right here! This guide only covers 2022.x.x to 2023.1.y upgrades.
To upgrade ScyllaDB:
Update the ScyllaDB rpm repo to 2023.1.
Install the new ScyllaDB version:
sudo yum clean all sudo yum update scylla\* -y
Installing the New Version on Cloud
If you’re using the ScyllaDB official image (recommended), see the EC2/GCP/Azure Ubuntu Image tab for upgrade instructions. If you’re using your own image and installed ScyllaDB packages for CentOS/RHEL, you need to apply an extended upgrade procedure:
Update the ScyllaDB deb repo (see above).
Install the new ScyllaDB version with the additional scylla-enterprise-machine-image package:
sudo yum clean all sudo yum update scylla\* -y sudo yum update scylla-enterprise-machine-image
Run scylla_setup without running io_setup (note that running
scylla_setup during the upgrade may trigger resharding).
Run sudo /opt/scylladb/scylla-machine-image/scylla_cloud_io_setup.
Before upgrading, check what version you are running now using scylla --version. You should use the same version as this version in case you want to rollback the upgrade. If you are not running a 2022.x.x version, stop right here! This guide only covers 2022.x.x to 2023.1.y upgrades.
There are two alternative upgrade procedures: upgrading ScyllaDB and simultaneously updating 3rd party and OS packages - recommended if you are running a ScyllaDB official image (EC2 AMI, GCP, and Azure images), which is based on Ubuntu 22.04, and upgrading ScyllaDB without updating any external packages.
To upgrade ScyllaDB and update 3rd party and OS packages (RECOMMENDED):
Choosing this upgrade procedure allows you to upgrade your ScyllaDB version and update the 3rd party and OS packages using one command.
Load the new repo:
sudo apt-get update
Run the following command to update the manifest file:
cat scylla-enterprise-packages-<version>-<arch>.txt | sudo xargs -n1 apt-get install -yWhere:
<version>- The ScyllaDB Enterprise version to which you are upgrading ( 2023.1 ).
<arch>- Architecture type:x86_64oraarch64.The file is included in the ScyllaDB Enterprise packages downloaded in the previous step. The file location is
http://downloads.scylladb.com/downloads/scylla/aws/manifest/scylla-packages-<version>-<arch>.txtExample:
cat scylla-enterprise-packages-2023.1.0-x86_64.txt | sudo xargs -n1 apt-get install -yNote
Alternatively, you can update the manifest file with the following command:
sudo apt-get install $(awk '{print $1'} scylla-packages-<version>-<arch>.txt) -y
To upgrade ScyllaDB without updating any external packages, follow the download and installation instructions for Debian/Ubuntu.
Optionally, you can enable Raft-based consistent cluster management on your cluster with the consistent_cluster_management
option. Setting the option to true on every node enables the Raft consensus algorithm for your cluster. Raft will be used
to consistently manage cluster-wide metadata as soon as you finish upgrading every node to the new version. See
Raft in ScyllaDB to learn more.
In 2023.1, Raft-based consistent cluster management is disabled by default.
To enable it, modify the scylla.yaml configuration file in /etc/scylla/ on every node and add the following:
consistent_cluster_management: true
Note
Once you finish upgrading every node with consistent_cluster_management enabled, it won’t be possible to disable the option.
The option can also be enabled after the cluster is upgraded to 2023.1 (see Enabling Raft in existing cluster).
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. Validate that the version matches the one you upgraded to.
Check scylla-server log (using journalctl _COMM=scylla) and /var/log/syslog to validate there are no new errors in the log.
Check again after two minutes, to validate no new issues are introduced.
Once you are sure the node upgrade was successful, move to the next node in the cluster.
See ScyllaDB Enterprise Metrics Update - ScyllaDB Enterprise 2022.x to 2023.1 for more information.
The following section only applies if you enabled the consistent_cluster_management option
on every node when upgrading the cluster.
When you enable consistent_cluster_management on every node during an upgrade, the ScyllaDB cluster will start an additional
internal procedure as soon as every node is upgraded to the new version. The goal of the procedure is to initialize data structures
used by the Raft algorithm to consistently manage cluster-wide metadata such as table schemas.
If you performed the rolling upgrade procedure correctly (in particular, ensuring that schema is synchronized on every step and there are no problems with cluster connectivity), that internal procedure should take no longer than a few seconds to finish. However, the procedure requires full cluster availability. If one of your nodes fails before this procedure finishes (for example, due to a hardware problem), the procedure may get stuck. This may cause the cluster to end up in a state where schema change operations are unavailable.
For this reason, you must verify that the internal procedure has finished successfully by checking the logs of every ScyllaDB node. If the procedure gets stuck, manual intervention is required.
Refer to Verifying that the internal Raft upgrade procedure finished successfully for instructions on how to verify that the procedure was successful and how to proceed if it gets stuck.
Note
Execute the following commands one node at a time, moving to the next node only after the rollback procedure is completed successfully.
The following procedure describes a rollback from ScyllaDB Enterprise 2023.1.x to 2022.x.y. Apply this procedure if an upgrade from 2022.x to 2023.1 failed before completing on all nodes. Use this procedure only for nodes you upgraded to 2023.1.
Warning
The rollback procedure can be applied only if some nodes have not been upgraded to 2023.1 yet. As soon as the last node in the rolling upgrade procedure is started with 2023.1, rollback becomes impossible. At that point, the only way to restore a cluster to 2022.x is by restoring it from backup.
ScyllaDB rollback is a rolling procedure which does not require a full cluster shutdown. For each of the nodes you rollback to 2022.x you will:
Drain the node and stop ScyllaDB
Retrieve the old ScyllaDB packages
Restore the configuration file
Restore system tables
Reload systemd configuration
Restart ScyllaDB
Validate the rollback success
Apply the following procedure serially on each node. Do not move to the next node before validating that the rollback was successful and the node is up and running the old version.
nodetool drain
sudo service scylla-server stop
Remove the old repo file.
sudo rm -rf /etc/apt/sources.list.d/scylla.list
Install:
sudo apt-get update sudo apt-get remove scylla\* -y sudo apt-get install scylla-enterprise
Answer ‘y’ to the first two questions.
Remove the old repo file.
sudo rm -rf /etc/yum.repos.d/scylla.repo
Update the ScyllaDB rpm repo to 2022.x.
Install:
sudo yum clean all sudo rm -rf /var/cache/yum sudo yum remove scylla\*tools-core sudo yum downgrade scylla\* -y sudo yum install scylla-enterprise
sudo rm -rf /etc/scylla/scylla.yaml
sudo cp -a /etc/scylla/scylla.yaml.backup-src | /etc/scylla/scylla.yaml
Restore all tables of system and system_schema from the previous snapshot because 2023.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/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/
You must reload the unit file if the systemd unit file is changed.
sudo systemctl daemon-reload
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.