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

add design doc about restore processes #28

Merged
merged 2 commits into from
Jul 11, 2024
+96 −27
Merged

add design doc about restore processes #28

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8dac5d
add design doc about restore processes
llamerada-jp Jul 10, 2024
c39b660
Apply suggestions from code review
llamerada-jp Jul 11, 2024
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
Prev Previous commit
Loading
Loading status checks…
Apply suggestions from code review 
Co-authored-by: Satoru Takeuchi <[email protected]>
@llamerada-jp @satoru-takeuchi
llamerada-jp and satoru-takeuchi committed Jul 11, 2024
commit c39b66063809b766767f45e603ef25f41b736181
12 changes: 6 additions & 6 deletions docs/design.md
View file
Original file line number Diff line number Diff line change
@@ -150,18 +150,18 @@ spec:
Precondition: Process will not start until conditions are met.
- The target MantleBackup must exist and be ready to use.

1. Users crate a `MantleRestore` resource.
1. Users create a `MantleRestore` resource.
2. The controller gets the target MantleBackup from the `MantleRestore` resource.
3. The controller stores the pool name for the `status.pool` field and cluster ID for the `status.clusterID` field. This value is used to remove the restored PV/PVC when the MantleRestore resource is deleted.
4. The controller gets backup target RBD snap image name from the MantleBackup.
5. The controller creates a new RBD clone from the RBD snap image.
6. The controller creates a new PV/PVC using the new RBD clone.
4. The controller gets backup target RBD snapshot name from the MantleBackup.
5. The controller creates a new RBD clone image from the RBD snapshot.
6. The controller creates a new PV/PVC using the above-mentioned RBD clone image.

### Cleanup restore flow

1. Users delete the `MantleRestore` resource.
2. The controller tries to delete the PV/PVC created by the `MantleRestore` resource and wait until the PV/PVC is deleted. If the PV/PVC is used by some pod.
3. The controller removes the RBD clone created by the `MantleRestore` resource. The controller should not remove RBD clone volume specified by the PV.
2. The controller tries to delete the PV/PVC created by the `MantleRestore` resource and wait until the Pod consuming the PV/PVC are stopped and deleted.
3. The controller removes the RBD clone image created by the `MantleRestore` resource. However, the controller should not remove the RBD clone image if the previous step is not completed and a PV/PVC exists.

#### The manifest to get restore PV/PVC from a backup