doc(lep): update system backup lep for backup bacingimages

ref: longhorn/longhorn 5085 Signed-off-by: Jack Lin <jack.lin@suse.com>
longhorn · Apr 18, 2024 · 17d37d6 · 17d37d6
1 parent c9bd730
commit 17d37d6
Showing 1 changed file with 11 additions and 5 deletions.
diff --git a/enhancements/20220913-longhorn-system-backup-restore.md b/enhancements/20220913-longhorn-system-backup-restore.md
@@ -89,12 +89,13 @@ https://github.com/longhorn/longhorn/issues/1455
 
 ```
 
-                                            [ system-backup.zip ]   [ backups ]]]
+                                            [ system-backup.zip ]   [ backups ]
                                                             ^          ^
                                                             |          |
             [ system-backup.cfg ] <-- backupstore/system-backups/...   |
                                                             |          |
                                                             |       backupstore/volumes/
+                                                            |       backupstore/backing-images/
                                                             |          |
                                                             |          |
 [ SystemRestore ] ---> [[ longhorn-system-restore ]] ---> [ object-store ]
@@ -109,9 +110,9 @@ https://github.com/longhorn/longhorn/issues/1455
                                                             |          |
                                                             |          v               
                                                             | <--- [ Volume: from backup ]
-                                                            |
-                                                           V
-                                                    [ Resources ]]]]
+                                                            | <--- [ BackingImage: from backup]
+                                                            V
+                                                    [ Resources ]
 ```
 
 1. Introduce new [v1/systemrestores](#longhorn-manager-http-api) HTTP APIs.
@@ -380,6 +381,7 @@ system-backup.zip
     + recurringjobs.yaml
     + settings.yaml
     + volumes.yaml
+    + backingimages.yaml
 ```
 1. Create metadata file.
     ```golang
@@ -392,6 +394,8 @@ system-backup.zip
     	ManagerImage           string      `json:"managerImage"`
     }
     ```
+1. Backup the Volumes to the backup target.
+1. Backup the BackingImages to the backup target after the Volumes. We only backup those BackingImages not being used in this stage because we already backup the BackingImages used by the Volumes when backing up the Volumes automatically. 
 1. Generated the resource YAML files:
    <a name="system-backup-resources"></a>
    1. Generate the API extension resource YAML file.
@@ -415,6 +419,7 @@ system-backup.zip
       - Longhorn EngineImages.
       - Longhorn Volumes.
       - Longhorn RecurringJobs.
+      - Longhorn BackingImages.
 1. Archive the files to a zip file.
 1. Execute engine binary [system-backup upload](#engine-commands) to upload to the backup target
    `backupstore/system-backups/<longhorn-version>/<system-backup-name>`.
@@ -582,11 +587,12 @@ spec:
     - Deployments.
     - DaemonSets.
     - EngineImages.
-    - Volumes. Annotate with `longhorn.io/last-system-restore-backup` if the volume is restored from the backup.
+    - BackingImages
     - StorageClasses.
     - PersistentVolumes.
     - PersistentVolumeClaims.
     - RecurringJobs.
+1. Restore Volumes after all resources are restored because Volumes with BackingImages needs to wait until BackingImages are restored. Annotate with `longhorn.io/last-system-restore-backup` if the volume is restored from the backup.
 1. Update [SystemRestore](#manager-systemrestore-custom-resource) status and error.
 1. Shutdown longhorn-system-rollout controller.