feat: remove lh snapshots when users delete backup

Signed-off-by: PoAn Yang <[email protected]>

controller/backup_controller.go

@@ -317,6 +317,31 @@ func (bc *BackupController) reconcile(backupName string) (err error) {
 			bc.eventRecorder.Eventf(backup, corev1.EventTypeWarning, string(backup.Status.State), "Failed backup %s has been deleted: %s", backup.Name, backup.Status.Error)
 		}
 
+		autocleanup, err := bc.ds.GetSettingAsBool(types.SettingNameAutoCleanupSnapshotWhenDeleteBackup)
+		if err != nil {
+			logrus.WithError(err).WithFields(logrus.Fields{
+				"name": types.SettingNameAutoCleanupSnapshotWhenDeleteBackup,
+			}).Warn("Failed to get the setting")
+		}
+		if autocleanup {
+			// do the best effort to delete the snapshot
+			snapshot, err := bc.ds.GetSnapshotRO(backup.Spec.SnapshotName)
+			if err != nil {
+				if !apierrors.IsNotFound(err) {
+					logrus.WithError(err).WithFields(logrus.Fields{
+						"backup":   backup.Name,
+						"snapshot": snapshot.Name,
+					}).Warn("Failed to get snapshot")
+				}
+				return nil
+			}
+			if err = bc.ds.DeleteSnapshot(snapshot.Name); err != nil {
+				logrus.WithError(err).WithFields(logrus.Fields{
+					"backup":   backup.Name,
+					"snapshot": snapshot.Name,
+				}).Warn("Failed to delete snapshot")
+			}
+		}
 		return bc.ds.RemoveFinalizerForBackup(backup)
 	}
 

types/setting.go

@@ -131,6 +131,7 @@ const (
 	SettingNameV2DataEngineLogLevel                                     = SettingName("v2-data-engine-log-level")
 	SettingNameV2DataEngineLogFlags                                     = SettingName("v2-data-engine-log-flags")
 	SettingNameFreezeFilesystemForSnapshot                              = SettingName("freeze-filesystem-for-snapshot")
+	SettingNameAutoCleanupSnapshotWhenDeleteBackup                      = SettingName("auto-cleanup-when-delete-backup")
 )
 
 var (
@@ -218,6 +219,7 @@ var (
 		SettingNameAllowEmptyDiskSelectorVolume,
 		SettingNameDisableSnapshotPurge,
 		SettingNameFreezeFilesystemForSnapshot,
+		SettingNameAutoCleanupSnapshotWhenDeleteBackup,
 	}
 )
 
@@ -333,6 +335,7 @@ var (
 		SettingNameAllowEmptyDiskSelectorVolume:                             SettingDefinitionAllowEmptyDiskSelectorVolume,
 		SettingNameDisableSnapshotPurge:                                     SettingDefinitionDisableSnapshotPurge,
 		SettingNameFreezeFilesystemForSnapshot:                              SettingDefinitionFreezeFilesystemForSnapshot,
+		SettingNameAutoCleanupSnapshotWhenDeleteBackup:                      SettingDefinitionAutoCleanupSnapshotWhenDeleteBackup,
 	}
 
 	SettingDefinitionBackupTarget = SettingDefinition{
@@ -1399,6 +1402,16 @@ var (
 		ReadOnly:    false,
 		Default:     "",
 	}
+
+	SettingDefinitionAutoCleanupSnapshotWhenDeleteBackup = SettingDefinition{
+		DisplayName: "Automatically Cleanup Snapshot When Deleting Backup",
+		Description: "This setting enables Longhorn to automatically cleanup snapshots when removing backup.",
+		Category:    SettingCategorySnapshot,
+		Type:        SettingTypeBool,
+		Required:    true,
+		ReadOnly:    false,
+		Default:     "false",
+	}
 )
 
 type NodeDownPodDeletionPolicy string