Allow ONTAP volumes to skip recovery queue on deletion

Co-authored-by: Vivin Thomas Wilson <[email protected]>

Author: clintonk

core/orchestrator_core.go

@@ -2364,6 +2364,7 @@ func (o *TridentOrchestrator) cloneVolumeInitial(
 	cloneConfig.ReadOnlyClone = volumeConfig.ReadOnlyClone
 	cloneConfig.Namespace = volumeConfig.Namespace
 	cloneConfig.RequestName = volumeConfig.RequestName
+	cloneConfig.SkipRecoveryQueue = volumeConfig.SkipRecoveryQueue
 
 	// If it's from snapshot, we need the LUKS passphrases value from the snapshot
 	isLUKS, err := strconv.ParseBool(cloneConfig.LUKSEncryption)

frontend/csi/controller_helpers/kubernetes/config.go

@@ -60,6 +60,7 @@ const (
 	AnnVolumeShareToNS      = annPrefix + "/shareToNamespace"
 	AnnReadOnlyClone        = annPrefix + "/readOnlyClone"
 	AnnLUKSEncryption       = annPrefix + "/luksEncryption" // import only
+	AnnSkipRecoveryQueue    = annPrefix + "/skipRecoveryQueue"
 )
 
 var features = map[controllerhelpers.Feature]*versionutils.Version{

frontend/csi/controller_helpers/kubernetes/helper.go

@@ -819,6 +819,7 @@ func getVolumeConfig(
 		PreferredTopologies: preferredTopology,
 		Namespace:           pvc.Namespace,
 		RequestName:         pvc.Name,
+		SkipRecoveryQueue:   getAnnotation(annotations, AnnSkipRecoveryQueue),
 	}
 }
 

mocks/mock_storage_drivers/mock_ontap/mock_api.go

@@ -68,6 +68,7 @@ type VolumeConfig struct {
 	SubordinateVolumes map[string]interface{} `json:"-"`
 	Namespace          string                 `json:"namespace"`
 	RequestName        string                 `json:"requestName"`
+	SkipRecoveryQueue  string                 `json:"skipRecoveryQueue"`
 }
 
 type VolumeCreatingConfig struct {

mocks/mock_storage_drivers/mock_ontap/mock_ontap_rest_interface.go

@@ -68,7 +68,7 @@ type OntapAPI interface {
 	) error
 	FlexgroupMount(ctx context.Context, name, junctionPath string) error
 	FlexgroupListByPrefix(ctx context.Context, prefix string) (Volumes, error)
-	FlexgroupDestroy(ctx context.Context, volumeName string, force bool) error
+	FlexgroupDestroy(ctx context.Context, volumeName string, force, skipRecoveryQueue bool) error
 	FlexgroupSetSize(ctx context.Context, name, newSize string) error
 	FlexgroupSize(ctx context.Context, volumeName string) (uint64, error)
 	FlexgroupUnmount(ctx context.Context, name string, force bool) error
@@ -195,7 +195,7 @@ type OntapAPI interface {
 	VolumeCloneSplitStart(ctx context.Context, cloneName string) error
 
 	VolumeCreate(ctx context.Context, volume Volume) error
-	VolumeDestroy(ctx context.Context, volumeName string, force bool) error
+	VolumeDestroy(ctx context.Context, volumeName string, force, skipRecoveryQueue bool) error
 	VolumeModifySnapshotDirectoryAccess(ctx context.Context, name string, enable bool) error
 	VolumeExists(ctx context.Context, volumeName string) (bool, error)
 	VolumeInfo(ctx context.Context, volumeName string) (*Volume, error)
@@ -221,6 +221,8 @@ type OntapAPI interface {
 		ctx context.Context, volumeName string, desiredStates, abortStates []string,
 		maxElapsedTime time.Duration,
 	) (string, error)
+	VolumeRecoveryQueuePurge(ctx context.Context, recoveryQueueVolumeName string) error
+	VolumeRecoveryQueueGetName(ctx context.Context, name string) (string, error)
 	SMBShareCreate(ctx context.Context, shareName, path string) error
 	SMBShareExists(ctx context.Context, shareName string) (bool, error)
 	SMBShareDestroy(ctx context.Context, shareName string) error

mocks/mock_storage_drivers/mock_ontap/mock_ontap_zapi_interface.go

@@ -180,14 +180,30 @@ func (d OntapAPIREST) VolumeCreate(ctx context.Context, volume Volume) error {
 	return nil
 }
 
-func (d OntapAPIREST) VolumeDestroy(ctx context.Context, name string, force bool) error {
-	deletionErr := d.api.VolumeDestroy(ctx, name)
+func (d OntapAPIREST) VolumeDestroy(ctx context.Context, name string, force, skipRecoveryQueue bool) error {
+	deletionErr := d.api.VolumeDestroy(ctx, name, skipRecoveryQueue)
 	if deletionErr != nil {
 		return fmt.Errorf("error destroying volume %v: %v", name, deletionErr)
 	}
 	return nil
 }
 
+func (d OntapAPIREST) VolumeRecoveryQueuePurge(ctx context.Context, recoveryQueueVolumeName string) error {
+	purgeErr := d.api.VolumeRecoveryQueuePurge(ctx, recoveryQueueVolumeName)
+	if purgeErr != nil {
+		return fmt.Errorf("error purging volume vfrom recovery queue %v: %v", recoveryQueueVolumeName, purgeErr)
+	}
+	return nil
+}
+
+func (d OntapAPIREST) VolumeRecoveryQueueGetName(ctx context.Context, name string) (string, error) {
+	recoveryQueueVolumeName, err := d.api.VolumeRecoveryQueueGetName(ctx, name)
+	if err != nil {
+		return "", fmt.Errorf("error listing volumes in recovery queue: %v", err)
+	}
+	return recoveryQueueVolumeName, nil
+}
+
 func (d OntapAPIREST) VolumeInfo(ctx context.Context, name string) (*Volume, error) {
 	fields := []string{
 		"type", "size", "comment", "aggregates", "nas", "guarantee",
@@ -722,7 +738,7 @@ func (d OntapAPIREST) FlexgroupMount(ctx context.Context, name, junctionPath str
 	return nil
 }
 
-func (d OntapAPIREST) FlexgroupDestroy(ctx context.Context, volumeName string, force bool) error {
+func (d OntapAPIREST) FlexgroupDestroy(ctx context.Context, volumeName string, force, skipRecoveryQueue bool) error {
 	if err := d.FlexgroupUnmount(ctx, volumeName, true); err != nil {
 		return fmt.Errorf("error unmounting volume %v: %v", volumeName, err)
 	}
@@ -733,7 +749,7 @@ func (d OntapAPIREST) FlexgroupDestroy(ctx context.Context, volumeName string, f
 	// utilized space. Is that what we want? Or should we just deny the delete, and force the
 	// user to keep the volume around until all of the clones are gone? If we do that, need a
 	// way to list the clones. Maybe volume inspect.
-	deletionErr := d.api.FlexGroupDestroy(ctx, volumeName)
+	deletionErr := d.api.FlexGroupDestroy(ctx, volumeName, skipRecoveryQueue)
 	if deletionErr != nil {
 		return fmt.Errorf("error destroying volume %v: %v", volumeName, deletionErr)
 	}

storage/volume.go

@@ -1459,13 +1459,13 @@ func TestVolumeDestroy(t *testing.T) {
 	oapi, rsi := newMockOntapAPIREST(t)
 
 	// case 1: Delete volume, Positive test
-	rsi.EXPECT().VolumeDestroy(ctx, "vol1").Return(nil)
-	err := oapi.VolumeDestroy(ctx, "vol1", false)
+	rsi.EXPECT().VolumeDestroy(ctx, "vol1", false).Return(nil)
+	err := oapi.VolumeDestroy(ctx, "vol1", false, false)
 	assert.NoError(t, err, "error returned while deleting a volume")
 
 	// case 2: Delete volume, returned error.
-	rsi.EXPECT().VolumeDestroy(ctx, "vol1").Return(fmt.Errorf("failed to delete volume"))
-	err = oapi.VolumeDestroy(ctx, "vol1", false)
+	rsi.EXPECT().VolumeDestroy(ctx, "vol1", false).Return(fmt.Errorf("failed to delete volume"))
+	err = oapi.VolumeDestroy(ctx, "vol1", false, false)
 	assert.Error(t, err, "no error returned while deleting a volume")
 }
 
@@ -1863,21 +1863,21 @@ func TestFlexgroupDestroy(t *testing.T) {
 
 	// case 1: Flexgroup destroy
 	rsi.EXPECT().FlexgroupUnmount(ctx, "trident-pvc-1234").Return(nil)
-	rsi.EXPECT().FlexGroupDestroy(ctx, "trident-pvc-1234").Return(nil)
-	err := oapi.FlexgroupDestroy(ctx, "trident-pvc-1234", true)
+	rsi.EXPECT().FlexGroupDestroy(ctx, "trident-pvc-1234", false).Return(nil)
+	err := oapi.FlexgroupDestroy(ctx, "trident-pvc-1234", true, false)
 	assert.NoError(t, err, "error returned while deleting a volume")
 
 	// case 2: Flexgroup destroyed returned error
 	rsi.EXPECT().FlexgroupUnmount(ctx, "trident-pvc-1234").Return(nil)
-	rsi.EXPECT().FlexGroupDestroy(ctx, "trident-pvc-1234").Return(
+	rsi.EXPECT().FlexGroupDestroy(ctx, "trident-pvc-1234", false).Return(
 		fmt.Errorf("failed to delete flexgroup volume"))
-	err = oapi.FlexgroupDestroy(ctx, "trident-pvc-1234", true)
+	err = oapi.FlexgroupDestroy(ctx, "trident-pvc-1234", true, false)
 	assert.Error(t, err, "no error returned while deleting a volume")
 
 	// case 3: Flexgroup unmount returned error
 	rsi.EXPECT().FlexgroupUnmount(ctx, "trident-pvc-1234").Return(
 		fmt.Errorf("failed to unmount flexgroup volume"))
-	err = oapi.FlexgroupDestroy(ctx, "trident-pvc-1234", true)
+	err = oapi.FlexgroupDestroy(ctx, "trident-pvc-1234", true, false)
 	assert.Error(t, err, "no error returned while deleting a volume")
 }