Add directory provisioning mode

Implement `DirectoryProvisioner` struct and its `Provision/Delete` methods. Add `delete-provisioned-dir` command-line option to control DeleteVolume behavior in efs-dir mode.

Author: mpatlasov

cmd/main.go

@@ -41,6 +41,8 @@ func main() {
 		volMetricsFsRateLimit    = flag.Int("vol-metrics-fs-rate-limit", 5, "Volume metrics routines rate limiter per file system")
 		deleteAccessPointRootDir = flag.Bool("delete-access-point-root-dir", false,
 			"Opt in to delete access point root directory by DeleteVolume. By default, DeleteVolume will delete the access point behind Persistent Volume and deleting access point will not delete the access point root directory or its contents.")
+		deleteProvisionedDir = flag.Bool("delete-provisioned-dir", false,
+			"Opt in to delete any provisioned directories and their contents. By default, DeleteVolume will not delete the directory behind Persistent Volume. Note: If root squash is enabled on your EFS it's possible this option will not work.")
 		adaptiveRetryMode = flag.Bool("adaptive-retry-mode", true, "Opt out to use standard sdk retry configuration. By default, adaptive retry mode will be used to more heavily client side rate limit EFS API requests.")
 		tags              = flag.String("tags", "", "Space separated key:value pairs which will be added as tags for EFS resources. For example, 'environment:prod region:us-east-1'")
 	)
