Merge pull request ceph#55691 from ivoalmeida/snapshot-schedule-retention-fix

mgr/dashboard: fix retention add for subvolume

Reviewed-by: Ankush Behl <[email protected]>
Reviewed-by: Milind Changire <[email protected]>
Reviewed-by: Venky Shankar <[email protected]>

Author: ivoalmeida

src/pybind/mgr/dashboard/controllers/cephfs.py

@@ -1029,7 +1029,9 @@ def create(self, fs: str, path: str, snap_schedule: str, start: str, retention_p
                                                                     path,
                                                                     retention_spec_or_period,
                                                                     retention_count,
-                                                                    fs)
+                                                                    fs,
+                                                                    subvol,
+                                                                    group)
                 if error_code_retention != 0:
                     raise DashboardException(
                         f'Failed to add retention policy for path {path}: {err_retention}'
@@ -1071,7 +1073,36 @@ def editRetentionPolicies(method, retention_policy):
 
     @RESTController.Resource('DELETE')
     def delete_snapshot(self, fs: str, path: str, schedule: str, start: str,
-                        subvol=None, group=None):
+                        retention_policy=None, subvol=None, group=None):
+        if retention_policy:
+            # check if there are other snap schedules for this exact same path
+            error_code, out, err = mgr.remote('snap_schedule', 'snap_schedule_list',
+                                              path, False, fs, subvol, group, 'plain')
+
+            if error_code != 0:
+                raise DashboardException(
+                    f'Failed to get snapshot schedule list for path {path}: {err}'
+                )
+            # only remove the retention policies if there no other snap schedules for this path
+            snapshot_schedule_list = out.split('\n')
+            if len(snapshot_schedule_list) <= 1:
+                retention_policies = retention_policy.split('|')
+                for retention in retention_policies:
+                    retention_count = retention.split('-')[0]
+                    retention_spec_or_period = retention.split('-')[1]
+                    error_code, _, err = mgr.remote('snap_schedule',
+                                                    'snap_schedule_retention_rm',
+                                                    path,
+                                                    retention_spec_or_period,
+                                                    retention_count,
+                                                    fs,
+                                                    subvol,
+                                                    group)
+                    if error_code != 0:
+                        raise DashboardException(
+                            f'Failed to remove retention policy for path {path}: {err}'
+                        )
+        # remove snap schedule
         error_code, _, err = mgr.remote('snap_schedule',
                                         'snap_schedule_rm',
                                         path,

src/pybind/mgr/dashboard/frontend/src/app/ceph/cephfs/cephfs-snapshotschedule-form/cephfs-snapshotschedule-form.component.ts

@@ -389,7 +389,8 @@ export class CephfsSnapshotscheduleFormComponent extends CdForm implements OnIni
               frm.get('directory').value,
               this.fsName,
               retentionList,
-              this.retentionPoliciesToRemove?.map?.((rp) => rp.retentionFrequency) || []
+              this.retentionPoliciesToRemove?.map?.((rp) => rp.retentionFrequency) || [],
+              !!this.subvolume
             )
             .pipe(
               map(({ exists, errorIndex }) => {

src/pybind/mgr/dashboard/frontend/src/app/ceph/cephfs/cephfs-snapshotschedule-list/cephfs-snapshotschedule-list.component.ts

@@ -291,7 +291,17 @@ export class CephfsSnapshotscheduleListComponent
   }
 
   deleteSnapshotSchedule() {
-    const { path, start, fs, schedule, subvol, group } = this.selection.first();
+    const { path, start, fs, schedule, subvol, group, retention } = this.selection.first();
+    const retentionPolicy = retention
+      ?.split(/\s/gi)
+      ?.filter((r: string) => !!r)
+      ?.map((r: string) => {
+        const frequency = r.substring(r.length - 1);
+        const interval = r.substring(0, r.length - 1);
+        return `${interval}-${frequency}`;
+      })
+      ?.join('|')
+      ?.toLocaleLowerCase();
 
     this.modalRef = this.modalService.show(CriticalConfirmationModalComponent, {
       itemDescription: $localize`snapshot schedule`,
@@ -305,6 +315,7 @@ export class CephfsSnapshotscheduleListComponent
             schedule,
             start,
             fs,
+            retentionPolicy,
             subvol,
             group
           })

src/pybind/mgr/dashboard/frontend/src/app/shared/api/cephfs-snapshot-schedule.service.ts

@@ -48,10 +48,21 @@ export class CephfsSnapshotScheduleService {
     );
   }
 
-  delete({ fs, path, schedule, start, subvol, group }: Record<string, any>): Observable<any> {
+  delete({
+    fs,
+    path,
+    schedule,
+    start,
+    retentionPolicy,
+    subvol,
+    group
+  }: Record<string, any>): Observable<any> {
     let deleteUrl = `${this.baseURL}/snapshot/schedule/${fs}/${encodeURIComponent(
       path
     )}/delete_snapshot?schedule=${schedule}&start=${encodeURIComponent(start)}`;
+    if (retentionPolicy) {
+      deleteUrl += `&retention_policy=${retentionPolicy}`;
+    }
     if (subvol && group) {
       deleteUrl += `&subvol=${encodeURIComponent(subvol)}&group=${encodeURIComponent(group)}`;
     }
@@ -81,13 +92,16 @@ export class CephfsSnapshotScheduleService {
     path: string,
     fs: string,
     retentionFrequencies: string[],
-    retentionFrequenciesRemoved: string[] = []
+    retentionFrequenciesRemoved: string[] = [],
+    isSubvolume = false
   ): Observable<{ exists: boolean; errorIndex: number }> {
     return this.getSnapshotSchedule(path, fs, false).pipe(
       map((response) => {
         let errorIndex = -1;
         let exists = false;
-        const index = response.findIndex((x) => x.path === path);
+        const index = response.findIndex((x) =>
+          isSubvolume ? x.path.startsWith(path) : x.path === path
+        );
         const result = retentionFrequencies?.length
           ? intersection(
               Object.keys(response?.[index]?.retention).filter(

src/pybind/mgr/dashboard/openapi.yaml

@@ -2081,6 +2081,11 @@ paths:
         required: true
         schema:
           type: string
+      - allowEmptyValue: true
+        in: query
+        name: retention_policy
+        schema:
+          type: string
       - allowEmptyValue: true
         in: query
         name: subvol