APPS-1367 Add support for backup retention configuration

config/config.yml

@@ -25,30 +25,30 @@ storage:
 backup-policies:
   keepFilesMaxRecordsPolicy:
     parallel: 8
-    remove-files: KeepAll
     sealed: true
     retry-delay: 10_000
     max-retries: 10
   keepFilesPolicy:
     parallel: 8
-    remove-files: KeepAll
     sealed: true
   removeFilesPolicy:
     parallel: 8
-    remove-files: RemoveAll
     sealed: true
+    retention:
+      full: 1
+      incremental: 0
   removeIncrementalPolicy:
     parallel: 8
     remove-files: RemoveIncremental
     sealed: true
+    retention:
+      incremental: 0
   keepFilesPolicySlow:
     parallel: 8
-    remove-files: KeepAll
     bandwidth: 1
     sealed: true
   encryptedCompressedPolicy128:
     parallel: 8
-    remove-files: RemoveAll
     sealed: true
     encryption:
       key-file: encryptionKey
@@ -58,7 +58,6 @@ backup-policies:
       mode: ZSTD
   encryptedCompressedPolicy256:
     parallel: 8
-    remove-files: RemoveAll
     sealed: true
     encryption:
       key-file: encryptionKey
@@ -68,11 +67,9 @@ backup-policies:
       mode: ZSTD
   notSealed:
     parallel: 8
-    remove-files: KeepAll
     sealed: false
   noIndexesUdfsRecords:
     parallel: 8
-    remove-files: KeepAll
     sealed: true
     no-indexes: true
     no-records: true

docs/docs.go

@@ -1810,16 +1810,11 @@ const docTemplate = `{
                     "type": "integer",
                     "example": 1000
                 },
-                "remove-files": {
-                    "description": "Whether to clear the output directory (default: KeepAll).",
-                    "enum": [
-                        "KeepAll",
-                        "RemoveAll",
-                        "RemoveIncremental"
-                    ],
+                "retention": {
+                    "description": "Specifies how long to retain full and incremental backups.",
                     "allOf": [
                         {
-                            "$ref": "#/definitions/dto.RemoveFilesType"
+                            "$ref": "#/definitions/dto.RetentionPolicy"
                         }
                     ]
                 },
@@ -1860,7 +1855,7 @@ const docTemplate = `{
                 "backup-policy": {
                     "description": "The name of the corresponding backup policy.",
                     "type": "string",
-                    "example": "keepAll"
+                    "example": "keepAllPolicy"
                 },
                 "bin-list": {
                     "description": "The list of backup bin names (optional, an empty list implies backing up all bins).",
@@ -2325,20 +2320,6 @@ const docTemplate = `{
                 }
             }
         },
-        "dto.RemoveFilesType": {
-            "description": "RemoveFilesType represents the type of the backup storage.",
-            "type": "string",
-            "enum": [
-                "KeepAll",
-                "RemoveAll",
-                "RemoveIncremental"
-            ],
-            "x-enum-varnames": [
-                "KeepAll",
-                "RemoveAll",
-                "RemoveIncremental"
-            ]
-        },
         "dto.RestoreJobStatus": {
             "description": "RestoreJobStatus represents a restore job status.",
             "type": "object",
@@ -2627,6 +2608,19 @@ const docTemplate = `{
                 }
             }
         },
+        "dto.RetentionPolicy": {
+            "type": "object",
+            "properties": {
+                "full": {
+                    "description": "Number of full backups to store:\n- If nil, retain all full backups.\n- If N is specified, retain the last N full backups.\n- The minimum value is 1.",
+                    "type": "integer"
+                },
+                "incremental": {
+                    "description": "Number of full backups to store incremental backups for:\n- If nil, retain all incremental backups.\n- If N is specified, retain incremental backups for the last N full backups.\n- If set to 0, do not retain any incremental backups.\n- Must not exceed the value of FullBackups.",
+                    "type": "integer"
+                }
+            }
+        },
         "dto.RetryPolicy": {
             "description": "RetryPolicy defines the configuration for retry attempts in case of failures.",
             "type": "object",

docs/openapi.json

@@ -2021,11 +2021,11 @@
             "example" : 1000,
             "type" : "integer"
           },