@@ -61,7 +63,7 @@ func main() {
 	if err != nil {
 		klog.Fatalln(err)
 	}
-	drv := driver.NewDriver(*endpoint, etcAmazonEfs, *efsUtilsStaticFilesPath, *tags, *volMetricsOptIn, *volMetricsRefreshPeriod, *volMetricsFsRateLimit, *deleteAccessPointRootDir, *adaptiveRetryMode)
+	drv := driver.NewDriver(*endpoint, etcAmazonEfs, *efsUtilsStaticFilesPath, *tags, *volMetricsOptIn, *volMetricsRefreshPeriod, *volMetricsFsRateLimit, *deleteAccessPointRootDir, *adaptiveRetryMode, *deleteProvisionedDir)
 	if err := drv.Run(); err != nil {
 		klog.Fatalln(err)
 	}

pkg/driver/controller.go

@@ -40,6 +40,7 @@ const (
 	DefaultTagKey         = "efs.csi.aws.com/cluster"
 	DefaultTagValue       = "true"
 	DirectoryPerms        = "directoryPerms"
+	DirectoryMode         = "efs-dir"
 	EnsureUniqueDirectory = "ensureUniqueDirectory"
 	FsId                  = "fileSystemId"
 	Gid                   = "gid"
@@ -120,19 +121,25 @@ func (d *Driver) DeleteVolume(ctx context.Context, req *csi.DeleteVolumeRequest)
 		return nil, status.Error(codes.InvalidArgument, "Volume ID not provided")
 	}
 
-	_, _, accessPointId, err := parseVolumeId(volId)
+	_, subpath, accessPointId, err := parseVolumeId(volId)
 	if err != nil {
 		//Returning success for an invalid volume ID. See here - https://github.com/kubernetes-csi/csi-test/blame/5deb83d58fea909b2895731d43e32400380aae3c/pkg/sanity/controller.go#L733
 		klog.V(5).Infof("DeleteVolume: Failed to parse volumeID: %v, err: %v, returning success", volId, err)
 		return &csi.DeleteVolumeResponse{}, nil
 	}
 
-	if accessPointId == "" {
-		klog.V(5).Infof("DeleteVolume: No Access Point for volume %v, returning success", volId)
+	var provisioningMode string
+	if accessPointId != "" {
+		provisioningMode = AccessPointMode
+	} else if subpath != "" {
+		provisioningMode = DirectoryMode
+	} else {
+		klog.V(5).Infof("DeleteVolume: No Access Point or subpath for volume %v, returning success", volId)
 		return &csi.DeleteVolumeResponse{}, nil
 	}
 
-	err = d.provisioners[AccessPointMode].Delete(ctx, req)
+	klog.V(5).Infof("DeleteVolume: provisioningMode %v", provisioningMode)
+	err = d.provisioners[provisioningMode].Delete(ctx, req)
 	if err != nil {
 		return nil, status.Errorf(codes.Internal, "Failed to Delete volume %v: %v", volId, err)
 	}

pkg/driver/controller_test.go

@@ -2932,6 +2932,6 @@ func buildDriver(endpoint string, cloud cloud.Cloud, tags string, mounter Mounte
 		endpoint:     endpoint,
 		cloud:        cloud,
 		mounter:      mounter,
-		provisioners: getProvisioners(cloud, mounter, parseTagsFromStr(tags), deleteAccessPointRootDir, false),
+		provisioners: getProvisioners(cloud, mounter, parseTagsFromStr(tags), deleteAccessPointRootDir, false, &FakeOsClient{}, false),
 	}
 }

pkg/driver/driver.go

@@ -52,7 +52,7 @@ type Driver struct {
 	provisioners            map[string]Provisioner
 }
 
-func NewDriver(endpoint, efsUtilsCfgPath, efsUtilsStaticFilesPath, tags string, volMetricsOptIn bool, volMetricsRefreshPeriod float64, volMetricsFsRateLimit int, deleteAccessPointRootDir bool, adaptiveRetryMode bool) *Driver {
+func NewDriver(endpoint, efsUtilsCfgPath, efsUtilsStaticFilesPath, tags string, volMetricsOptIn bool, volMetricsRefreshPeriod float64, volMetricsFsRateLimit int, deleteAccessPointRootDir bool, adaptiveRetryMode bool, deleteProvisionedDir bool) *Driver {
 	cloud, err := cloud.NewCloud(adaptiveRetryMode)
 	if err != nil {
 		klog.Fatalln(err)
@@ -62,7 +62,7 @@ func NewDriver(endpoint, efsUtilsCfgPath, efsUtilsStaticFilesPath, tags string,
 	watchdog := newExecWatchdog(efsUtilsCfgPath, efsUtilsStaticFilesPath, "amazon-efs-mount-watchdog")
 	mounter := newNodeMounter()
 	parsedTags := parseTagsFromStr(strings.TrimSpace(tags))
-	provisioners := getProvisioners(cloud, mounter, parsedTags, deleteAccessPointRootDir, adaptiveRetryMode)
+	provisioners := getProvisioners(cloud, mounter, parsedTags, deleteAccessPointRootDir, adaptiveRetryMode, &RealOsClient{}, deleteProvisionedDir)
 	return &Driver{
 		endpoint:                endpoint,
 		nodeID:                  cloud.GetMetadata().GetInstanceID(),

pkg/driver/os_client.go

@@ -0,0 +1,89 @@
+package driver
+
+import "os"
+
+type OsClient interface {
+	MkDirAllWithPerms(path string, perms os.FileMode, uid, gid int) error
+	MkDirAllWithPermsNoOwnership(path string, perms os.FileMode) error
+	GetPerms(path string) (os.FileMode, error)
+	Remove(path string) error
+	RemoveAll(path string) error
+}
+
+// Real OsClient
+
+type RealOsClient struct{}
+
+func NewOsClient() *RealOsClient {
+	return &RealOsClient{}
+}
+
+func (o *RealOsClient) MkDirAllWithPerms(path string, perms os.FileMode, uid, gid int) error {
+	err := os.MkdirAll(path, perms)
+	if err != nil {
+		return err
+	}
+	// Extra CHMOD guarantees we get the permissions we desire, inspite of the umask
+	err = os.Chmod(path, perms)
+	if err != nil {
+		return err
+	}
+	err = os.Chown(path, uid, gid)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+func (o *RealOsClient) MkDirAllWithPermsNoOwnership(path string, perms os.FileMode) error {
+	err := os.MkdirAll(path, perms)
+	if err != nil {
+		return err
+	}
+	// Extra CHMOD guarantees we get the permissions we desire, inspite of the umask
+	err = os.Chmod(path, perms)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+func (o *RealOsClient) Remove(path string) error {
+	return os.Remove(path)
+}
+
+func (o *RealOsClient) RemoveAll(path string) error {
+	return os.RemoveAll(path)
+}
+
+func (o *RealOsClient) GetPerms(path string) (os.FileMode, error) {
+	fInfo, err := os.Stat(path)
+	if err != nil {
+		return 0, err
+	}
+	return fInfo.Mode(), nil
+}
+
+// Fake OsClient
+
+type FakeOsClient struct{}
+
+func (o *FakeOsClient) MkDirAllWithPerms(_ string, _ os.FileMode, _, _ int) error {
+	return nil
+}
+
+func (o *FakeOsClient) MkDirAllWithPermsNoOwnership(_ string, _ os.FileMode) error {
+	return nil
+}
+
+func (o *FakeOsClient) Remove(_ string) error {
+	return nil
+}
+
+func (o *FakeOsClient) RemoveAll(_ string) error {
+	return nil
+}
+
+func (o *FakeOsClient) GetPerms(_ string) (os.FileMode, error) {
+	return 0, nil
+}

pkg/driver/provisioner.go

@@ -21,7 +21,7 @@ type BaseProvisioner struct {
 	adaptiveRetryMode bool
 }
 
-func getProvisioners(cloud cloud.Cloud, mounter Mounter, tags map[string]string, deleteAccessPointRootDir bool, adaptiveRetryMode bool) map[string]Provisioner {
+func getProvisioners(cloud cloud.Cloud, mounter Mounter, tags map[string]string, deleteAccessPointRootDir bool, adaptiveRetryMode bool, osClient OsClient, deleteProvisionedDir bool) map[string]Provisioner {
 	return map[string]Provisioner{
 		AccessPointMode: AccessPointProvisioner{
 			BaseProvisioner: BaseProvisioner{
@@ -33,6 +33,14 @@ func getProvisioners(cloud cloud.Cloud, mounter Mounter, tags map[string]string,
 			gidAllocator:             NewGidAllocator(),
 			deleteAccessPointRootDir: deleteAccessPointRootDir,
 		},
+		DirectoryMode: DirectoryProvisioner{
+			BaseProvisioner: BaseProvisioner{
+				cloud:   cloud,
+				mounter: mounter,
+			},
+			osClient:             osClient,
+			deleteProvisionedDir: deleteProvisionedDir,
+		},
 	}
 }