BIAv2 async operations controller work

Signed-off-by: Scott Seago <[email protected]>

changelogs/unreleased/5849-sseago

@@ -0,0 +1 @@
+BIAv2 async operations controller work

config/crd/v1/bases/velero.io_backups.yaml

@@ -273,6 +273,11 @@ spec:
                   type: string
                 nullable: true
                 type: array
+              itemOperationTimeout:
+                description: ItemOperationTimeout specifies the time used to wait
+                  for asynchronous BackupItemAction operations The default value is
+                  1 hour.
+                type: string
               labelSelector:
                 description: LabelSelector is a metav1.LabelSelector to filter with
                   when adding individual objects to the backup. If empty or nil, all
@@ -415,6 +420,20 @@ spec:
           status:
             description: BackupStatus captures the current status of a Velero backup.
             properties:
+              asyncBackupItemOperationsAttempted:
+                description: AsyncBackupItemOperationsAttempted is the total number
+                  of attempted async BackupItemAction operations for this backup.
+                type: integer
+              asyncBackupItemOperationsCompleted:
+                description: AsyncBackupItemOperationsCompleted is the total number
+                  of successfully completed async BackupItemAction operations for
+                  this backup.
+                type: integer
+              asyncBackupItemOperationsFailed:
+                description: AsyncBackupItemOperationsFailed is the total number of
+                  async BackupItemAction operations for this backup which ended with
+                  an error.
+                type: integer
               completionTimestamp:
                 description: CompletionTimestamp records the time a backup was completed.
                   Completion time is recorded even on failed backups. Completion time
@@ -457,6 +476,8 @@ spec:
                 - InProgress
                 - WaitingForPluginOperations
                 - WaitingForPluginOperationsPartiallyFailed
+                - FinalizingAfterPluginOperations
+                - FinalizingAfterPluginOperationsPartiallyFailed
                 - Completed
                 - PartiallyFailed
                 - Failed

config/crd/v1/bases/velero.io_schedules.yaml

@@ -308,6 +308,11 @@ spec:
                       type: string
                     nullable: true
                     type: array
+                  itemOperationTimeout:
+                    description: ItemOperationTimeout specifies the time used to wait
+                      for asynchronous BackupItemAction operations The default value
+                      is 1 hour.
+                    type: string
                   labelSelector:
                     description: LabelSelector is a metav1.LabelSelector to filter
                       with when adding individual objects to the backup. If empty

design/biav2-design.md

@@ -34,6 +34,7 @@ message ExecuteResponse {
     bytes item = 1;
     repeated generated.ResourceIdentifier additionalItems = 2;
     string operationID = 3;
+    repeated generated.ResourceIdentifier itemsToUpdate = 4;
 }
 ```
 The BackupItemAction service gets two new rpc methods:
@@ -78,6 +79,19 @@ message OperationProgress {
 }
 ```
 
+In addition to the two new rpc methods added to the BackupItemAction interface, there is also a new `Name()` method. This one is only actually used internally by Velero to get the name that the plugin was registered with, but it still must be defined in a plugin which implements BackupItemActionV2 in order to implement the interface. It doesn't really matter what it returns, though, as this particular method is not delegated to the plugin via RPC calls. The new (and modified) interface methods for `BackupItemAction` are as follows:
+```
+type BackupItemAction interface {
+...
+	Name() string
+...
+	Execute(item runtime.Unstructured, backup *api.Backup) (runtime.Unstructured, []velero.ResourceIdentifier, string, []velero.ResourceIdentifier, error)
+	Progress(operationID string, backup *api.Backup) (velero.OperationProgress, error)
+	Cancel(operationID string, backup *api.Backup) error
+...
+}
+```
+
 A new PluginKind, `BackupItemActionV2`, will be created, and the backup process will be modified to use this plugin kind.
 See [Plugin Versioning](plugin-versioning.md) for more details on implementation plans, including v1 adapters, etc.
 

internal/hook/item_hook_handler.go

@@ -273,6 +273,20 @@ func (h *DefaultItemHookHandler) HandleHooks(
 	return nil
 }
 
