Upgrade Guide - ScyllaDB Image 2021.1 to 2022.1 for EC2, GCP, and Azure¶

Check the cluster schema¶

Make sure that all nodes have the schema synched before the upgrade. The upgrade will fail if there is a schema disagreement between nodes.

nodetool describecluster

Drain the nodes and backup the data¶

Before any major procedure, like an upgrade, it is recommended to backup all the data to an external device. In ScyllaDB, 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 completed on all nodes, the snapshot should be removed with the nodetool clearsnapshot -t <snapshot> command to prevent running out of space.

Backup the configuration file¶

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

Gracefully stop the node¶

sudo service scylla-server stop

Download and install the new release¶

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 2021.1.x version, stop right here! This guide only covers 2021.1.x to 2022.1.y upgrades.

There are two alternative upgrade procedures:

• Upgrading ScyllaDB and simultaneously updating 3rd party and OS packages. It is recommended if you are running a ScyllaDB official image (EC2 AMI, GCP, and Azure images), which is based on Ubuntu 20.04.

• 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.

1. Update the ScyllaDB Enterprise Deb repo to 2022.1.

2. Load the new repo:

   sudo apt-get update
   

3. Run the following command to update the manifest file:

   cat scylla-enterprise-packages-<version>-<arch>.txt | sudo xargs -n1 apt-get install -y
   

   Where:

   • <version> - The ScyllaDB version to which you are upgrading ( 2022.1 ).

   • <arch> - Architecture type: x86_64 or aarch64.

   The file is included in the ScyllaDB packages downloaded in the previous step. The file location is http://downloads.scylladb.com/downloads/scylla-enterprise/aws/manifest/scylla-enterprise-packages-<version>-<arch>.txt.

   Example:

   cat scylla-enterprise-packages-2022.1.10-x86_64.txt | sudo xargs -n1 apt-get install -y
   

   Note

   Alternatively, you can update the manifest file with the following command:

   sudo apt-get install $(awk '{print $1'} scylla-enterprise-packages-<version>-<arch>.txt) -y

To upgrade ScyllaDB:

1. Update the ScyllaDB Enterprise Deb repo to 2022.1 and enable scylla/ppa repo.

   Ubuntu 16:
   sudo add-apt-repository -y ppa:scylladb/ppa
   

2. Configure Java 1.8, which is requested by ScyllaDB Enterprise 2022.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
   

3. 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 Guide - ScyllaDB Image 2021.1 to 2022.1 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:

1. Update the ScyllaDB deb repo (see above).

2. Configure Java 1.8 (see above).

3. 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
   

4. Run scylla_setup without running io_setup.

5. Run sudo /opt/scylladb/scylla-machine-image/scylla_cloud_io_setup.

Start the node¶

A 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

Validate¶

1. Check cluster status with nodetool status and make sure all nodes, including the one you just upgraded, are in UN status.

2. Use curl -X GET "http://localhost:10000/storage_service/scylla_release_version" to check the ScyllaDB version.

3. Check scylla-server log (by journalctl _COMM=scylla) and /var/log/syslog to validate there are no errors.

4. 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.

See Scylla Metrics Update - Scylla Enterprise 2021.1 to 2022.1 for more information.

Gracefully shutdown ScyllaDB¶

nodetool drain
sudo service scylla-server stop

Download and install the old release¶

1. Remove the old repo file.

   sudo rm -rf /etc/apt/sources.list.d/scylla.list
   

2. Update the ScyllaDB Enterprise Deb repo to 2021.1.

3. 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.

Restore the configuration file¶

sudo rm -rf /etc/scylla/scylla.yaml
sudo cp -a /etc/scylla/scylla.yaml.backup-2021.1 /etc/scylla/scylla.yaml

Restore system tables¶

Restore all tables of system and system_schema from the previous snapshot - 2022.1 uses a different set of system tables. Refer to 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/

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.