cleanup: Remove support for Delete and Unmounting v1.1.0 PVC

as v1.0.0 is deprecated we need to remove the support
for it in the Next coming (v3.0.0) release. This PR
removes the support for the same.

closes #882

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>

internal/rbd/controllerserver.go

@@ -40,7 +40,6 @@ const (
 // controller server spec.
 type ControllerServer struct {
 	*csicommon.DefaultControllerServer
-	MetadataStore util.CachePersister
 	// A map storing all volumes with ongoing operations so that additional operations
 	// for that same volume (as defined by VolumeID/volume name) return an Aborted error
 	VolumeLocks *util.VolumeLocks
@@ -100,7 +99,7 @@ func (cs *ControllerServer) parseVolCreateRequest(ctx context.Context, req *csi.
 	}
 
 	// if it's NOT SINGLE_NODE_WRITER and it's BLOCK we'll set the parameter to ignore the in-use checks
-	rbdVol, err := genVolFromVolumeOptions(ctx, req.GetParameters(), req.GetSecrets(), (isMultiNode && isBlock), false)
+	rbdVol, err := genVolFromVolumeOptions(ctx, req.GetParameters(), req.GetSecrets(), (isMultiNode && isBlock))
 	if err != nil {
 		return nil, status.Error(codes.InvalidArgument, err.Error())
 	}
@@ -461,60 +460,6 @@ func checkContentSource(ctx context.Context, req *csi.CreateVolumeRequest, cr *u
 	return nil, nil, status.Errorf(codes.InvalidArgument, "not a proper volume source")
 }
 
-// DeleteLegacyVolume deletes a volume provisioned using version 1.0.0 of the plugin
-func (cs *ControllerServer) DeleteLegacyVolume(ctx context.Context, req *csi.DeleteVolumeRequest, cr *util.Credentials) (*csi.DeleteVolumeResponse, error) {
-	volumeID := req.GetVolumeId()
-
-	if cs.MetadataStore == nil {
-		return nil, status.Errorf(codes.InvalidArgument, "missing metadata store configuration to"+
-			" proceed with deleting legacy volume ID (%s)", volumeID)
-	}
-
-	if acquired := cs.VolumeLocks.TryAcquire(volumeID); !acquired {
-		klog.Errorf(util.Log(ctx, util.VolumeOperationAlreadyExistsFmt), volumeID)
-		return nil, status.Errorf(codes.Aborted, util.VolumeOperationAlreadyExistsFmt, volumeID)
-	}
-	defer cs.VolumeLocks.Release(volumeID)
-
-	rbdVol := &rbdVolume{}
-	if err := cs.MetadataStore.Get(volumeID, rbdVol); err != nil {
-		if err, ok := err.(*util.CacheEntryNotFound); ok {
-			klog.Warningf(util.Log(ctx, "metadata for legacy volume %s not found, assuming the volume to be already deleted (%v)"), volumeID, err)
-			return &csi.DeleteVolumeResponse{}, nil
-		}
-
-		return nil, status.Error(codes.Internal, err.Error())
-	}
-
-	// Fill up Monitors
-	if err := updateMons(rbdVol, nil, req.GetSecrets()); err != nil {
-		return nil, status.Error(codes.Internal, err.Error())
-	}
-
-	defer rbdVol.Destroy()
-
-	err := rbdVol.Connect(cr)
-	if err != nil {
-		return nil, status.Error(codes.Internal, err.Error())
-	}
-
-	// Update rbdImageName as the VolName when dealing with version 1 volumes
-	rbdVol.RbdImageName = rbdVol.VolName
-
-	util.DebugLog(ctx, "deleting legacy volume %s", rbdVol.VolName)
-	if err := deleteImage(ctx, rbdVol, cr); err != nil {
-		// TODO: can we detect "already deleted" situations here and proceed?
-		klog.Errorf(util.Log(ctx, "failed to delete legacy rbd image: %s/%s with error: %v"), rbdVol.Pool, rbdVol.VolName, err)
-		return nil, status.Error(codes.Internal, err.Error())
-	}
-
-	if err := cs.MetadataStore.Delete(volumeID); err != nil {
-		return nil, status.Error(codes.Internal, err.Error())
-	}
-
-	return &csi.DeleteVolumeResponse{}, nil
-}
-
 // DeleteVolume deletes the volume in backend and removes the volume metadata
 // from store
 // TODO: make this function less complex
@@ -554,19 +499,6 @@ func (cs *ControllerServer) DeleteVolume(ctx context.Context, req *csi.DeleteVol
 			return &csi.DeleteVolumeResponse{}, nil
 		}
 
-		// If error is ErrInvalidVolID it could be a version 1.0.0 or lower volume, attempt
-		// to process it as such
-		var eivi ErrInvalidVolID
-		if errors.As(err, &eivi) {
-			if isLegacyVolumeID(volumeID) {
-				util.UsefulLog(ctx, "attempting deletion of potential legacy volume (%s)", volumeID)
-				return cs.DeleteLegacyVolume(ctx, req, cr)
-			}
-
-			// Consider unknown volumeID as a successfully deleted volume
-			return &csi.DeleteVolumeResponse{}, nil
-		}
-
 		// if error is ErrKeyNotFound, then a previous attempt at deletion was complete
 		// or partially complete (image and imageOMap are garbage collected already), hence return
 		// success as deletion is complete

internal/rbd/driver.go

@@ -75,10 +75,9 @@ func NewIdentityServer(d *csicommon.CSIDriver) *IdentityServer {
 }
 
 // NewControllerServer initialize a controller server for rbd CSI driver
-func NewControllerServer(d *csicommon.CSIDriver, cachePersister util.CachePersister) *ControllerServer {
+func NewControllerServer(d *csicommon.CSIDriver) *ControllerServer {
 	return &ControllerServer{
 		DefaultControllerServer: csicommon.NewDefaultControllerServer(d),
-		MetadataStore:           cachePersister,
 		VolumeLocks:             util.NewVolumeLocks(),
 		SnapshotLocks:           util.NewVolumeLocks(),
 	}
@@ -96,7 +95,7 @@ func NewNodeServer(d *csicommon.CSIDriver, t string, topology map[string]string)
 
 // Run start a non-blocking grpc controller,node and identityserver for
 // rbd CSI driver which can serve multiple parallel requests
-func (r *Driver) Run(conf *util.Config, cachePersister util.CachePersister) {
+func (r *Driver) Run(conf *util.Config) {
 	var err error
 	var topology map[string]string
 
@@ -155,7 +154,7 @@ func (r *Driver) Run(conf *util.Config, cachePersister util.CachePersister) {
 	}
 
 	if conf.IsControllerServer {
-		r.cs = NewControllerServer(r.cd, cachePersister)
+		r.cs = NewControllerServer(r.cd)
 	}
 	if !conf.IsControllerServer && !conf.IsNodeServer {
 		topology, err = util.GetTopologyFromDomainLabels(conf.DomainLabels, conf.NodeID, conf.DriverName)
@@ -166,7 +165,7 @@ func (r *Driver) Run(conf *util.Config, cachePersister util.CachePersister) {
 		if err != nil {
 			klog.Fatalf("failed to start node server, err %v\n", err)
 		}
-		r.cs = NewControllerServer(r.cd, cachePersister)
+		r.cs = NewControllerServer(r.cd)
 	}
 
 	s := csicommon.NewNonBlockingGRPCServer()

internal/rbd/nodeserver.go

@@ -22,7 +22,6 @@ import (
 	"fmt"
 	"os"
 	"strconv"
-	"strings"
 
 	csicommon "github.com/ceph/ceph-csi/internal/csi-common"
 	"github.com/ceph/ceph-csi/internal/journal"
@@ -155,23 +154,16 @@ func (ns *NodeServer) NodeStageVolume(ctx context.Context, req *csi.NodeStageVol
 		return &csi.NodeStageVolumeResponse{}, nil
 	}
 
-	isLegacyVolume := isLegacyVolumeID(volID)
-	volOptions, err := genVolFromVolumeOptions(ctx, req.GetVolumeContext(), req.GetSecrets(), disableInUseChecks, isLegacyVolume)
+	volOptions, err := genVolFromVolumeOptions(ctx, req.GetVolumeContext(), req.GetSecrets(), disableInUseChecks)
 	if err != nil {
 		return nil, status.Error(codes.Internal, err.Error())
 	}
 
 	// get rbd image name from the volume journal
 	// for static volumes, the image name is actually the volume ID itself
-	// for legacy volumes (v1.0.0), the image name can be found in the staging path
 	switch {
 	case staticVol:
 		volOptions.RbdImageName = volID
-	case isLegacyVolume:
-		volOptions.RbdImageName, err = getLegacyVolumeName(stagingTargetPath)
-		if err != nil {
-			return nil, status.Error(codes.Internal, err.Error())
-		}
 	default:
 		var vi util.CSIIdentifier
 		var imageAttributes *journal.ImageAttributes
@@ -421,30 +413,6 @@ func (ns *NodeServer) NodePublishVolume(ctx context.Context, req *csi.NodePublis
 	return &csi.NodePublishVolumeResponse{}, nil
 }
 
-func getLegacyVolumeName(mountPath string) (string, error) {
-	var volName string
-
-	if strings.HasSuffix(mountPath, "/globalmount") {
-		s := strings.Split(strings.TrimSuffix(mountPath, "/globalmount"), "/")
-		volName = s[len(s)-1]
-		return volName, nil
-	}
-
-	if strings.HasSuffix(mountPath, "/mount") {
-		s := strings.Split(strings.TrimSuffix(mountPath, "/mount"), "/")
-		volName = s[len(s)-1]
-		return volName, nil
-	}
-
-	// get volume name for block volume
-	s := strings.Split(mountPath, "/")
-	if len(s) == 0 {
-		return "", fmt.Errorf("rbd: malformed value of stage target path: %s", mountPath)
-	}
-	volName = s[len(s)-1]
-	return volName, nil
-}
-
 func (ns *NodeServer) mountVolumeToStagePath(ctx context.Context, req *csi.NodeStageVolumeRequest, staticVol bool, stagingPath, devicePath string) (bool, error) {
 	readOnly := false
 	fsType := req.GetVolumeCapability().GetMount().GetFsType()

internal/rbd/nodeserver_test.go

@@ -22,25 +22,6 @@ import (
 	"github.com/container-storage-interface/spec/lib/go/csi"
 )
 
-func TestGetLegacyVolumeName(t *testing.T) {
-	tests := []struct {
-		mountPath string
-		volName   string
-	}{
-		{"csi/vol/56a0cc34-a5c9-44ab-ad33-ed53dd2bd5ea/globalmount", "56a0cc34-a5c9-44ab-ad33-ed53dd2bd5ea"},
-		{"csi/vol/9fdb7491-3469-4414-8fe2-ea96be6f7f72/mount", "9fdb7491-3469-4414-8fe2-ea96be6f7f72"},
-		{"csi/vol/82cd91c4-4582-47b3-bb08-a84f8c5716d6", "82cd91c4-4582-47b3-bb08-a84f8c5716d6"},
-	}
-
-	for _, test := range tests {
-		if got, err := getLegacyVolumeName(test.mountPath); err != nil {
-			t.Errorf("getLegacyVolumeName(%s) returned error when it shouldn't: %s", test.mountPath, err.Error())
-		} else if got != test.volName {
-			t.Errorf("getLegacyVolumeName(%s) = %s, want %s", test.mountPath, got, test.volName)
-		}
-	}
-}
-
 func TestGetStagingPath(t *testing.T) {
 	var stagingPath string
 	// test with nodestagevolumerequest

internal/rbd/rbd_util.go

@@ -36,7 +36,6 @@ import (
 	"github.com/container-storage-interface/spec/lib/go/csi"
 	"github.com/golang/protobuf/ptypes"
 	"github.com/golang/protobuf/ptypes/timestamp"
-	"github.com/pborman/uuid"
 	"k8s.io/apimachinery/pkg/util/sets"
 	"k8s.io/cloud-provider/volume/helpers"
 	klog "k8s.io/klog/v2"
@@ -698,66 +697,7 @@ func getMonsAndClusterID(ctx context.Context, options map[string]string) (monito
 	return
 }
 
-// isLegacyVolumeID checks if passed in volume ID string conforms to volume ID naming scheme used
-// by the version 1.0.0 (legacy) of the plugin, and returns true if found to be conforming
-func isLegacyVolumeID(volumeID string) bool {
-	// Version 1.0.0 volumeID format: "csi-rbd-vol-" + UUID string
-	//    length: 12 ("csi-rbd-vol-") + 36 (UUID string)
-
-	// length check
-	if len(volumeID) != 48 {
-		return false
-	}
-
-	// Header check
-	if !strings.HasPrefix(volumeID, "csi-rbd-vol-") {
-		return false
-	}
-
-	// Trailer UUID format check
-	if uuid.Parse(volumeID[12:]) == nil {
-		return false
-	}
-
-	return true
-}
-
-// upadateMons function is used to update the rbdVolume.Monitors for volumes that were provisioned
-// using the 1.0.0 version (legacy) of the plugin.
-func updateMons(rbdVol *rbdVolume, options, credentials map[string]string) error {
-	var ok bool
-
-	// read monitors and MonValueFromSecret from options, else check passed in rbdVolume for
-	// MonValueFromSecret key in credentials
-	monInSecret := ""
-	if options != nil {
-		if rbdVol.Monitors, ok = options["monitors"]; !ok {
-			rbdVol.Monitors = ""
-		}
-		if monInSecret, ok = options["monValueFromSecret"]; !ok {
-			monInSecret = ""
-		}
-	} else {
-		monInSecret = rbdVol.MonValueFromSecret
-	}
-
-	// if monitors are present in secrets and we have the credentials, use monitors from the
-	// credentials overriding monitors from other sources
-	if monInSecret != "" && credentials != nil {
-		monsFromSecret, ok := credentials[monInSecret]
-		if ok {
-			rbdVol.Monitors = monsFromSecret
-		}
-	}
-
-	if rbdVol.Monitors == "" {
-		return errors.New("either monitors or monValueFromSecret must be set")
-	}
-
-	return nil
-}
-
-func genVolFromVolumeOptions(ctx context.Context, volOptions, credentials map[string]string, disableInUseChecks, isLegacyVolume bool) (*rbdVolume, error) {
+func genVolFromVolumeOptions(ctx context.Context, volOptions, credentials map[string]string, disableInUseChecks bool) (*rbdVolume, error) {
 	var (
 		ok         bool
 		err        error
@@ -776,16 +716,9 @@ func genVolFromVolumeOptions(ctx context.Context, volOptions, credentials map[st
 		rbdVol.NamePrefix = namePrefix
 	}
 
-	if isLegacyVolume {
-		err = updateMons(rbdVol, volOptions, credentials)
-		if err != nil {
-			return nil, err
-		}
-	} else {
-		rbdVol.Monitors, rbdVol.ClusterID, err = getMonsAndClusterID(ctx, volOptions)
-		if err != nil {
-			return nil, err
-		}
+	rbdVol.Monitors, rbdVol.ClusterID, err = getMonsAndClusterID(ctx, volOptions)
+	if err != nil {
+		return nil, err
 	}
 
 	// if no image features is provided, it results in empty string

internal/rbd/rbd_util_test.go

@@ -23,24 +23,6 @@ import (
 	librbd "github.com/ceph/go-ceph/rbd"
 )
 
-func TestIsLegacyVolumeID(t *testing.T) {
-	tests := []struct {
-		volID    string
-		isLegacy bool
-	}{
-		{"prefix-bda37d42-9979-420f-9389-74362f3f98f6", false},
-		{"csi-rbd-vo-f997e783-ff00-48b0-8cc7-30cb36c3df3d", false},
-		{"csi-rbd-vol-this-is-clearly-not-a-valid-UUID----", false},
-		{"csi-rbd-vol-b82f27de-3b3a-43f2-b5e7-9f8d0aad04e9", true},
-	}
-
-	for _, test := range tests {
-		if got := isLegacyVolumeID(test.volID); got != test.isLegacy {
-			t.Errorf("isLegacyVolumeID(%s) = %t, want %t", test.volID, got, test.isLegacy)
-		}
-	}
-}
-
 func TestHasSnapshotFeature(t *testing.T) {
 	tests := []struct {
 		features   string