diff --git a/docs/troubleshooting/missing-dotmount-files.rst b/docs/troubleshooting/missing-dotmount-files.rst index 26afeb4f4b..6c95fcb132 100644 --- a/docs/troubleshooting/missing-dotmount-files.rst +++ b/docs/troubleshooting/missing-dotmount-files.rst @@ -12,7 +12,7 @@ the ``/etc/systemd/system/var-lib-scylla.mount`` and ``/etc/systemd/system/var-l deleted by RPM. To avoid losing the files, the upgrade procedure includes a step to backup the .mount files. The following -example shows the command to backup the files before the :doc:`upgrade from version 5.0 `: +example shows the command to backup the files before the upgrade from version 5.0: .. code-block:: console diff --git a/docs/upgrade/upgrade-to-enterprise/index.rst b/docs/upgrade/upgrade-to-enterprise/index.rst index 182923e3f6..0bc72b0f95 100644 --- a/docs/upgrade/upgrade-to-enterprise/index.rst +++ b/docs/upgrade/upgrade-to-enterprise/index.rst @@ -1,6 +1,6 @@ -==================================================== -Upgrade from Scylla Open Source to Scylla Enterprise -==================================================== +========================================================= +Upgrade from ScyllaDB Open Source to ScyllaDB Enterprise +========================================================= .. toctree:: :titlesonly: @@ -8,13 +8,6 @@ Upgrade from Scylla Open Source to Scylla Enterprise ScyllaDB 5.2 to ScyllaDB Enterprise 2023.1 ScyllaDB 5.1 to ScyllaDB Enterprise 2022.2 - ScyllaDB 5.0 to ScyllaDB Enterprise 2022.1 - Scylla 4.3 to Scylla Enterprise 2021.1 - Scylla 4.0 to Scylla Enterprise 2020.1 - Scylla 3.0 to Scylla Enterprise 2019.1 - Scylla 2.1 to Scylla Enterprise 2018.1 - Scylla 1.6 to Scylla Enterprise 2017.1 - .. raw:: html @@ -23,21 +16,14 @@ Upgrade from Scylla Open Source to Scylla Enterprise
-
Upgrade to Scylla Enterprise
+
Upgrade to ScyllaDB Enterprise
-Procedures for upgrading from Scylla Open Source to Scylla Enterprise. - -* :doc:`Upgrade - ScyllaDB 5.2 to Scylla Enterprise 2023.1 ` -* :doc:`Upgrade - ScyllaDB 5.1 to Scylla Enterprise 2022.2 ` -* :doc:`Upgrade - ScyllaDB 5.0 to Scylla Enterprise 2022.1 ` -* :doc:`Upgrade - Scylla 4.3 to Scylla Enterprise 2021.1 ` -* :doc:`Upgrade - Scylla 4.0 to Scylla Enterprise 2020.1 ` -* :doc:`Upgrade - Scylla 3.0 to Scylla Enterprise 2019.1 ` -* :doc:`Upgrade - Scylla 2.1 to Scylla Enterprise 2018.1 ` -* :doc:`Upgrade - Scylla 1.6 to Scylla Enterprise 2017.1 ` +Procedures for upgrading from ScyllaDB Open Source to ScyllaDB Enterprise: +* :doc:`ScyllaDB 5.2 to ScyllaDB Enterprise 2023.1 ` +* :doc:`ScyllaDB 5.1 to ScyllaDB Enterprise 2022.2 ` .. raw:: html diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-1.6-to-2017.1/index.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-1.6-to-2017.1/index.rst deleted file mode 100644 index 0c48dabddf..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-1.6-to-2017.1/index.rst +++ /dev/null @@ -1,36 +0,0 @@ -================================================ -Upgrade - Scylla 1.6 to Scylla Enterprise 2017.1 -================================================ - -.. toctree:: - :titlesonly: - :hidden: - - Red Hat Enterprise Linux and CentOS - Ubuntu - Debian - - -.. raw:: html - - -
-
-
-
Upgrade Scylla Scylla 1.6 to Scylla Enterprise 2017.1
-
-
- -Upgrade guides are available for: - -* :doc:`Upgrade Scylla from 1.6.x to Scylla Enterprise 2017.1.y on Red Hat Enterprise Linux and CentOS ` -* :doc:`Upgrade Scylla from 1.6.x to Scylla Enterprise 2017.1.y on Ubuntu ` -* :doc:`Upgrade Scylla from 1.6.x to Scylla Enterprise 2017.1.y on Debian ` - - - -.. raw:: html - -
-
-
diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-1.6-to-2017.1/upgrade-guide-from-1.6-to-2017.1-debian.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-1.6-to-2017.1/upgrade-guide-from-1.6-to-2017.1-debian.rst deleted file mode 100644 index 30c7896456..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-1.6-to-2017.1/upgrade-guide-from-1.6-to-2017.1-debian.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. |OS| replace:: Debian 8 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-1.6-to-2017.1/upgrade-guide-from-1.6-to-2017.1-debian/#rollback-procedure -.. |APT| replace:: Scylla Enterprise Deb repo -.. _APT: http://www.scylladb.com/enterprise-download/debian8/ -.. include:: /upgrade/_common/upgrade-guide-from-1.6-to-2017.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-1.6-to-2017.1/upgrade-guide-from-1.6-to-2017.1-rpm.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-1.6-to-2017.1/upgrade-guide-from-1.6-to-2017.1-rpm.rst deleted file mode 100644 index f71703c697..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-1.6-to-2017.1/upgrade-guide-from-1.6-to-2017.1-rpm.rst +++ /dev/null @@ -1,156 +0,0 @@ -=========================================================================================== -Upgrade Guide - Scylla 1.6 to Scylla Enterprise 2017.1 for Red Hat Enterprise 7 or CentOS 7 -=========================================================================================== - -This document is a step by step procedure for upgrading from Scylla 1.6 to Scylla Enterprise 2017.1, and rollback to 1.6 if required. - - -Applicable versions -=================== -This guide covers upgrading Scylla from the following versions: 1.6.x to Scylla Enterprise version 2017.1.y, on the following platforms: - -* Red Hat Enterprise Linux, version 7 and later -* CentOS, version 7 and later -* No longer provide packages for Fedora - -Upgrade Procedure -================= - -.. include:: /upgrade/_common/warning.rst - -A Scylla upgrade is a rolling procedure which does not require full cluster shutdown. For each of the nodes in the cluster, serially (i.e. one at a time), 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 Scylla Enterprise 2017.1 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 Scylla, 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-1.6 - -Stop Scylla ------------ -.. code:: sh - - sudo systemctl stop scylla-server - -Download and install the new release ------------------------------------- -Before upgrading, check what version you are running now using ``rpm -qa | grep scylla-server``. You should use the same version in case you want to :ref:`rollback ` the upgrade. If you are not running a 1.6.x version, stop right here! This guide only covers 1.6.x to 2017.1.y upgrades. - -To upgrade: - -1. Update the `Scylla RPM Enterprise repo `_ to **2017.1** -2. install - -.. code:: sh - - sudo yum update scylla\* -y - -Start the node --------------- -.. code:: sh - - sudo systemctl start scylla-server - -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 scylla version. -3. Use ``journalctl _COMM=scylla`` to check there are no new errors in the log. -4. 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. - -.. _upgrade-1.6-2017.1-rpm-rollback-procedure: - -Rollback Procedure -================== - -.. include:: /upgrade/_common/warning_rollback.rst - -The following procedure describes a rollback from Scylla release 2017.1.x to 1.6.y. Apply this procedure if an upgrade from 1.6 to 2017.1 failed before completing on all nodes. Use this procedure only for nodes you upgraded to 2017.1 - -Scylla rollback is a rolling procedure which does **not** require full cluster shutdown. -For each of the nodes rollback to 1.6, you will: - -* drain the node and stop Scylla -* retrieve the old Scylla packages -* 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. - -Rollback steps -============== -Gracefully shutdown Scylla --------------------------- -.. code:: sh - - nodetool drain - sudo systemctl stop scylla-server - -Download and install the new release ------------------------------------- -1. Remove the old repo file. - -.. code:: sh - - sudo rm -rf /etc/yum.repos.d/scylla.repo - -2. Update the `Scylla RPM repo `_ to **1.6** -3. Install - -.. code:: sh - - sudo yum clean all - sudo yum downgrade scylla\* -y - -Restore the configuration file ------------------------------- - -.. code:: sh - - sudo rm -rf /etc/scylla/scylla.yaml - sudo cp -a /etc/scylla/scylla.yaml.backup-1.6 /etc/scylla/scylla.yaml - -Start the node --------------- - -.. code:: sh - - sudo systemctl start scylla-server - -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/upgrade-to-enterprise/upgrade-guide-from-1.6-to-2017.1/upgrade-guide-from-1.6-to-2017.1-ubuntu.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-1.6-to-2017.1/upgrade-guide-from-1.6-to-2017.1-ubuntu.rst deleted file mode 100644 index b5702fbd59..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-1.6-to-2017.1/upgrade-guide-from-1.6-to-2017.1-ubuntu.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. |OS| replace:: Ubuntu 14.04 or 16.04 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-1.6-to-2017.1/upgrade-guide-from-1.6-to-2017.1-ubuntu/#rollback-procedure -.. |APT| replace:: Scylla Enterprise Deb repo -.. _APT: http://www.scylladb.com/enterprise-download/ubuntu-16-04/ -.. include:: /upgrade/_common/upgrade-guide-from-1.6-to-2017.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/index.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/index.rst deleted file mode 100644 index a7a3a21f58..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/index.rst +++ /dev/null @@ -1,38 +0,0 @@ -================================================ -Upgrade - Scylla 2.1 to Scylla Enterprise 2018.1 -================================================ - -.. toctree:: - :titlesonly: - :hidden: - - Red Hat Enterprise Linux and CentOS - Ubuntu 14.04 - Ubuntu 16.04 - Debian - Metrics - - -.. raw:: html - - -
-
-
-
Upgrade Scylla Scylla 2.1 to Scylla Enterprise 2018.1
-
-
- -Upgrade guides are available for: - -* :doc:`Upgrade Scylla Enterprise from 2.1.x to 2018.1.y on Red Hat Enterprise Linux and CentOS ` -* :doc:`Upgrade Scylla Enterprise from 2.1.x to 2018.1.y on Ubuntu 14.04 ` -* :doc:`Upgrade Scylla Enterprise from 2.1.x to 2018.1.y on Ubuntu 16.04 ` -* :doc:`Upgrade Scylla Enterprise from 2.1.x to 2018.1.y on Debian ` -* :doc:`Scylla Metrics Update - Scylla 2.1 to 2018.1 ` - -.. raw:: html - -
-
-
diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/metric-update-2.1-to-2018.1.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/metric-update-2.1-to-2018.1.rst deleted file mode 100644 index ec012e1d07..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/metric-update-2.1-to-2018.1.rst +++ /dev/null @@ -1,10 +0,0 @@ -============================================================= -Scylla Metric Update - Scylla 2.1 to Scylla Enterprise 2018.1 -============================================================= - - -The following metrics are new in Scylla 2018.1 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -* scylla_evictions_from_garbage -* scylla_garbage_partitions diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-debian.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-debian.rst deleted file mode 100644 index 4b57de4592..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-debian.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. |OS| replace:: Debian 8 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-debian/#rollback-procedure -.. |APT| replace:: Scylla deb repo -.. _APT: http://www.scylladb.com/download/debian8/ -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: http://www.scylladb.com/enterprise-download/debian8/ -.. |ENABLE_APT_REPO| replace:: echo 'deb http://http.debian.net/debian jessie-backports main' > /etc/apt/sources.list.d/jessie-backports.list -.. |JESSIE_BACKPORTS| replace:: -t jessie-backports openjdk-8-jre-headless -.. include:: /upgrade/_common/upgrade-guide-from-2.1-to-2018.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-rpm.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-rpm.rst deleted file mode 100644 index 94bf1c3977..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-rpm.rst +++ /dev/null @@ -1,170 +0,0 @@ -============================================================================================= -Upgrade Guide - Scylla 2.1 to 2018.1 for Red Hat Enterprise Linux 7 or CentOS 7 -============================================================================================= - -This document is a step by step procedure for upgrading from Scylla 2.1 to Scylla Enterprise 2018.1, and rollback to 2.1 if required. - - -Applicable versions -=================== -This guide covers upgrading Scylla from the following versions: 2.1.x to Scylla Enterprise version 2018.1.y, on the following platforms: - -* Red Hat Enterprise Linux, version 7 and later -* CentOS, version 7 and later -* No longer provide packages for Fedora - -Upgrade Procedure -================= - -.. include:: /upgrade/_common/warning.rst - -A Scylla upgrade is a rolling procedure which does not require full cluster shutdown. For each of the nodes in the cluster, serially (i.e. one at a time), you will: - -* Check cluster schema -* Drain node and backup the data -* 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 2018.1 features -* Not to run administration functions, like repairs, refresh, rebuild or add or remove nodes -* Not to apply schema changes - -Upgrade steps -============= -Check cluster schema --------------------- -Make sure that all nodes have the schema synched prior to upgrade, we won't survive an upgrade that has schema disagreement between nodes. - -.. code:: sh - - nodetool describecluster - -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 Scylla, 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 files --------------------------- -.. code:: sh - - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ); do sudo cp -v $conf $conf.backup-2.1; done - -Stop Scylla ------------ -.. code:: sh - - sudo systemctl stop scylla-server - -Download and install the new release ------------------------------------- -Before upgrading, check what version you are running now using ``rpm -qa | grep scylla-server``. You should use the same version in case you want to :ref:`rollback ` the upgrade. If you are not running a 2.1.x version, stop right here! This guide only covers 2.1.x to 2018.1.y upgrades. - -To upgrade: - -1. Update the `Scylla RPM Enterprise repo `_ to **2018.1** -2. install - -.. code:: sh - - sudo yum clean all - sudo rm -rf /var/cache/yum - sudo yum remove scylla\* - sudo yum install scylla-enterprise - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ); do sudo cp -v $conf.backup-2.1 $conf; done - -Start the node --------------- -.. code:: sh - - sudo systemctl start scylla-server - -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 scylla version. -3. Use ``journalctl _COMM=scylla`` to check there are no new errors in the log. -4. 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. - -* More on :doc:`Scylla Metrics Update - Scylla 2.1 to 2018.1` - -.. _upgrade-2.1-2018.1-rpm-rollback-procedure: - -Rollback Procedure -================== - -.. include:: /upgrade/_common/warning_rollback.rst - -The following procedure describes a rollback from Scylla Enterprise release 2018.1.x to 2.1.y. Apply this procedure if an upgrade from 2.1 to 2018.1 failed before completing on all nodes. Use this procedure only for nodes you upgraded to 2018.1 - -Scylla rollback is a rolling procedure which does **not** require full cluster shutdown. -For each of the nodes rollback to 2.1, you will: - -* Drain the node and stop Scylla -* Retrieve the old Scylla packages -* 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. - -Rollback steps -============== -Gracefully shutdown Scylla --------------------------- -.. code:: sh - - nodetool drain - sudo systemctl stop scylla-server - -Download and install the new release ------------------------------------- -1. Remove the old repo file. - -.. code:: sh - - sudo rm -rf /etc/yum.repos.d/scylla.repo - -2. Update the `Scylla RPM repo `_ to **2.1** -3. Install - -.. code:: sh - - sudo yum clean all - sudo yum remove scylla\* - sudo yum install scylla - -Restore the configuration file ------------------------------- - -.. code:: sh - - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ); do sudo cp -v $conf.backup-2.1 $conf; done - -Start the node --------------- - -.. code:: sh - - sudo systemctl start scylla-server - -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/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-ubuntu-16-04.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-ubuntu-16-04.rst deleted file mode 100644 index 27035c7574..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-ubuntu-16-04.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. |OS| replace:: Ubuntu 16.04 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-ubuntu-16-04/#rollback-procedure -.. |APT| replace:: Scylla deb repo -.. _APT: http://www.scylladb.com/download/ -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: http://www.scylladb.com/enterprise-download/ubuntu-16-04/ -.. |ENABLE_APT_REPO| replace:: sudo add-apt-repository -y ppa:openjdk-r/ppa -.. |JESSIE_BACKPORTS| replace:: openjdk-8-jre-headless -.. include:: /upgrade/_common/upgrade-guide-from-2.1-to-2018.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-ubuntu.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-ubuntu.rst deleted file mode 100644 index 910fb21074..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-ubuntu.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. |OS| replace:: Ubuntu 14.04 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-2.1-to-2018.1/upgrade-guide-from-2.1-to-2018.1-ubuntu/#rollback-procedure -.. |APT| replace:: Scylla deb repo -.. _APT: http://www.scylladb.com/download/ -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: http://www.scylladb.com/enterprise-download/ubuntu/ -.. |ENABLE_APT_REPO| replace:: sudo add-apt-repository -y ppa:openjdk-r/ppa -.. |JESSIE_BACKPORTS| replace:: openjdk-8-jre-headless -.. include:: /upgrade/_common/upgrade-guide-from-2.1-to-2018.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/index.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/index.rst deleted file mode 100644 index 2deddf5ca4..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/index.rst +++ /dev/null @@ -1,38 +0,0 @@ -================================================ -Upgrade - Scylla 3.0 to Scylla Enterprise 2019.1 -================================================ - -.. toctree:: - :titlesonly: - :hidden: - - Red Hat Enterprise Linux and CentOS - Ubuntu 16.04 - Ubuntu 14.04 - Debian - Metrics - - -.. raw:: html - - -
-
-
-
Upgrade Scylla Scylla 3.0 to Scylla Enterprise 2019.1
-
-
- -Upgrade guides are available for: - -* :doc:`Upgrade Scylla Enterprise from 3.0.x to 2019.1.y on Red Hat Enterprise Linux and CentOS ` -* :doc:`Upgrade Scylla Enterprise from 3.0.x to 2019.1.y on Ubuntu 16.04 ` -* :doc:`Upgrade Scylla Enterprise from 3.0.x to 2019.1.y on Ubuntu 18.04 ` -* :doc:`Upgrade Scylla Enterprise from 3.0.x to 2019.1.y on Debian ` -* :doc:`Scylla Metrics Update - Scylla 3.0 to 2019.1 ` - -.. raw:: html - -
-
-
diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/metric-update-3.0-to-2019.1.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/metric-update-3.0-to-2019.1.rst deleted file mode 100644 index 5370975111..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/metric-update-3.0-to-2019.1.rst +++ /dev/null @@ -1,87 +0,0 @@ -============================================================= -Scylla Metric Update - Scylla 3.0 to Scylla Enterprise 2019.1 -============================================================= - - -The following metrics are new in Scylla Enterprise 2019.1 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -* scylla_database_paused_reads -* scylla_database_paused_reads_permit_based_evictions -* scylla_database_total_view_updates_failed_local -* scylla_database_total_view_updates_failed_remote -* scylla_database_total_view_updates_pushed_local -* scylla_database_total_view_updates_pushed_remote -* scylla_database_view_building_paused -* scylla_hints_for_views_manager_corrupted_files -* scylla_hints_for_views_manager_discarded -* scylla_hints_manager_corrupted_files -* scylla_hints_manager_discarded -* scylla_query_processor_queries -* scylla_reactor_aio_errors -* scylla_sstables_capped_local_deletion_time -* scylla_sstables_capped_tombstone_deletion_time -* scylla_sstables_cell_tombstone_writes -* scylla_sstables_cell_writes -* scylla_sstables_partition_reads -* scylla_sstables_partition_seeks -* scylla_sstables_partition_writes -* scylla_sstables_range_partition_reads -* scylla_sstables_range_tombstone_writes -* scylla_sstables_row_reads -* scylla_sstables_row_writes -* scylla_sstables_single_partition_reads -* scylla_sstables_sstable_partition_reads -* scylla_sstables_static_row_writes -* scylla_sstables_tombstone_writes -* scylla_storage_proxy_coordinator_last_mv_flow_control_delay - -The following metrics names changes from Scylla 3.0 to Scylla Enterprise 2019.1 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. list-table:: - :widths: 30 30 - :header-rows: 1 - - * - Scylla 3.0 Name - - Scylla 2019.1 Name - * - scylla_io_queue_commitlog_delay - - scylla_io_queue_delay - * - scylla_io_queue_commitlog_queue_length - - scylla_io_queue_queue_length - * - scylla_io_queue_commitlog_shares - - scylla_io_queue_shares - * - scylla_io_queue_commitlog_total_bytes - - scylla_io_queue_total_bytes - * - scylla_io_queue_commitlog_total_operations - - scylla_io_queue_total_operations - * - scylla_io_queue_compaction_delay - - scylla_io_queue_delay - * - scylla_io_queue_compaction_queue_length - - scylla_io_queue_queue_length - * - scylla_io_queue_compaction_shares - - scylla_io_queue_shares - * - scylla_io_queue_compaction_total_bytes - - scylla_io_queue_total_bytes - * - scylla_io_queue_compaction_total_operations - - scylla_io_queue_total_operations - * - scylla_io_queue_default_delay - - scylla_io_queue_delay - * - scylla_io_queue_default_queue_length - - scylla_io_queue_queue_length - * - scylla_io_queue_default_shares - - scylla_io_queue_shares - * - scylla_io_queue_default_total_bytes - - scylla_io_queue_total_bytes - * - scylla_io_queue_default_total_operations - - scylla_io_queue_total_operations - * - scylla_io_queue_memtable_flush_delay - - scylla_io_queue_delay - * - scylla_io_queue_memtable_flush_queue_length - - scylla_io_queue_queue_length - * - scylla_io_queue_memtable_flush_shares - - scylla_io_queue_shares - * - scylla_io_queue_memtable_flush_total_bytes - - scylla_io_queue_total_bytes - * - scylla_io_queue_memtable_flush_total_operations - - scylla_io_queue_total_operations diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-debian.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-debian.rst deleted file mode 100644 index 9cdf6aea20..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-debian.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. |OS| replace:: Debian 9 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-debian/#rollback-procedure -.. |APT| replace:: Scylla deb repo -.. _APT: http://www.scylladb.com/download/?platform=debian-9 -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: http://www.scylladb.com/enterprise-download/debian9/ -.. include:: /upgrade/_common/upgrade-guide-from-3.0-to-2019.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-rpm.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-rpm.rst deleted file mode 100644 index 7da3c522ed..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-rpm.rst +++ /dev/null @@ -1,172 +0,0 @@ -============================================================================================= -Upgrade Guide - Scylla 3.0 to 2019.1 for Red Hat Enterprise Linux 7 or CentOS 7 -============================================================================================= - -This document is a step by step procedure for upgrading from Scylla 3.0 to Scylla Enterprise 2019.1, and rollback to 3.0 if required. - - -Applicable versions -=================== -This guide covers upgrading Scylla from the following versions: 3.0.x to Scylla Enterprise version 2019.1.y, on the following platforms: - -* Red Hat Enterprise Linux, version 7 and later -* CentOS, version 7 and later -* No longer provide packages for Fedora - -.. include:: /upgrade/_common/upgrade_to_2019_warning.rst - -Upgrade Procedure -================= - -.. include:: /upgrade/_common/warning.rst - -A Scylla upgrade is a rolling procedure which does not require full cluster shutdown. For each of the nodes in the cluster, serially (i.e. one at a time), you will: - -* Check cluster schema -* Drain node and backup the data -* 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.1 features -* Not to run administration functions, like repairs, refresh, rebuild or add or remove nodes. See `sctool `_ for suspending Scylla Manager scheduled or running repairs. -* Not to apply schema changes - -Upgrade steps -============= -Check cluster schema --------------------- -Make sure that all nodes have the schema synched prior to upgrade, we won't survive an upgrade that has schema disagreement between nodes. - -.. code:: sh - - nodetool describecluster - -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 Scylla, 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 files --------------------------- -.. code:: sh - - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ); do sudo cp -v $conf $conf.backup-3.0; done - -Stop Scylla ------------ -.. code:: sh - - sudo systemctl stop scylla-server - -Download and install the new release ------------------------------------- -Before upgrading, check what version you are running now using ``rpm -qa | grep scylla-server``. You should use the same version in case you want to :ref:`rollback ` the upgrade. If you are not running a 3.0.x version, stop right here! This guide only covers 3.0.x to 2019.1.y upgrades. - -To upgrade: - -1. Update the `Scylla RPM Enterprise repo `_ to **2019.1** -2. install - -.. code:: sh - - sudo yum clean all - sudo rm -rf /var/cache/yum - sudo yum remove scylla\* - sudo yum install scylla-enterprise - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ); do sudo cp -v $conf.backup-3.0 $conf; done - -Start the node --------------- -.. code:: sh - - sudo systemctl start scylla-server - -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 scylla version. -3. Use ``journalctl _COMM=scylla`` to check there are no new errors in the log. -4. 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. - -* More on :doc:`Scylla Metrics Update - Scylla 3.0 to 2019.1` - -.. _upgrade-3.0-2019.1-rpm-rollback-procedure: - -Rollback Procedure -================== - -.. include:: /upgrade/_common/warning_rollback.rst - -The following procedure describes a rollback from Scylla Enterprise release 2019.1.x to 3.0.y. Apply this procedure if an upgrade from 3.0 to 2019.1 failed before completing on all nodes. Use this procedure only for nodes you upgraded to 2019.1 - -Scylla rollback is a rolling procedure which does **not** require full cluster shutdown. -For each of the nodes rollback to 3.0, you will: - -* Drain the node and stop Scylla -* Retrieve the old Scylla packages -* 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. - -Rollback steps -============== -Gracefully shutdown Scylla --------------------------- -.. code:: sh - - nodetool drain - sudo systemctl stop scylla-server - -Download and install the new release ------------------------------------- -1. Remove the old repo file. - -.. code:: sh - - sudo rm -rf /etc/yum.repos.d/scylla.repo - -2. Update the `Scylla RPM repo `_ to **3.0** -3. Install - -.. code:: sh - - sudo yum clean all - sudo yum remove scylla\* - sudo yum install scylla - -Restore the configuration file ------------------------------- - -.. code:: sh - - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ); do sudo cp -v $conf.backup-3.0 $conf; done - -Start the node --------------- - -.. code:: sh - - sudo systemctl start scylla-server - -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/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-ubuntu-16-04.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-ubuntu-16-04.rst deleted file mode 100644 index 0af68ea9fb..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-ubuntu-16-04.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. |OS| replace:: Ubuntu 16.04 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-ubuntu-16-04/#rollback-procedure -.. |APT| replace:: Scylla deb repo -.. _APT: http://www.scylladb.com/download/ -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: http://www.scylladb.com/enterprise-download/ubuntu-16-04/ -.. include:: /upgrade/_common/upgrade-guide-from-3.0-to-2019.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-ubuntu-18-04.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-ubuntu-18-04.rst deleted file mode 100644 index ac8663ff77..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-ubuntu-18-04.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. |OS| replace:: Ubuntu 18.04 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-3.0-to-2019.1/upgrade-guide-from-3.0-to-2019.1-ubuntu-18-04/#id4 -.. |APT| replace:: Scylla deb repo -.. _APT: http://www.scylladb.com/download/ -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: http://www.scylladb.com/enterprise-download/ubuntu/ -.. include:: /upgrade/_common/upgrade-guide-from-3.0-to-2019.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/index.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/index.rst deleted file mode 100644 index 3afe783f71..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/index.rst +++ /dev/null @@ -1,38 +0,0 @@ -================================================ -Upgrade - Scylla 4.0 to Scylla Enterprise 2020.1 -================================================ - -.. toctree:: - :titlesonly: - :hidden: - - Red Hat Enterprise Linux and CentOS - Ubuntu 16.04 - Ubuntu 14.04 - Debian - Metrics - - -.. raw:: html - - -
-
-
-
Upgrade Scylla Scylla 4.0 to Scylla Enterprise 2020.1
-
-
- -Upgrade guides are available for: - -* :doc:`Upgrade Scylla Enterprise from 4.0.x to 2020.1.y on Red Hat Enterprise Linux and CentOS ` -* :doc:`Upgrade Scylla Enterprise from 4.0.x to 2020.1.y on Ubuntu 16.04 ` -* :doc:`Upgrade Scylla Enterprise from 4.0.x to 2020.1.y on Ubuntu 18.04 ` -* :doc:`Upgrade Scylla Enterprise from 4.0.x to 2020.1.y on Debian ` -* :doc:`Scylla Metrics Update - Scylla 4.0 to 2020.1 ` - -.. raw:: html - -
-
-
diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/metric-update-4.0-to-2020.1.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/metric-update-4.0-to-2020.1.rst deleted file mode 100644 index 3ddd619b62..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/metric-update-4.0-to-2020.1.rst +++ /dev/null @@ -1,16 +0,0 @@ -============================================================= -Scylla Metric Update - Scylla 4.0 to Scylla Enterprise 2019.1 -============================================================= - - -The following metrics are new in Scylla Enterprise 2020.1 compared to Scylla Open Source 4.0: - -* *scylla_storage_proxy_coordinator_cas_dropped_prune* : How many times a coordinator did not perform prune after cas -* *scylla_storage_proxy_coordinator_cas_prune* : How many times paxos prune was done after successful cas operation -* *scylla_storage_proxy_replica_cas_dropped_prune* : How many times a coordinator did not perform prune after cas - -The following metrics are not available in Scylla Enterprise 2020.1 compared to Scylla Open Source 4.0: - -* *scylla_thrift_current_connections* -* *scylla_thrift_served* -* *scylla_thrift_thrift_connections* diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/upgrade-guide-from-4.0-to-2020.1-debian.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/upgrade-guide-from-4.0-to-2020.1-debian.rst deleted file mode 100644 index 5df50c542d..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/upgrade-guide-from-4.0-to-2020.1-debian.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. |OS| replace:: Debian 9 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/upgrade-guide-from-4.0-to-2020.1-debian/#rollback-procedure -.. |APT| replace:: Scylla deb repo -.. _APT: http://www.scylladb.com/download/?platform=debian-9 -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: http://www.scylladb.com/enterprise-download/debian9/ -.. include:: /upgrade/_common/upgrade-guide-from-4.0-to-2020.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/upgrade-guide-from-4.0-to-2020.1-rpm.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/upgrade-guide-from-4.0-to-2020.1-rpm.rst deleted file mode 100644 index 3692baa16b..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/upgrade-guide-from-4.0-to-2020.1-rpm.rst +++ /dev/null @@ -1,172 +0,0 @@ -============================================================================================= -Upgrade Guide - Scylla 4.0 to 2020.1 for Red Hat Enterprise Linux 7 or CentOS 7 -============================================================================================= - -This document is a step by step procedure for upgrading from Scylla 4.0 to Scylla Enterprise 2020.1, and rollback to 4.0 if required. - - -Applicable versions -=================== -This guide covers upgrading Scylla from the following versions: 4.0.x to Scylla Enterprise version 2020.1.y, on the following platforms: - -* Red Hat Enterprise Linux, version 7 and later -* CentOS, version 7 and later -* No longer provide packages for Fedora - -.. include:: /upgrade/_common/upgrade_to_2020_warning.rst - -Upgrade Procedure -================= - -.. include:: /upgrade/_common/warning.rst - -A Scylla upgrade is a rolling procedure which does not require full cluster shutdown. For each of the nodes in the cluster, serially (i.e. one at a time), you will: - -* Check cluster schema -* Drain node and backup the data -* 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 2020.1 features -* Not to run administration functions, like repairs, refresh, rebuild or add or remove nodes. See `sctool `_ for suspending Scylla Manager scheduled or running repairs. -* Not to apply schema changes - -Upgrade steps -============= -Check cluster schema --------------------- -Make sure that all nodes have the schema synched prior to upgrade, we won't survive an upgrade that has schema disagreement between nodes. - -.. code:: sh - - nodetool describecluster - -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 Scylla, 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 files --------------------------- -.. code:: sh - - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ); do sudo cp -v $conf $conf.backup-4.0; done - -Stop Scylla ------------ -.. code:: sh - - sudo systemctl stop scylla-server - -Download and install the new release ------------------------------------- -Before upgrading, check what version you are running now using ``rpm -qa | grep scylla-server``. You should use the same version in case you want to :ref:`rollback ` the upgrade. If you are not running a 4.0.x version, stop right here! This guide only covers 4.0.x to 2020.1.y upgrades. - -To upgrade: - -1. Update the `Scylla RPM Enterprise repo `_ to **2020.1** -2. install - -.. code:: sh - - sudo yum clean all - sudo rm -rf /var/cache/yum - sudo yum remove scylla\* - sudo yum install scylla-enterprise - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ); do sudo cp -v $conf.backup-4.0 $conf; done - -Start the node --------------- -.. code:: sh - - sudo systemctl start scylla-server - -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 scylla version. -3. Use ``journalctl _COMM=scylla`` to check there are no new errors in the log. -4. 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. - -* More on :doc:`Scylla Metrics Update - Scylla 4.0 to 2020.1` - -.. _upgrade-4.0-2020.1-rpm-rollback-procedure: - -Rollback Procedure -================== - -.. include:: /upgrade/_common/warning_rollback.rst - -The following procedure describes a rollback from Scylla Enterprise release 2020.1.x to 4.0.y. Apply this procedure if an upgrade from 4.0 to 2020.1 failed before completing on all nodes. Use this procedure only for nodes you upgraded to 2020.1 - -Scylla rollback is a rolling procedure which does **not** require full cluster shutdown. -For each of the nodes rollback to 4.0, you will: - -* Drain the node and stop Scylla -* Retrieve the old Scylla packages -* 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. - -Rollback steps -============== -Gracefully shutdown Scylla --------------------------- -.. code:: sh - - nodetool drain - sudo systemctl stop scylla-server - -Download and install the new release ------------------------------------- -1. Remove the old repo file. - -.. code:: sh - - sudo rm -rf /etc/yum.repos.d/scylla.repo - -2. Update the `Scylla RPM repo `_ to **4.0** -3. Install - -.. code:: sh - - sudo yum clean all - sudo yum remove scylla\* - sudo yum install scylla - -Restore the configuration file ------------------------------- - -.. code:: sh - - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ); do sudo cp -v $conf.backup-4.0 $conf; done - -Start the node --------------- - -.. code:: sh - - sudo systemctl start scylla-server - -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/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/upgrade-guide-from-4.0-to-2020.1-ubuntu-16-04.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/upgrade-guide-from-4.0-to-2020.1-ubuntu-16-04.rst deleted file mode 100644 index d6cae6cfba..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/upgrade-guide-from-4.0-to-2020.1-ubuntu-16-04.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. |OS| replace:: Ubuntu 16.04 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2019.1/upgrade-guide-from-4.0-to-2020.1-ubuntu-16-04/#rollback-procedure -.. |APT| replace:: Scylla deb repo -.. _APT: http://www.scylladb.com/download/ -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: http://www.scylladb.com/enterprise-download/ubuntu-16-04/ -.. include:: /upgrade/_common/upgrade-guide-from-4.0-to-2020.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/upgrade-guide-from-4.0-to-2020.1-ubuntu-18-04.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/upgrade-guide-from-4.0-to-2020.1-ubuntu-18-04.rst deleted file mode 100644 index 3856a2d69c..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/upgrade-guide-from-4.0-to-2020.1-ubuntu-18-04.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. |OS| replace:: Ubuntu 18.04 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-4.0-to-2020.1/upgrade-guide-from-4.0-to-2020.1-ubuntu-18-04/#id4 -.. |APT| replace:: Scylla deb repo -.. _APT: http://www.scylladb.com/download/ -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: http://www.scylladb.com/enterprise-download/ubuntu/ -.. include:: /upgrade/_common/upgrade-guide-from-4.0-to-2020.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/index.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/index.rst deleted file mode 100644 index 1b6cdb7de4..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/index.rst +++ /dev/null @@ -1,42 +0,0 @@ -================================================ -Upgrade - Scylla 4.3 to Scylla Enterprise 2021.1 -================================================ - -.. toctree:: - :titlesonly: - :hidden: - - Red Hat Enterprise Linux and CentOS - Ubuntu 16.04 - Ubuntu 18.04 - Ubuntu 20.04 - Debian 9 - Debian 10 - Metrics - - -.. raw:: html - - -
-
-
-
Upgrade Scylla Scylla 4.3 to Scylla Enterprise 2021.1
-
-
- -Upgrade guides are available for: - -* :doc:`Upgrade Scylla Enterprise from 4.3.x to 2021.1.y on Red Hat Enterprise Linux and CentOS ` -* :doc:`Upgrade Scylla Enterprise from 4.3.x to 2021.1.y on Ubuntu 16.04 ` -* :doc:`Upgrade Scylla Enterprise from 4.3.x to 2021.1.y on Ubuntu 18.04 ` -* :doc:`Upgrade Scylla Enterprise from 4.3.x to 2021.1.y on Ubuntu 20.04 ` -* :doc:`Upgrade Scylla Enterprise from 4.3.x to 2021.1.y on Debian 9 ` -* :doc:`Upgrade Scylla Enterprise from 4.3.x to 2021.1.y on Debian 10 ` -* :doc:`Scylla Metrics Update - Scylla 4.3 to 2021.1 ` - -.. raw:: html - -
-
-
diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/metric-update-4.3-to-2021.1.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/metric-update-4.3-to-2021.1.rst deleted file mode 100644 index a3dbce2cd8..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/metric-update-4.3-to-2021.1.rst +++ /dev/null @@ -1,28 +0,0 @@ -============================================================= -Scylla Metric Update - Scylla 4.3 to Scylla Enterprise 2021.1 -============================================================= - - -The following metrics are new in Scylla Enterprise 2021.1 compared to Scylla Open Source 4.3: - -* scylla_storage_proxy_coordinator_background_replica_writes_failed_remote_node -* scylla_view_builder_steps_performed -* scylla_view_update_generator_queued_batches_count -* scylla_view_update_generator_sstables_to_move_count - -The following metrics are not available in Scylla Enterprise 2021.1 compared to Scylla Open Source 4.3: - -* scylla_node_maintenance_operations_bootstrap_finished_percentage -* scylla_node_maintenance_operations_decommission_finished_percentage -* scylla_node_maintenance_operations_rebuild_finished_percentage -* scylla_node_maintenance_operations_removenode_finished_percentage -* scylla_node_maintenance_operations_repair_finished_percentage -* scylla_node_maintenance_operations_replace_finished_percentage -* scylla_repair_row_from_disk_bytes -* scylla_repair_row_from_disk_nr -* scylla_repair_rx_hashes_nr -* scylla_repair_rx_row_bytes -* scylla_repair_rx_row_nr -* scylla_repair_tx_hashes_nr -* scylla_repair_tx_row_bytes -* scylla_repair_tx_row_nr diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-debian-10.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-debian-10.rst deleted file mode 100644 index 56a7c871fe..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-debian-10.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. |OS| replace:: Debian 10 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-debian-10/#rollback-procedure -.. |APT| replace:: Scylla deb repo -.. _APT: http://www.scylladb.com/download/?platform=debian-10&version=scylla-4.3 -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: https://www.scylladb.com/customer-portal/?product=ent&platform=debian-10&version=stable-release-2021.1 -.. include:: /upgrade/_common/upgrade-guide-from-4.3-to-2021.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-debian-9.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-debian-9.rst deleted file mode 100644 index 76805c6942..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-debian-9.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. |OS| replace:: Debian 9 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-debian/#rollback-procedure -.. |APT| replace:: Scylla deb repo -.. _APT: http://www.scylladb.com/download/?platform=debian-9&version=scylla-4.3 -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: https://www.scylladb.com/customer-portal/?product=ent&platform=debian-9&version=stable-release-2021.1 -.. include:: /upgrade/_common/upgrade-guide-from-4.3-to-2021.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-rpm.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-rpm.rst deleted file mode 100644 index b2d7ea16e7..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-rpm.rst +++ /dev/null @@ -1,192 +0,0 @@ -============================================================================================= -Upgrade Guide - Scylla 4.3 to 2021.1 for Red Hat Enterprise Linux 7 or CentOS 7 -============================================================================================= - -This document is a step by step procedure for upgrading from Scylla 4.3 to Scylla Enterprise 2021.1, and rollback to 4.3 if required. - - -Applicable versions -=================== -This guide covers upgrading Scylla from the following versions: 4.3.x to Scylla Enterprise version 2021.1.y, on the following platforms: - -* Red Hat Enterprise Linux, version 7 and later -* CentOS, version 7 and later -* No longer provide packages for Fedora - -.. include:: /upgrade/_common/upgrade_to_2020_warning.rst - -Upgrade Procedure -================= - -.. include:: /upgrade/_common/warning.rst - -A Scylla upgrade is a rolling procedure which does not require full cluster shutdown. For each of the nodes in the cluster, serially (i.e. one at a time), you will: - -* Check cluster schema -* Drain node and backup the data -* 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 2021.1 features -* Not to run administration functions, like repairs, refresh, rebuild or add or remove nodes. See `sctool `_ for suspending Scylla Manager scheduled or running repairs. -* Not to apply schema changes - -Upgrade steps -============= -Check cluster schema --------------------- -Make sure that all nodes have the schema synched prior to upgrade, we won't survive an upgrade that has schema disagreement between nodes. - -.. code:: sh - - nodetool describecluster - -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 Scylla, 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 files --------------------------- -.. code:: sh - - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ) /etc/systemd/system/{var-lib-scylla,var-lib-systemd-coredump}.mount; do sudo cp -v $conf $conf.backup-4.3; done - -Stop Scylla ------------ -.. code:: sh - - sudo systemctl stop scylla-server - -Download and install the new release ------------------------------------- -Before upgrading, check what version you are running now using ``rpm -qa scylla\*server``. You should use the same version in case you want to :ref:`rollback ` the upgrade. If you are not running a 4.3.x version, stop right here! This guide only covers 4.3.x to 2021.1.y upgrades. - -To upgrade: - -1. Update the `Scylla RPM Enterprise repo `_ to **2021.1** -2. install - -.. code:: sh - - sudo yum clean all - sudo rm -rf /var/cache/yum - sudo yum remove scylla\* - sudo yum install scylla-enterprise - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ) /etc/systemd/system/{var-lib-scylla,var-lib-systemd-coredump}.mount; do sudo cp -v $conf.backup-4.3 $conf; done - -Start the node --------------- - -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. - -.. code:: sh - - sudo scylla_io_setup - -.. code:: sh - - sudo systemctl start scylla-server - -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 scylla version. -3. Use ``journalctl _COMM=scylla`` to check there are no new errors in the log. -4. 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. - -* More on :doc:`Scylla Metrics Update - Scylla 4.3 to 2021.1` - -.. _upgrade-4.3-2021.1-rpm-rollback-procedure: - -Rollback Procedure -================== - -.. include:: /upgrade/_common/warning_rollback.rst - -The following procedure describes a rollback from Scylla Enterprise release 2021.1.x to 4.3.y. Apply this procedure if an upgrade from 4.3 to 2021.1 failed before completing on all nodes. Use this procedure only for nodes you upgraded to 2021.1 - -Scylla rollback is a rolling procedure which does **not** require full cluster shutdown. -For each of the nodes rollback to 4.3, you will: - -* Drain the node and stop Scylla -* Retrieve the old Scylla packages -* 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. - -Rollback steps -============== -Gracefully shutdown Scylla --------------------------- -.. code:: sh - - nodetool drain - sudo systemctl stop scylla-server - -Download and install the new release ------------------------------------- -1. Remove the old repo file. - -.. code:: sh - - sudo rm -rf /etc/yum.repos.d/scylla.repo - -2. Update the `Scylla RPM repo `_ to **4.3** -3. Install - -.. code:: sh - - sudo yum clean all - sudo yum remove scylla\* - sudo yum install scylla - -Restore the configuration file ------------------------------- - -.. code:: sh - - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ) /etc/systemd/system/{var-lib-scylla,var-lib-systemd-coredump}.mount; do sudo cp -v $conf.backup-4.3 $conf; done - -Restore system tables ---------------------- - -Restore all tables of **system** and **system_schema** from the previous snapshot because 2021.1 uses a different set of system tables. See :doc:`Restore from a Backup and Incremental Backup ` for reference. - -.. code:: console - - cd /var/lib/scylla/data/keyspace_name/table_name-UUID/ - sudo find . -maxdepth 1 -type f -exec sudo rm -f "{}" + - cd /var/lib/scylla/data/keyspace_name/table_name-UUID/snapshots// - 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 --------------- - -.. code:: sh - - sudo systemctl start scylla-server - -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/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-ubuntu-16-04.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-ubuntu-16-04.rst deleted file mode 100644 index f6e3a64fbe..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-ubuntu-16-04.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. |OS| replace:: Ubuntu 16.04 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-ubuntu-16-04/#rollback-procedure -.. |APT| replace:: Scylla deb repo -.. _APT: https://www.scylladb.com/download/?platform=ubuntu-16.04&version=scylla-4.3 -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: https://www.scylladb.com/customer-portal/?product=ent&platform=ubuntu-16.04&version=stable-release-2021.1 -.. include:: /upgrade/_common/upgrade-guide-from-4.3-to-2021.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-ubuntu-18-04.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-ubuntu-18-04.rst deleted file mode 100644 index 3290e87e84..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-ubuntu-18-04.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. |OS| replace:: Ubuntu 18.04 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-ubuntu-18-04/#id4 -.. |APT| replace:: Scylla deb repo -.. _APT: https://www.scylladb.com/download/?platform=ubuntu-16.04&version=scylla-4.3 -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: https://www.scylladb.com/customer-portal/?product=ent&platform=ubuntu-18.04&version=stable-release-2021.1 -.. include:: /upgrade/_common/upgrade-guide-from-4.3-to-2021.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-ubuntu-20-04.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-ubuntu-20-04.rst deleted file mode 100644 index 4c546bb499..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-ubuntu-20-04.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. |OS| replace:: Ubuntu 20.04 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-4.3-to-2021.1/upgrade-guide-from-4.3-to-2021.1-ubuntu-20-04/#id4 -.. |APT| replace:: Scylla deb repo -.. _APT: http://www.scylladb.com/download/ -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: https://www.scylladb.com/customer-portal/?product=ent&platform=ubuntu-20.04&version=stable-release-2021.1 -.. include:: /upgrade/_common/upgrade-guide-from-4.3-to-2021.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/index.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/index.rst deleted file mode 100644 index ca1accd226..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/index.rst +++ /dev/null @@ -1,36 +0,0 @@ -====================================================== -Upgrade - ScyllaDB 5.0 to ScyllaDB Enterprise 2022.1 -====================================================== - -.. toctree:: - :titlesonly: - :hidden: - - Red Hat Enterprise Linux and CentOS - Ubuntu - Debian 10 - Metrics - - -.. raw:: html - - -
-
-
-
Upgrade ScyllaDB 5.0 to ScyllaDB Enterprise 2022.1
-
-
- -Upgrade guides are available for: - -* :doc:`Upgrade ScyllaDB Enterprise from 5.0.x to 2022.1.y on Red Hat Enterprise Linux and CentOS ` -* :doc:`Upgrade ScyllaDB Enterprise from 5.0.x to 2022.1.y on Ubuntu ` -* :doc:`Upgrade ScyllaDB Enterprise from 5.0.x to 2022.1.y on Debian 10 ` -* :doc:`ScyllaDB Metrics Update - ScyllaDB 5.0 to 2022.1 ` - -.. raw:: html - -
-
-
diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/metric-update-5.0-to-2022.1.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/metric-update-5.0-to-2022.1.rst deleted file mode 100644 index b87c7ad46b..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/metric-update-5.0-to-2022.1.rst +++ /dev/null @@ -1,5 +0,0 @@ -================================================================= -ScyllaDB Metric Update - Scylla 5.0 to Scylla Enterprise 2022.1 -================================================================= - -There are no metric updates in ScyllaDB Enterprise 2022.1 compared to ScyllaDB 5.0. diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/upgrade-guide-from-5.0-to-2022.1-debian-10.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/upgrade-guide-from-5.0-to-2022.1-debian-10.rst deleted file mode 100644 index f54266270b..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/upgrade-guide-from-5.0-to-2022.1-debian-10.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. |OS| replace:: Debian 10 -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/upgrade-guide-from-5.0-to-2022.1-debian-10/#rollback-procedure -.. |APT| replace:: ScyllaDB deb repo -.. _APT: http://www.scylladb.com/download/?platform=debian-10&version=scylla-5.0 -.. |APT_ENTERPRISE| replace:: ScyllaDB Enterprise Deb repo -.. _APT_ENTERPRISE: https://www.scylladb.com/customer-portal/?product=ent&platform=debian-10&version=stable-release-2022.1 -.. include:: /upgrade/_common/upgrade-guide-from-5.0-to-2022.1-ubuntu-and-debian.rst diff --git a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/upgrade-guide-from-5.0-to-2022.1-rpm.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/upgrade-guide-from-5.0-to-2022.1-rpm.rst deleted file mode 100644 index 447055681a..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/upgrade-guide-from-5.0-to-2022.1-rpm.rst +++ /dev/null @@ -1,197 +0,0 @@ -============================================================================================= -Upgrade Guide - ScyllaDB 5.0 to 2022.1 for Red Hat Enterprise Linux 7/8 or CentOS 7/8 -============================================================================================= - -This document is a step-by-step procedure for upgrading from ScyllaDB 5.0 to ScyllaDB Enterprise 2022.1 and rollback to 5.0 if required. - - -Applicable Versions -=================== -This guide covers upgrading ScyllaDB from version 5.0.x to ScyllaDB Enterprise version 2022.1.y, on the following platforms: - -* Red Hat Enterprise Linux 7 and 8 -* CentOS 7 and 8 - -Packages for Fedora are no longer provided. - - -Upgrade Procedure -================= - -A ScyllaDB upgrade is a rolling procedure that does not require a full cluster shutdown. For each of the nodes in the cluster, serially (i.e. one at a time), you will: - -* Check the cluster schema -* Drain the node and backup the data -* Backup the configuration file -* Stop ScyllaDB -* Download and install new ScyllaDB packages -* Start ScyllaDB -* Validate that the upgrade was successful - -Apply the following procedure **serially** on each node. Do not move to the next node before validating that the node is up and running the new version. - -**During** the rolling upgrade, it is highly recommended: - -* Not to use new 2022.1 features. -* Not to run administration functions, like repairs, refresh, rebuild or add or remove nodes. See `sctool `_ for suspending Scylla Manager scheduled or running repairs. -* Not to apply schema changes. - -Upgrade Steps -============= - -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. - -.. code:: sh - - nodetool describecluster - -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 completed on all nodes, the snapshot should be removed with the ``nodetool clearsnapshot -t `` command, or you risk running out of space. - -Backup the configuration files --------------------------------- -.. code:: sh - - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ) /etc/systemd/system/{var-lib-scylla,var-lib-systemd-coredump}.mount; do sudo cp -v $conf $conf.backup-5.0; done - -Stop ScyllaDB --------------- -.. code:: sh - - sudo systemctl stop scylla-server - -Download and install the new release ------------------------------------- -Before upgrading, check what version you are running now using ``rpm -qa scylla\*server``. You should use the same version in case you want to :ref:`rollback ` the upgrade. If you are not running a 5.0.x version, stop right here! This guide only covers 5.0.x to 2022.1.y upgrades. - -To upgrade: - -#. Update the `ScyllaDB RPM Enterprise repo `_ to **2022.1**. -#. Install: - - .. code:: sh - - sudo yum clean all - sudo rm -rf /var/cache/yum - sudo yum remove scylla\* - sudo yum install scylla-enterprise - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ) /etc/systemd/system/{var-lib-scylla,var-lib-systemd-coredump}.mount; do sudo cp -v $conf.backup-5.0 $conf; done - - If you use a cloud image with a preinstalled version of ScyllaDB (for example, AMI), you need to install an additional - package ``scylla-enterprise-machine-image`` with the ``sudo yum install scylla-enterprise-machine-image`` command. - -Start the node --------------- - -A new io.conf format was introduced in ScyllaDB 2.3 and 2019.1. If your io.conf doesn't contain the `--io-properties-file` option, then it's still the old format. You need to re-run the io setup to generate a new io.conf. - -.. code:: sh - - sudo scylla_io_setup - -.. code:: sh - - sudo systemctl start scylla-server - -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. -#. Use ``journalctl _COMM=scylla`` to check there are no new errors in the log. -#. 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. - -More on :doc:`ScyllaDB Metrics Update - ScyllaDB 5.0 to 2023.1` - -.. _upgrade-5.0-2022.1-rpm-rollback-procedure: - -Rollback Procedure -================== - -.. include:: /upgrade/_common/warning_rollback.rst - -The following procedure describes a rollback from ScyllaDB Enterprise release 2022.1.x to 5.0.y. Apply this procedure if an upgrade from 5.0 to 2022.1 failed before completing on all nodes. Use this procedure only for nodes you upgraded to 2022.1. - -ScyllaDB rollback is a rolling procedure that does **not** require a full cluster shutdown. -For each of the nodes to rollback to 5.0, you will: - -* Drain the node and stop ScyllaDB -* Retrieve the old ScyllaDB packages -* 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 that the node you upgraded is up and running the new version. - -Rollback Steps -============== -Gracefully shutdown ScyllaDB ------------------------------- - - .. code:: sh - - nodetool drain - sudo systemctl stop scylla-server - -Download and install the new release ------------------------------------- - -#. Remove the old repo file. - - .. code:: sh - - sudo rm -rf /etc/yum.repos.d/scylla.repo - -#. Update the `ScyllaDB RPM repo `_ to **5.0**. -#. Install: - - .. code:: sh - - sudo yum clean all - sudo yum remove scylla\* - sudo yum install scylla - -Restore the configuration file ------------------------------- - -.. code:: sh - - for conf in $( rpm -qc $(rpm -qa | grep scylla) | grep -v contains ) /etc/systemd/system/{var-lib-scylla,var-lib-systemd-coredump}.mount; do sudo cp -v $conf.backup-5.0 $conf; done - -Restore system tables ---------------------- - -Restore all tables of **system** and **system_schema** from the previous snapshot because 2022.1 uses a different set of system tables. See :doc:`Restore from a Backup and Incremental Backup ` for reference. - -.. code:: console - - cd /var/lib/scylla/data/keyspace_name/table_name-UUID/ - sudo find . -maxdepth 1 -type f -exec sudo rm -f "{}" + - cd /var/lib/scylla/data/keyspace_name/table_name-UUID/snapshots// - 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 --------------- - -.. code:: sh - - sudo systemctl start scylla-server - -Validate --------- -Check the 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/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/upgrade-guide-from-5.0-to-2022.1-ubuntu.rst b/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/upgrade-guide-from-5.0-to-2022.1-ubuntu.rst deleted file mode 100644 index fbc0a94789..0000000000 --- a/docs/upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/upgrade-guide-from-5.0-to-2022.1-ubuntu.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. |OS| replace:: Ubuntu -.. |ROLLBACK| replace:: rollback -.. _ROLLBACK: /upgrade/upgrade-to-enterprise/upgrade-guide-from-5.0-to-2022.1/upgrade-guide-from-5.0-to-2022.1-ubuntu/#rollback-procedure -.. |APT| replace:: ScyllaDB deb repo -.. _APT: http://www.scylladb.com/download/ -.. |APT_ENTERPRISE| replace:: Scylla Enterprise Deb repo -.. _APT_ENTERPRISE: https://www.scylladb.com/customer-portal/?product=ent&platform=ubuntu-20.04&version=stable-release-2022.1 -.. include:: /upgrade/_common/upgrade-guide-from-5.0-to-2022.1-ubuntu-and-debian.rst