Merge pull request #565 from andyzhangx/disable-volume-stat

feat: disable GET_VOLUME_STATS by default

Author: andyzhangx

README.md

@@ -15,7 +15,7 @@ This driver allows Kubernetes to access Azure Storage through one of following m
 ### Container Images & Kubernetes Compatibility:
 |driver version  |Image                                      | supported k8s version | built-in blobfuse version |
 |----------------|-------------------------------------------|-----------------------|---------------------------|
-|master branch   |mcr.microsoft.com/k8s/csi/blob-csi:latest  | 1.18+                 | 1.4.1                     |
+|master branch   |mcr.microsoft.com/k8s/csi/blob-csi:latest  | 1.19+                 | 1.4.1                     |
 |v1.6.0          |mcr.microsoft.com/k8s/csi/blob-csi:v1.6.0  | 1.18+                 | 1.4.1                     |
 |v1.5.0          |mcr.microsoft.com/k8s/csi/blob-csi:v1.5.0  | 1.18+                 | 1.4.1                     |
 |v1.4.0          |mcr.microsoft.com/k8s/csi/blob-csi:v1.4.0  | 1.18+                 | 1.3.8                     |

charts/README.md

@@ -59,6 +59,7 @@ The following table lists the configurable parameters of the latest Azure Blob S
 | `driver.customUserAgent`                              | custom userAgent                                      | `` |
 | `driver.userAgentSuffix`                              | userAgent suffix                                      | `OSS-helm` |
 | `feature.enableFSGroupPolicy`                         | enable `fsGroupPolicy` on a k8s 1.20+ cluster         | `false`                      |
+| `feature.enableGetVolumeStats`                        | allow GET_VOLUME_STATS on agent node                  | `false`                      |
 | `image.baseRepo`                                      | base repository of driver images                      | `mcr.microsoft.com`                      |
 | `image.blob.repository`                               | blob-csi-driver docker image                          | `mcr.microsoft.com/k8s/csi/blob-csi`                             |
 | `image.blob.tag`                                      | blob-csi-driver docker image tag                      | `latest`                                                         |

charts/latest/blob-csi-driver-v1.6.0.tgz

@@ -122,6 +122,7 @@ spec:
             - "--custom-user-agent={{ .Values.driver.customUserAgent }}"
             - "--user-agent-suffix={{ .Values.driver.userAgentSuffix }}"
             - "--allow-empty-cloud-config={{ .Values.node.allowEmptyCloudConfig }}"
+            - "--enable-get-volume-stats={{ .Values.feature.enableGetVolumeStats }}"
           ports:
             - containerPort: {{ .Values.node.livenessProbe.healthPort }}
               name: healthz

charts/latest/blob-csi-driver/templates/csi-blob-node.yaml

@@ -138,6 +138,7 @@ node:
 
 feature:
   enableFSGroupPolicy: false
+  enableGetVolumeStats: false
 
 driver:
   name: blob.csi.azure.com

charts/latest/blob-csi-driver/values.yaml

@@ -119,6 +119,7 @@ type DriverOptions struct {
 	BlobfuseProxyConnTimout    int
 	EnableBlobMockMount        bool
 	AllowEmptyCloudConfig      bool
+	EnableGetVolumeStats       bool
 }
 
 // Driver implements all interfaces of CSI drivers
@@ -134,6 +135,7 @@ type Driver struct {
 	enableBlobMockMount     bool
 	enableBlobfuseProxy     bool
 	allowEmptyCloudConfig   bool
+	enableGetVolumeStats    bool
 	blobfuseProxyConnTimout int
 	mounter                 *mount.SafeFormatAndMount
 	volLockMap              *util.LockMap
@@ -164,6 +166,7 @@ func NewDriver(options *DriverOptions) *Driver {
 		blobfuseProxyConnTimout:    options.BlobfuseProxyConnTimout,
 		enableBlobMockMount:        options.EnableBlobMockMount,
 		allowEmptyCloudConfig:      options.AllowEmptyCloudConfig,
+		enableGetVolumeStats:       options.EnableGetVolumeStats,
 	}
 	d.Name = options.DriverName
 	d.Version = driverVersion
@@ -216,11 +219,14 @@ func (d *Driver) Run(endpoint, kubeconfig string, testBool bool) {
 		csi.VolumeCapability_AccessMode_MULTI_NODE_MULTI_WRITER,
 	})
 
-	d.AddNodeServiceCapabilities([]csi.NodeServiceCapability_RPC_Type{
+	nodeCap := []csi.NodeServiceCapability_RPC_Type{
 		csi.NodeServiceCapability_RPC_STAGE_UNSTAGE_VOLUME,
-		csi.NodeServiceCapability_RPC_GET_VOLUME_STATS,
 		csi.NodeServiceCapability_RPC_SINGLE_NODE_MULTI_WRITER,
-	})
+	}
+	if d.enableGetVolumeStats {
+		nodeCap = append(nodeCap, csi.NodeServiceCapability_RPC_GET_VOLUME_STATS)
+	}
+	d.AddNodeServiceCapabilities(nodeCap)
 
 	s := csicommon.NewNonBlockingGRPCServer()
 	// Driver d act as IdentityServer, ControllerServer and NodeServer

pkg/blob/blob.go

@@ -43,14 +43,15 @@ var (
 	metricsAddress             = flag.String("metrics-address", "0.0.0.0:29634", "export the metrics")
 	kubeconfig                 = flag.String("kubeconfig", "", "Absolute path to the kubeconfig file. Required only when running out of cluster.")
 	driverName                 = flag.String("drivername", blob.DefaultDriverName, "name of the driver")
-	enableBlobfuseProxy        = flag.Bool("enable-blobfuse-proxy", false, "Whether using blobfuse proxy for mounts")
+	enableBlobfuseProxy        = flag.Bool("enable-blobfuse-proxy", false, "using blobfuse proxy for mounts")
 	blobfuseProxyConnTimout    = flag.Int("blobfuse-proxy-connect-timeout", 5, "blobfuse proxy connection timeout(seconds)")
-	enableBlobMockMount        = flag.Bool("enable-blob-mock-mount", false, "Whether enable mock mount(only for testing)")
+	enableBlobMockMount        = flag.Bool("enable-blob-mock-mount", false, "enable mock mount(only for testing)")
 	cloudConfigSecretName      = flag.String("cloud-config-secret-name", "azure-cloud-provider", "secret name of cloud config")
 	cloudConfigSecretNamespace = flag.String("cloud-config-secret-namespace", "kube-system", "secret namespace of cloud config")
 	customUserAgent            = flag.String("custom-user-agent", "", "custom userAgent")
 	userAgentSuffix            = flag.String("user-agent-suffix", "", "userAgent suffix")
-	allowEmptyCloudConfig      = flag.Bool("allow-empty-cloud-config", true, "Whether allow running driver without cloud config")
+	allowEmptyCloudConfig      = flag.Bool("allow-empty-cloud-config", true, "allow running driver without cloud config")
+	enableGetVolumeStats       = flag.Bool("enable-get-volume-stats", false, "allow GET_VOLUME_STATS on agent node")
 )
 
 func main() {
@@ -83,6 +84,7 @@ func handle() {
 		CustomUserAgent:            *customUserAgent,
 		UserAgentSuffix:            *userAgentSuffix,
 		AllowEmptyCloudConfig:      *allowEmptyCloudConfig,
+		EnableGetVolumeStats:       *enableGetVolumeStats,
 	}
 	driver := blob.NewDriver(&driverOptions)
 	if driver == nil {