Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adds info about restore and backup/repair tasks interference #4124

Merged
merged 1 commit into from
Dec 11, 2024
Merged

docs: adds info about restore and backup/repair tasks interference #4124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions docs/source/restore/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,14 +89,15 @@ and :ref:`resume <task-start>` it.
Interference with backup and repair tasks
=========================================

It is advisable to manually make sure that the restore task does not interfere with backup or repair tasks.

#. Do not start backup or repair tasks when restore task is running.
#. If scheduled runs of backup or repair tasks can interfier with restore task, then disable them until restore is complete::

# check Next column to determine when next run of a task is scheduled
$ sctool tasks -a

# disable repair/backup tasks if needed
$ sctool repair update -c CLUSTER-ID SCHEDULED-REPAIR-TASK-ID --enabled=false
$ sctool backup update -c CLUSTER-ID SCHEDULED-BACKUP-TASK-ID --enabled=false
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.
You will see an error in the output of the ``sctool tasks`` command if there is a conflict between tasks.
Here is an example output of ``sctool progress -c ${cluster_name} {task_id}`` when there is an interference between tasks::

$ ./sctool.dev progress -c my-cluster backup/06cd5d90-6daa-4215-acd3-d19f6782b5b6
Run: 351378ee-ab05-11ef-aa2d-0242c0a8c802
Status: ERROR (initialising)
Cause: exclusive task (restore) is running: another task is running
Start time: 25 Nov 24 09:13:52 CET
End time: 25 Nov 24 09:13:52 CET
Duration: 0s
Progress: -
2 changes: 1 addition & 1 deletion docs/source/sctool/partials/sctool_repair.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ options:
usage: |
Prints table names together with keyspace, used in combination with --dry-run.
- name: small-table-threshold
default_value: 1G
default_value: 1GiB
usage: |
Enables small table optimization for tables of size lower than given threshold, supported units [B, M, G, T].
- name: start-date
Expand Down
2 changes: 1 addition & 1 deletion docs/source/sctool/partials/sctool_repair_update.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ options:
usage: |
Prints table names together with keyspace, used in combination with --dry-run.
- name: small-table-threshold
default_value: 1G
default_value: 1GiB
usage: |
Enables small table optimization for tables of size lower than given threshold, supported units [B, M, G, T].
- name: start-date
Expand Down
Loading