-          "remove-files" : {
+          "retention" : {
             "allOf" : [ {
-              "$ref" : "#/components/schemas/dto.RemoveFilesType"
+              "$ref" : "#/components/schemas/dto.RetentionPolicy"
             } ],
-            "description" : "Whether to clear the output directory (default: KeepAll).",
+            "description" : "Specifies how long to retain full and incremental backups.",
             "type" : "object"
           },
           "retry-policy" : {
@@ -2057,7 +2057,7 @@
         "properties" : {
           "backup-policy" : {
             "description" : "The name of the corresponding backup policy.",
-            "example" : "keepAll",
+            "example" : "keepAllPolicy",
             "type" : "string"
           },
           "bin-list" : {
@@ -2462,12 +2462,6 @@
         },
         "type" : "object"
       },
-      "dto.RemoveFilesType" : {
-        "description" : "RemoveFilesType represents the type of the backup storage.",
-        "enum" : [ "KeepAll", "RemoveAll", "RemoveIncremental" ],
-        "type" : "string",
-        "x-enum-varnames" : [ "KeepAll", "RemoveAll", "RemoveIncremental" ]
-      },
       "dto.RestoreJobStatus" : {
         "description" : "RestoreJobStatus represents a restore job status.",
         "properties" : {
@@ -2730,6 +2724,19 @@
         "required" : [ "destination", "policy", "routine", "time" ],
         "type" : "object"
       },
+      "dto.RetentionPolicy" : {
+        "properties" : {
+          "full" : {
+            "description" : "Number of full backups to store:\n- If nil, retain all full backups.\n- If N is specified, retain the last N full backups.\n- The minimum value is 1.",
+            "type" : "integer"
+          },
+          "incremental" : {
+            "description" : "Number of full backups to store incremental backups for:\n- If nil, retain all incremental backups.\n- If N is specified, retain incremental backups for the last N full backups.\n- If set to 0, do not retain any incremental backups.\n- Must not exceed the value of FullBackups.",
+            "type" : "integer"
+          }
+        },
+        "type" : "object"
+      },
       "dto.RetryPolicy" : {
         "description" : "RetryPolicy defines the configuration for retry attempts in case of failures.",
         "properties" : {

docs/openapi.yaml

@@ -1420,7 +1420,6 @@ components:
         bandwidth: 10000
         total-timeout: 2000
         sealed: true
-        remove-files: "{}"
         encryption: "{}"
         parallel: 1
         no-indexes: true
@@ -1429,6 +1428,7 @@ components:
         file-limit: 1024
         retry-policy: "{}"
         socket-timeout: 1000
+        retention: "{}"
       properties:
         bandwidth:
           description: |-
@@ -1471,10 +1471,10 @@ components:
             the records-per-second limit is not applied.
           example: 1000
           type: integer
-        remove-files:
+        retention:
           allOf:
-          - $ref: '#/components/schemas/dto.RemoveFilesType'
-          description: "Whether to clear the output directory (default: KeepAll)."
+          - $ref: '#/components/schemas/dto.RetentionPolicy'
+          description: Specifies how long to retain full and incremental backups.
           type: object
         retry-policy:
           allOf:
@@ -1512,7 +1512,7 @@ components:
         set-list:
         - set1
         interval-cron: 0 0 * * * *
-        backup-policy: keepAll
+        backup-policy: keepAllPolicy
         node-list:
         - "<IP addr 1>:<port 1>["
         - "<IP addr 2>:<port 2>["
@@ -1527,7 +1527,7 @@ components:
       properties:
         backup-policy:
           description: The name of the corresponding backup policy.
-          example: keepAll
+          example: keepAllPolicy
           type: string
         bin-list:
           description: "The list of backup bin names (optional, an empty list implies\
@@ -1653,7 +1653,6 @@ components:
             bandwidth: 10000
             total-timeout: 2000
             sealed: true
-            remove-files: "{}"
             encryption: "{}"
             parallel: 1
             no-indexes: true
@@ -1662,6 +1661,7 @@ components:
             file-limit: 1024
             retry-policy: "{}"
             socket-timeout: 1000
+            retention: "{}"
         aerospike-clusters:
           key:
             credentials: "{}"
@@ -1704,7 +1704,7 @@ components:
             set-list:
             - set1
             interval-cron: 0 0 * * * *
-            backup-policy: keepAll
+            backup-policy: keepAllPolicy
             node-list:
             - "<IP addr 1>:<port 1>["
             - "<IP addr 2>:<port 2>["
@@ -1985,17 +1985,6 @@ components:
             type: string
           type: array
       type: object
-    dto.RemoveFilesType:
-      description: RemoveFilesType represents the type of the backup storage.
-      enum:
-      - KeepAll
-      - RemoveAll
-      - RemoveIncremental
-      type: string
-      x-enum-varnames:
-      - KeepAll
-      - RemoveAll
-      - RemoveIncremental
     dto.RestoreJobStatus:
       description: RestoreJobStatus represents a restore job status.
       example:
@@ -2261,6 +2250,24 @@ components:
       - routine
       - time
       type: object
+    dto.RetentionPolicy:
+      properties:
+        full:
+          description: |-
+            Number of full backups to store:
+            - If nil, retain all full backups.
+            - If N is specified, retain the last N full backups.
+            - The minimum value is 1.
+          type: integer
+        incremental:
+          description: |-
+            Number of full backups to store incremental backups for:
+            - If nil, retain all incremental backups.
+            - If N is specified, retain incremental backups for the last N full backups.
+            - If set to 0, do not retain any incremental backups.
+            - Must not exceed the value of FullBackups.
+          type: integer
+      type: object
     dto.RetryPolicy:
       description: RetryPolicy defines the configuration for retry attempts in case
         of failures.

internal/server/handlers/config_policy_test.go

@@ -19,9 +19,7 @@ const (
 
 func testConfigBackupPolicy() *dto.BackupPolicy {
 	testInt := 10
-	keepFiles := dto.KeepAll
 	return &dto.BackupPolicy{
-		RemoveFiles:   &keepFiles,
 		Parallel:      &testInt,
 		SocketTimeout: &testInt,
 		TotalTimeout:  &testInt,