diff --git a/docs/upgrade/_common/upgrade-guide-v5-patch-ubuntu-and-debian-p1.rst b/docs/upgrade/_common/upgrade-guide-v5-patch-ubuntu-and-debian-p1.rst deleted file mode 100644 index 8bf565dec3..0000000000 --- a/docs/upgrade/_common/upgrade-guide-v5-patch-ubuntu-and-debian-p1.rst +++ /dev/null @@ -1,68 +0,0 @@ -Upgrade Guide - |SCYLLA_NAME| |SRC_VERSION| to |NEW_VERSION| for |OS| -====================================================================== - -This document is a step-by-step procedure for upgrading from |SCYLLA_NAME| |FROM| to |SCYLLA_NAME| |TO|, and rollback to 2021.1 if required. - - -Applicable Versions ------------------------- -This guide covers upgrading |SCYLLA_NAME| from version |FROM| to version |TO| on |OS|. See :doc:`OS Support by Platform and Version ` for information about supported versions. - - -Upgrade Procedure ----------------------------- - -.. note:: - Apply the following procedure **serially** on each node. Do not move to the next node before validating the node is up and running the new version. - -A ScyllaDB 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 ScyllaDB. -* Download and install new ScyllaDB packages. -* Start ScyllaDB. -* Validate that the upgrade was successful. - - -**During** the rolling upgrade it is highly recommended: - -* Not to use new |TO| features. -* Not to run administration functions, like repairs, refresh, rebuild or add or remove nodes. -* Not to apply schema changes. - -Upgrade steps -------------------------------- -Drain node 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: - -.. code:: sh - - 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 ``, or you risk running out of space. - - -Backup configuration file -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code:: sh - - sudo cp -a /etc/scylla/scylla.yaml /etc/scylla/scylla.yaml.backup-5.x.z - -Gracefully stop the node -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code:: sh - - sudo service scylla-server stop - -Download and install the new release -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Before upgrading, check what version you are running now using ``dpkg -s scylla-server``. You should use the same version in case you want to |ROLLBACK|_ the upgrade. If you are not running a |FROM| version, stop right here! This guide only covers |FROM| to |TO| upgrades. diff --git a/docs/upgrade/_common/upgrade-guide-v5-patch-ubuntu-and-debian-p2.rst b/docs/upgrade/_common/upgrade-guide-v5-patch-ubuntu-and-debian-p2.rst deleted file mode 100644 index 23af4f0c47..0000000000 --- a/docs/upgrade/_common/upgrade-guide-v5-patch-ubuntu-and-debian-p2.rst +++ /dev/null @@ -1,84 +0,0 @@ -**To upgrade ScyllaDB:** - -#. Update the |APT|_ to |NEW_VERSION|. -#. Install: - - .. code:: sh - - sudo apt-get update - sudo apt-get dist-upgrade scylla - - Answer ‘y’ to the first two questions. - -Start the node -^^^^^^^^^^^^^^^^ - -.. code:: sh - - sudo service scylla-server start - -Validate -^^^^^^^^^^^^^^^^ -#. 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. -#. Check the scylla-server log (execute ``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 ------------------------ - -.. include:: /upgrade/_common/warning_rollback.rst - -The following procedure describes a rollback from ScyllaDB release |TO| to |FROM|. Apply this procedure if an upgrade from |FROM| to |TO| failed before completing on all nodes. Use this procedure only for nodes you upgraded to |TO|. - -ScyllaDB rollback is a rolling procedure which does **not** require full cluster shutdown. -For each of the nodes rollback to |FROM|, you will: - -* Drain the node and stop ScyllaDB. -* Downgrade to previous release. -* Restore the configuration file. -* Restart ScyllaDB. -* 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. - -Rollback steps ------------------------- -Gracefully shutdown ScyllaDB -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code:: sh - - nodetool drain - sudo service scylla-server stop - -Downgrade to previous release -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Install: - -.. code:: sh - - sudo apt-get install scylla=5.x.y\* scylla-server=5.x.y\* scylla-jmx=5.x.y\* scylla-tools=5.x.y\* scylla-tools-core=5.x.y\* scylla-kernel-conf=5.x.y\* scylla-conf=5.x.y\* - -Answer ‘y’ to the first two questions. - -Restore the configuration file -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code:: sh - - sudo rm -rf /etc/scylla/scylla.yaml - sudo cp -a /etc/scylla/scylla.yaml.backup-5.x.z /etc/scylla/scylla.yaml - -Start the node -^^^^^^^^^^^^^^^^^^^ - -.. code:: sh - - sudo service scylla-server start - -Validate -^^^^^^^^^^^^^^^^^^ -Check upgrade instruction above for validation. Once you are sure the node rollback is successful, move to the next node in the cluster. diff --git a/docs/upgrade/_common/upgrade-guide-v5-patch-ubuntu-and-debian.rst b/docs/upgrade/_common/upgrade-guide-v5-patch-ubuntu-and-debian.rst deleted file mode 100644 index 21441daba2..0000000000 --- a/docs/upgrade/_common/upgrade-guide-v5-patch-ubuntu-and-debian.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. include:: /upgrade/_common/upgrade-guide-v5-patch-ubuntu-and-debian-p1.rst -.. include:: /upgrade/_common/upgrade-guide-v5-patch-ubuntu-and-debian-p2.rst diff --git a/docs/upgrade/_common/upgrade-image-opensource.rst b/docs/upgrade/_common/upgrade-image-opensource.rst deleted file mode 100644 index 2485f2a80e..0000000000 --- a/docs/upgrade/_common/upgrade-image-opensource.rst +++ /dev/null @@ -1,47 +0,0 @@ -There are two alternative upgrade procedures: - -* :ref:`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. - -* :ref:`Upgrading ScyllaDB without updating any external packages `. - -.. _upgrade-image-recommended-procedure: - -**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. - -#. Update the |SCYLLA_REPO|_ to |NEW_VERSION|. - -#. Load the new repo: - - .. code:: sh - - sudo apt-get update - - -#. Run the following command to update the manifest file: - - .. code:: sh - - cat scylla-packages--.txt | sudo xargs -n1 apt-get install -y - - Where: - - * ```` - The ScyllaDB version to which you are upgrading ( |NEW_VERSION| ). - * ```` - 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/aws/manifest/scylla-packages--.txt`` - - Example: - - .. code:: sh - - cat scylla-packages-5.1.2-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-packages--.txt) -y`` - -.. _upgrade-image-upgrade-guide-regular-procedure: \ No newline at end of file diff --git a/docs/upgrade/upgrade-opensource/upgrade-guide-from-5.x.y-to-5.x.z/upgrade-guide-from-5.x.y-to-5.x.z-image.rst b/docs/upgrade/upgrade-opensource/upgrade-guide-from-5.x.y-to-5.x.z/upgrade-guide-from-5.x.y-to-5.x.z-image.rst index 2eb688f7ec..1545ac08eb 100644 --- a/docs/upgrade/upgrade-opensource/upgrade-guide-from-5.x.y-to-5.x.z/upgrade-guide-from-5.x.y-to-5.x.z-image.rst +++ b/docs/upgrade/upgrade-opensource/upgrade-guide-from-5.x.y-to-5.x.z/upgrade-guide-from-5.x.y-to-5.x.z-image.rst @@ -1,16 +1,14 @@ -.. |OS| replace:: EC2, GCP, and Azure -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: ./#rollback-procedure -.. |SRC_VERSION| replace:: 5.x.y -.. |NEW_VERSION| replace:: 5.x.z -.. |FROM| replace:: 5.x.y -.. |TO| replace:: 5.x.z -.. |SCYLLA_NAME| replace:: ScyllaDB Image -.. |PKG_NAME| replace:: scylla -.. |SCYLLA_REPO| replace:: ScyllaDB deb repo -.. _SCYLLA_REPO: https://www.scylladb.com/download/?platform=ubuntu-20.04&version=scylla-5.0 -.. |APT| replace:: ScyllaDB deb repo -.. _APT: http://www.scylladb.com/download/ -.. include:: /upgrade/_common/upgrade-guide-v5-patch-ubuntu-and-debian-p1.rst -.. include:: /upgrade/_common/upgrade-image-opensource.rst -.. include:: /upgrade/_common/upgrade-guide-v5-patch-ubuntu-and-debian-p2.rst \ No newline at end of file +====================================================================== +Upgrade Guide - ScyllaDB Image (EC2, GCP, Azure) 5.x.y to 5.x.z +====================================================================== + + +If you are running a ScyllaDB official image (for EC2 AMI, GCP, or Azure), you +need to: + +* Download and install the new ScyllaDB release for Ubuntu. See + the :doc:`upgrade guide for Ubuntu ` + for instructions. +* Update underlying OS packages. + +See :doc:`Upgrade ScyllaDB Image ` for details. \ No newline at end of file