PMM-8322: Delete artifact from storage (#758)

* PMM-8158: Delete artifact from storage * rename field * rename api * rename endpoint * add delete statuses Co-authored-by: Artem Gavrilov <[email protected]>
percona · Jul 15, 2021 · eabde8d · eabde8d
1 parent c29d5c0
commit eabde8d
Show file tree

Hide file tree

Showing 11 changed files with 944 additions and 90 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,6 @@
 /api/nginx/*.pem
 /bin
 /third_party
+
+# System Files
+.DS_Store
diff --git a/api/managementpb/backup/artifacts.pb.go b/api/managementpb/backup/artifacts.pb.go
diff --git a/api/managementpb/backup/artifacts.pb.gw.go b/api/managementpb/backup/artifacts.pb.gw.go
diff --git a/api/managementpb/backup/artifacts.proto b/api/managementpb/backup/artifacts.proto
@@ -16,6 +16,8 @@ enum BackupStatus {
   BACKUP_STATUS_PAUSED = 3;
   BACKUP_STATUS_SUCCESS = 4;
   BACKUP_STATUS_ERROR = 5;
+  BACKUP_STATUS_DELETING = 6;
+  BACKUP_STATUS_FAILED_TO_DELETE = 7;
 }
 
 // Artifact represents single backup artifact.
@@ -48,6 +50,15 @@ message ListArtifactsResponse {
   repeated Artifact artifacts = 1;
 }
 
+message DeleteArtifactRequest {
+  // Machine-readable artifact ID.
+  string artifact_id = 1;
+  // Removes all the backup files associated with artifact if flag is set.
+  bool remove_files = 2;
+}
+
+message DeleteArtifactResponse {}
+
 // Artifacts service provides public methods for managing backup artifacts.
 service Artifacts {
   // ListArtifacts returns a list of all backup artifacts.
@@ -57,4 +68,11 @@ service Artifacts {
       body: "*"
     };
   }
+  // DeleteArtifact deletes specified artifact.
+  rpc DeleteArtifact(DeleteArtifactRequest) returns (DeleteArtifactResponse) {
+    option (google.api.http) = {
+      post: "/v1/management/backup/Artifacts/Delete"
+      body: "*"
+    };
+  }
 }
diff --git a/api/managementpb/backup/artifacts.validator.pb.go b/api/managementpb/backup/artifacts.validator.pb.go
diff --git a/api/managementpb/backup/json/backup.json b/api/managementpb/backup/json/backup.json
@@ -15,6 +15,84 @@
     "version": "v1beta1"
   },
   "paths": {
+    "/v1/management/backup/Artifacts/Delete": {
+      "post": {
+        "tags": [
+          "Artifacts"
+        ],
+        "summary": "DeleteArtifact deletes specified artifact.",
+        "operationId": "DeleteArtifact",
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "type": "object",
+              "properties": {
+                "artifact_id": {
+                  "description": "Machine-readable artifact ID.",
+                  "type": "string",
+                  "x-order": 0
+                },
+                "remove_files": {
+                  "description": "Removes all the backup files associated with artifact if flag is set.",
+                  "type": "boolean",
+                  "x-order": 1
+                }
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "type": "object"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "type": "object",
+              "properties": {
+                "code": {
+                  "type": "integer",
+                  "format": "int32",
+                  "x-order": 1
+                },
+                "details": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "type_url": {
+                        "type": "string",
+                        "x-order": 0
+                      },
+                      "value": {
+                        "type": "string",
+                        "format": "byte",
+                        "x-order": 1
+                      }
+                    }
+                  },
+                  "x-order": 3
+                },
+                "error": {
+                  "type": "string",
+                  "x-order": 0
+                },
+                "message": {
+                  "type": "string",
+                  "x-order": 2
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/management/backup/Artifacts/List": {
       "post": {
         "tags": [
@@ -101,7 +179,9 @@
                           "BACKUP_STATUS_IN_PROGRESS",
                           "BACKUP_STATUS_PAUSED",
                           "BACKUP_STATUS_SUCCESS",
-                          "BACKUP_STATUS_ERROR"
+                          "BACKUP_STATUS_ERROR",
+                          "BACKUP_STATUS_DELETING",
+                          "BACKUP_STATUS_FAILED_TO_DELETE"
                         ],
                         "x-order": 8
                       },

diff --git a/api/managementpb/backup/json/client/artifacts/artifacts_client.go b/api/managementpb/backup/json/client/artifacts/artifacts_client.go