+// NoOpItemHookHandler is the an itemHookHandler for the Finalize controller where hooks don't run
+type NoOpItemHookHandler struct{}
+
+func (h *NoOpItemHookHandler) HandleHooks(
+	log logrus.FieldLogger,
+	groupResource schema.GroupResource,
+	obj runtime.Unstructured,
+	resourceHooks []ResourceHook,
+	phase hookPhase,
+) error {
+
+	return nil
+}
+
 func phasedKey(phase hookPhase, key string) string {
 	if phase != "" {
 		return fmt.Sprintf("%v.%v", phase, key)

pkg/apis/velero/v1/backup.go

@@ -124,6 +124,11 @@ type BackupSpec struct {
 	// The default value is 10 minute.
 	// +optional
 	CSISnapshotTimeout metav1.Duration `json:"csiSnapshotTimeout,omitempty"`
+
+	// ItemOperationTimeout specifies the time used to wait for asynchronous BackupItemAction operations
+	// The default value is 1 hour.
+	// +optional
+	ItemOperationTimeout metav1.Duration `json:"itemOperationTimeout,omitempty"`
 }
 
 // BackupHooks contains custom behaviors that should be executed at different phases of the backup.
@@ -221,7 +226,7 @@ const (
 
 // BackupPhase is a string representation of the lifecycle phase
 // of a Velero backup.
-// +kubebuilder:validation:Enum=New;FailedValidation;InProgress;WaitingForPluginOperations;WaitingForPluginOperationsPartiallyFailed;Completed;PartiallyFailed;Failed;Deleting
+// +kubebuilder:validation:Enum=New;FailedValidation;InProgress;WaitingForPluginOperations;WaitingForPluginOperationsPartiallyFailed;FinalizingAfterPluginOperations;FinalizingAfterPluginOperationsPartiallyFailed;Completed;PartiallyFailed;Failed;Deleting
 type BackupPhase string
 
 const (
@@ -251,6 +256,23 @@ const (
 	// ongoing.  The backup is not usable yet.
 	BackupPhaseWaitingForPluginOperationsPartiallyFailed BackupPhase = "WaitingForPluginOperationsPartiallyFailed"
 
+	// BackupPhaseFinalizingAfterPluginOperations means the backup of
+	// Kubernetes resources, creation of snapshots, and other
+	// async plugin operations were successful and snapshot upload and
+	// other plugin operations are now complete, but the Backup is awaiting
+	// final update of resources modified during async operations.
+	// The backup is not usable yet.
+	BackupPhaseFinalizingAfterPluginOperations BackupPhase = "FinalizingAfterPluginOperations"
+
+	// BackupPhaseFinalizingAfterPluginOperationsPartiallyFailed means the backup of
+	// Kubernetes resources, creation of snapshots, and other
+	// async plugin operations were successful and snapshot upload and
+	// other plugin operations are now complete, but one or more errors
+	// occurred during backup or async operation processing, and the
+	// Backup is awaiting final update of resources modified during async
+	// operations. The backup is not usable yet.
+	BackupPhaseFinalizingAfterPluginOperationsPartiallyFailed BackupPhase = "FinalizingAfterPluginOperationsPartiallyFailed"
+
 	// BackupPhaseCompleted means the backup has run successfully without
 	// errors.
 	BackupPhaseCompleted BackupPhase = "Completed"
@@ -351,6 +373,21 @@ type BackupStatus struct {
 	// completed CSI VolumeSnapshots for this backup.
 	// +optional
 	CSIVolumeSnapshotsCompleted int `json:"csiVolumeSnapshotsCompleted,omitempty"`
+
+	// AsyncBackupItemOperationsAttempted is the total number of attempted
+	// async BackupItemAction operations for this backup.
+	// +optional
+	AsyncBackupItemOperationsAttempted int `json:"asyncBackupItemOperationsAttempted,omitempty"`
+
+	// AsyncBackupItemOperationsCompleted is the total number of successfully completed
+	// async BackupItemAction operations for this backup.
+	// +optional
+	AsyncBackupItemOperationsCompleted int `json:"asyncBackupItemOperationsCompleted,omitempty"`
+
+	// AsyncBackupItemOperationsFailed is the total number of async
+	// BackupItemAction operations for this backup which ended with an error.
+	// +optional
+	AsyncBackupItemOperationsFailed int `json:"asyncBackupItemOperationsFailed,omitempty"`
 }
 
 // BackupProgress stores information about the progress of a Backup's execution.

pkg/archive/filesystem.go

@@ -28,11 +28,20 @@ import (
 
 // GetItemFilePath returns an item's file path once extracted from a Velero backup archive.
 func GetItemFilePath(rootDir, groupResource, namespace, name string) string {
-	switch namespace {
-	case "":
-		return filepath.Join(rootDir, velerov1api.ResourcesDir, groupResource, velerov1api.ClusterScopedDir, name+".json")
-	default:
-		return filepath.Join(rootDir, velerov1api.ResourcesDir, groupResource, velerov1api.NamespaceScopedDir, namespace, name+".json")
+	return GetVersionedItemFilePath(rootDir, groupResource, namespace, name, "")
+}
+
+// GetVersionedItemFilePath returns an item's file path once extracted from a Velero backup archive, with version included.
+func GetVersionedItemFilePath(rootDir, groupResource, namespace, name, versionPath string) string {
+	return filepath.Join(rootDir, velerov1api.ResourcesDir, groupResource, versionPath, GetScopeDir(namespace), namespace, name+".json")
+}
+
+// GetScopeDir returns NamespaceScopedDir if namespace is present, or ClusterScopedDir if empty
+func GetScopeDir(namespace string) string {
+	if namespace == "" {
+		return velerov1api.ClusterScopedDir
+	} else {
+		return velerov1api.NamespaceScopedDir
 	}
 }
 

pkg/archive/filesystem_test.go

@@ -28,4 +28,22 @@ func TestGetItemFilePath(t *testing.T) {
 
 	res = GetItemFilePath("root", "resource", "namespace", "item")
 	assert.Equal(t, "root/resources/resource/namespaces/namespace/item.json", res)
+
+	res = GetItemFilePath("", "resource", "", "item")
+	assert.Equal(t, "resources/resource/cluster/item.json", res)
+
+	res = GetVersionedItemFilePath("root", "resource", "", "item", "")
+	assert.Equal(t, "root/resources/resource/cluster/item.json", res)
+
+	res = GetVersionedItemFilePath("root", "resource", "namespace", "item", "")
+	assert.Equal(t, "root/resources/resource/namespaces/namespace/item.json", res)
+
+	res = GetVersionedItemFilePath("root", "resource", "namespace", "item", "v1")
+	assert.Equal(t, "root/resources/resource/v1/namespaces/namespace/item.json", res)
+
+	res = GetVersionedItemFilePath("root", "resource", "", "item", "v1")
+	assert.Equal(t, "root/resources/resource/v1/cluster/item.json", res)
+
+	res = GetVersionedItemFilePath("", "resource", "", "item", "")
+	assert.Equal(t, "resources/resource/cluster/item.json", res)
 }