Skip to content

Commit 1b7dc91

Browse files
authored
chore(docs): how to avoid restore and backup/repair task interference (#4124)
This documents how to prevent interference between restore and backup/repair tasks. Fixes: #3742
1 parent 76e7b6d commit 1b7dc91

File tree

3 files changed

+14
-13
lines changed

3 files changed

+14
-13
lines changed

docs/source/restore/index.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,15 @@ and :ref:`resume <task-start>` it.
8989
Interference with backup and repair tasks
9090
=========================================
9191

92-
It is advisable to manually make sure that the restore task does not interfere with backup or repair tasks.
93-
94-
#. Do not start backup or repair tasks when restore task is running.
95-
#. If scheduled runs of backup or repair tasks can interfier with restore task, then disable them until restore is complete::
96-
97-
# check Next column to determine when next run of a task is scheduled
98-
$ sctool tasks -a
99-
100-
# disable repair/backup tasks if needed
101-
$ sctool repair update -c CLUSTER-ID SCHEDULED-REPAIR-TASK-ID --enabled=false
102-
$ sctool backup update -c CLUSTER-ID SCHEDULED-BACKUP-TASK-ID --enabled=false
92+
The restore task will not start if backup or repair tasks are running in the cluster at that time, and vice versa, if a restore task is running, backup or repair tasks will not start.
93+
You will see an error in the output of the ``sctool tasks`` command if there is a conflict between tasks.
94+
Here is an example output of ``sctool progress -c ${cluster_name} {task_id}`` when there is an interference between tasks::
95+
96+
$ ./sctool.dev progress -c my-cluster backup/06cd5d90-6daa-4215-acd3-d19f6782b5b6
97+
Run: 351378ee-ab05-11ef-aa2d-0242c0a8c802
98+
Status: ERROR (initialising)
99+
Cause: exclusive task (restore) is running: another task is running
100+
Start time: 25 Nov 24 09:13:52 CET
101+
End time: 25 Nov 24 09:13:52 CET
102+
Duration: 0s
103+
Progress: -

docs/source/sctool/partials/sctool_repair.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ options:
129129
usage: |
130130
Prints table names together with keyspace, used in combination with --dry-run.
131131
- name: small-table-threshold
132-
default_value: 1G
132+
default_value: 1GiB
133133
usage: |
134134
Enables small table optimization for tables of size lower than given threshold, supported units [B, M, G, T].
135135
- name: start-date

docs/source/sctool/partials/sctool_repair_update.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ options:
130130
usage: |
131131
Prints table names together with keyspace, used in combination with --dry-run.
132132
- name: small-table-threshold
133-
default_value: 1G
133+
default_value: 1GiB
134134
usage: |
135135
Enables small table optimization for tables of size lower than given threshold, supported units [B, M, G, T].
136136
- name: start-date

0 commit comments

Comments
 (0)