feat(docs): adds info about restore and backup/repair tasks interference #4124
Conversation
This extends restore procedure docs with how to avoid conflicts between restore and backup/repair tasks in a cluster. Refs: #3742
VAveryanov8
requested review from
karol-kokoszka and
Michal-Leszczynski
as code owners
|
I'm not sure which SM version will contain changes made in #4122, so I've put 3.5 version in the docs temporarily. |
| Starting from Scylla Manager v3.5.0, the restore task will not start if backup or repair tasks are running in the cluster at that time, and vice versa, if backup or repair tasks are running, the restore task will not start. | ||
|
|
||
| Prior to 3.5.0, it is advisable to manually make sure that the restore task does not interfere with backup or repair tasks. |
There was a problem hiding this comment.
SM docs are versioned per minor version, so there is no need to write things like "starting from version".
On the other hand, I see that you wanted to document previous behavior as well.
So the proper way of handling this would be to create 2 separate PRs:
- one adding docs about current state (merged to master and branch-3.4)
- one updating docs with new functionality description (rebased on the first one, merged to master)
3.5 is a good candidate - we shouldn't put it into 3.4.1 as this is a feature. |
|
For docs oriented PRs, It's always good to request a review from someone from the product team (e.g. @annastuchlik). They don't always have the time to go through it, so not all docs related PRs need their approval. |
This extends restore procedure docs with how to avoid conflicts between restore and backup/repair tasks in a cluster.
Fixes: #3742
Please make sure that: