Skip to content

Commit 12df045

Browse files
feat(docs): add workaround for restoring raft schema
1 parent f9dd9c9 commit 12df045

File tree

3 files changed

+22
-3
lines changed

3 files changed

+22
-3
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. warning:: Restoring schema into a cluster with ScyllaDB **5.4.X** or **2024.1.X** with ``consistent_cluster_management: true`` isn't supported. Please see the following :ref:`workaround <restore-schema-workaround>`.

docs/source/restore/compatibility-matrix.rst

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ Compatibility Matrix
33

44
The following table shows which version of Scylla Manager restore task supports which versions of Scylla.
55

6+
.. include:: _common/restore-raft-schema-warn.rst
67

78
.. list-table::
89
:widths: 25 25 25

docs/source/restore/restore-schema.rst

+20-3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Restore schema
66

77
.. note:: Because of small size of schema files, resuming schema restoration always starts from scratch.
88

9+
.. include:: _common/restore-raft-schema-warn.rst
10+
911
In order to restore Scylla cluster schema use :ref:`sctool restore <sctool-restore>` with ``--restore-schema`` flag.
1012

1113
Prerequisites
@@ -25,8 +27,10 @@ After successful restore it is important to perform necessary follow-up action.
2527
you should make a `rolling restart <https://docs.scylladb.com/stable/operating-scylla/procedures/config-change/rolling-restart.html>`_ of an entire cluster.
2628
Without the restart, the restored schema might not be visible, and querying it can return various errors.
2729

28-
Process
29-
=======
30+
Procedure
31+
=========
32+
33+
This section contains a description of the restore-schema procedure performed by ScyllaDB Manager.
3034

3135
Because of being unable to alter schema tables ``tombstone_gc`` option, restore procedure "simulates ad-hoc repair"
3236
by duplicating data from **each backed-up node into each node** in restore destination cluster.
@@ -47,4 +51,17 @@ Fortunately, the small size of schema files makes this overhead negligible.
4751
* Download all SSTables
4852
* For all nodes in restore destination cluster:
4953

50-
* `nodetool refresh <https://docs.scylladb.com/stable/operating-scylla/nodetool-commands/refresh.html#nodetool-refresh>`_ on all downloaded schema tables (full parallel)
54+
* `nodetool refresh <https://docs.scylladb.com/stable/operating-scylla/nodetool-commands/refresh.html#nodetool-refresh>`_ on all downloaded schema tables (full parallel)
55+
56+
.. _restore-schema-workaround:
57+
58+
Restoring schema into a cluster with ScyllaDB **5.4.X** or **2024.1.X** with **consistent_cluster_management**
59+
==============================================================================================================
60+
61+
Restoring schema when using ScyllaDB **5.4.X** or **2024.1.X** with ``consistent_cluster_management: true`` in ``scylla.yaml``
62+
is not supported. In such case, you should perform the following workaround:
63+
64+
* Create a fresh cluster with ``consistent_cluster_management: false`` configured in ``scylla.yaml`` and a desired ScyllaDB version.
65+
* Restore schema via :ref:`sctool restore <sctool-restore>` with ``--restore-schema`` flag.
66+
* Perform `rolling restart <https://docs.scylladb.com/stable/operating-scylla/procedures/config-change/rolling-restart.html>`_ of an entire cluster.
67+
* Follow the steps of the `Enable Raft procedure <https://opensource.docs.scylladb.com/stable/architecture/raft.html#enabling-raft>`_.

0 commit comments

Comments
 (0)