ScyllaDB Docs ScyllaDB Enterprise Upgrade Guide - ScyllaDB Enterprise 2024.x.y to 2024.x.z

Caution

You're viewing documentation for a previous version. Switch to the latest stable version.

Upgrade Guide - ScyllaDB Enterprise 2024.x.y to 2024.x.z¶

This document is a step-by-step procedure for upgrading from ScyllaDB Enterprise 2024.x.y to ScyllaDB Enterprise 2024.x.z (where “z” is the latest available version).

Applicable Versions¶

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.

Upgrade Procedure¶

A ScyllaDB 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 the node and backup the data
Check your current release
Backup the configuration file
Stop ScyllaDB
Download and install the new ScyllaDB packages
Start ScyllaDB
Validate that the upgrade was successful

Caution

Apply the following procedure serially on each node. Do not move to the next node before validating that the node that you upgraded is up and running the new version.

Before upgrading, check what version you are running now using scylla --version. You should use the same version in case you want to rollback the upgrade.

During the rolling upgrade, it is highly recommended:

Not to use new 2024.x.z features.
Not to run administration functions, like repairs, refresh, rebuild or add or remove nodes.
Not to apply schema changes.

Upgrade Steps¶

Drain the node and backup the data¶

Before any major procedure, such as an upgrade, it is recommended to backup all the data to an external device. You can use ScyllaDB Manager for creating backups.

Backup the configuration file¶

sudo cp -a /etc/scylla/scylla.yaml /etc/scylla/scylla.yaml.backup-src

Backup 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 $conf.backup-2.1; done

Gracefully stop the node¶

sudo service scylla-server stop

Download and install the new release¶

Update the ScyllaDB Enterprise deb repo to 2024.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.

To upgrade:

Update the ScyllaDB Enterprise rpm repo to 2024.x.

Install:

sudo yum clean all
sudo yum update scylla\* -y

If you’re using the ScyllaDB official image (recommended), see the Debian/Ubuntu 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 Enterprise deb repo to 2024.x.

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.
Run sudo /opt/scylladb/scylla-machine-image/scylla_cloud_io_setup.

Start the node¶

sudo service scylla-server start

Validate¶

Check the 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 Enterprise version.
Check scylla-server log (by journalctl _COMM=scylla) 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.

Rollback Procedure¶

The following procedure describes a rollback from ScyllaDB Enterprise 2024.x.z to 2024.x.y. Apply this procedure if an upgrade from 2024.x.y to 2024.x.z failed before completing on all nodes.

ScyllaDB rollback is a rolling procedure that does not require a full cluster shutdown. For each of the nodes to rollback to 2024.x.y, you will:

Gracefully shutdown ScyllaDB
Downgrade to the previous release
Restore the configuration file
Restart ScyllaDB
Validate the rollback success

Caution

Apply the above procedure serially on each node. Do not move to the next node before validating the node that you upgraded is up and running the previous version.

Rollback Steps¶

Gracefully shutdown ScyllaDB¶

nodetool drain
sudo service scylla-server stop

Downgrade to the previous release¶

Install:

sudo apt-get install scylla-enterprise=2024.x.y\* scylla-enterprise-server=2024.x.y\* scylla-enterprise-jmx=2024.x.y\* scylla-enterprise-tools=2024.x.y\* scylla-enterprise-tools-core=2024.x.y\* scylla-enterprise-kernel-conf=2024.x.y\* scylla-enterprise-conf=2024.x.y\* scylla-enterprise-python3=2024.x.y\*
sudo apt-get install scylla-enterprise-machine-image=2024.x.y\*  # only execute on AMI instance

Answer ‘y’ to the first two questions.

Install:

 sudo yum downgrade scylla\*-2024.x.y-\* -y

Restore the configuration file¶

sudo rm -rf /etc/scylla/scylla.yaml
sudo cp -a /etc/scylla/scylla.yaml.backup-src /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

Start the node¶

sudo service scylla-server start

Validate¶

Check the upgrade instructions above for validation. Once you are sure the node rollback is successful, move to the next node in the cluster.

Was this page helpful?