Adds support for allowing a RestoreItemAction to skip item restore (v…

…mware-tanzu#1336) * Adds support for allowing a RestoreItemAction to skip item restore This allows a RestoreItemAction plugin to signal to velero that the returned item should be skipped rather than restored to the cluster. To support this, a boolean SkipRestore attribute is added to RestoreItemActionExecuteOutput. If restore.restoreResource finds this set to true, any remaining actions on this item are skipped, and restore on this item is skipped. Execution continues with the next item of this resource type. To signal this for a particular item, the RestoreItemAction's Execute method should call WithoutRestore() on the RestoreItemActionExecuteOutput before returning it. Signed-off-by: Scott Seago <sseago@redhat.com> * Autogenerated code to support SkipRestore Signed-off-by: Scott Seago <sseago@redhat.com> * Added changelog for vmware-tanzu#1336 Signed-off-by: Scott Seago <sseago@redhat.com>
jessestuart · May 28, 2019 · aad366f · aad366f
1 parent cf7472d
commit aad366f
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 20 deletions.
diff --git a/changelogs/unreleased/1336-sseago b/changelogs/unreleased/1336-sseago
@@ -0,0 +1 @@
+Add support for allowing a RestoreItemAction to skip item restore.
diff --git a/pkg/plugin/framework/restore_item_action_client.go b/pkg/plugin/framework/restore_item_action_client.go
@@ -117,5 +117,6 @@ func (c *RestoreItemActionGRPCClient) Execute(input *velero.RestoreItemActionExe
 	return &velero.RestoreItemActionExecuteOutput{
 		UpdatedItem:     &updatedItem,
 		AdditionalItems: additionalItems,
+		SkipRestore:     res.SkipRestore,
 	}, nil
 }
diff --git a/pkg/plugin/framework/restore_item_action_server.go b/pkg/plugin/framework/restore_item_action_server.go
@@ -126,7 +126,8 @@ func (s *RestoreItemActionGRPCServer) Execute(ctx context.Context, req *proto.Re
 	}
 
 	res := &proto.RestoreItemActionExecuteResponse{
-		Item: updatedItemJSON,
+		Item:        updatedItemJSON,
+		SkipRestore: executeOutput.SkipRestore,
 	}
 
 	for _, item := range executeOutput.AdditionalItems {

diff --git a/pkg/plugin/generated/RestoreItemAction.pb.go b/pkg/plugin/generated/RestoreItemAction.pb.go
diff --git a/pkg/plugin/proto/RestoreItemAction.proto b/pkg/plugin/proto/RestoreItemAction.proto
@@ -13,6 +13,7 @@ message RestoreItemActionExecuteRequest {
 message RestoreItemActionExecuteResponse {
     bytes item = 1;
     repeated ResourceIdentifier additionalItems = 2;
+    bool skipRestore = 3;
 }
 
 service RestoreItemAction {

diff --git a/pkg/plugin/velero/restore_item_action.go b/pkg/plugin/velero/restore_item_action.go
@@ -57,6 +57,11 @@ type RestoreItemActionExecuteOutput struct {
 	// AdditionalItems is a list of additional related items that should
 	// be restored.
 	AdditionalItems []ResourceIdentifier
+
+	// SkipRestore tells velero to stop executing further actions
+	// on this item, and skip the restore step. When this field's
+	// value is true, AdditionalItems will be ignored.
+	SkipRestore bool
 }
 
 // NewRestoreItemActionExecuteOutput creates a new RestoreItemActionExecuteOutput
@@ -65,3 +70,9 @@ func NewRestoreItemActionExecuteOutput(item runtime.Unstructured) *RestoreItemAc
 		UpdatedItem: item,
 	}
 }
+
+// WithoutRestore returns SkipRestore for RestoreItemActionExecuteOutput
+func (r *RestoreItemActionExecuteOutput) WithoutRestore() *RestoreItemActionExecuteOutput {
+	r.SkipRestore = true
+	return r
+}
diff --git a/pkg/restore/restore.go b/pkg/restore/restore.go
@@ -896,6 +896,10 @@ func (ctx *context) restoreItem(obj *unstructured.Unstructured, groupResource sc
 			return warnings, errs
 		}
 
+		if executeOutput.SkipRestore {
+			ctx.log.Infof("Skipping restore of %s: %v because a registered plugin discarded it", obj.GroupVersionKind().Kind, name)
+			return warnings, errs
+		}
 		unstructuredObj, ok := executeOutput.UpdatedItem.(*unstructured.Unstructured)
 		if !ok {
 			addToResult(&errs, namespace, fmt.Errorf("%s: unexpected type %T", resourceID, executeOutput.UpdatedItem))