doc: refine volumeHandle doc

Author: andyzhangx

deploy/example/e2e_usage.md

@@ -92,7 +92,9 @@ spec:
   csi:
     driver: blob.csi.azure.com
     readOnly: false
-    volumeHandle: unique-volumeid  # make sure this volumeid is unique in the cluster
+    # make sure volumeid is unique for every identical storage blob container in the cluster
+    # character `#` is reserved for internal use and cannot be used in volumehandle
+    volumeHandle: unique-volumeid
     volumeAttributes:
       containerName: EXISTING_CONTAINER_NAME
     nodeStageSecretRef:

deploy/example/pv-blobfuse-auth.yaml

@@ -16,8 +16,8 @@ spec:
   csi:
     driver: blob.csi.azure.com
     readOnly: false
-    # make sure this volumeid is unique in the cluster
-    # `#` is not allowed in self defined volumeHandle
+    # make sure volumeid is unique for every identical storage blob container in the cluster
+    # character `#` is reserved for internal use and cannot be used in volumehandle
     volumeHandle: unique-volumeid
     volumeAttributes:
       resourceGroup: EXISTING_RESOURCE_GROUP_NAME

deploy/example/pv-blobfuse-csi-keyvault.yaml

@@ -13,8 +13,8 @@ spec:
   csi:
     driver: blob.csi.azure.com
     readOnly: false
-    # make sure this volumeid is unique in the cluster
-    # `#` is not allowed in self defined volumeHandle
+    # make sure volumeid is unique for every identical storage blob container in the cluster
+    # character `#` is reserved for internal use and cannot be used in volumehandle
     volumeHandle: unique-volumeid
     volumeAttributes:
       containerName: EXISTING_CONTAINER_NAME

deploy/example/pv-blobfuse-csi.yaml

@@ -16,8 +16,8 @@ spec:
   csi:
     driver: blob.csi.azure.com
     readOnly: false
-    # make sure this volumeid is unique in the cluster
-    # `#` is not allowed in self defined volumeHandle
+    # make sure volumeid is unique for every identical storage blob container in the cluster
+    # character `#` is reserved for internal use and cannot be used in volumehandle
     volumeHandle: unique-volumeid
     volumeAttributes:
       resourceGroup: EXISTING_RESOURCE_GROUP_NAME

deploy/example/pv-blobfuse-nfs.yaml

@@ -13,8 +13,8 @@ spec:
   csi:
     driver: blob.csi.azure.com
     readOnly: false
-    # make sure this volumeid is unique in the cluster
-    # `#` is not allowed in self defined volumeHandle
+    # make sure volumeid is unique for every identical storage blob container in the cluster
+    # character `#` is reserved for internal use and cannot be used in volumehandle
     volumeHandle: unique-volumeid
     volumeAttributes:
       resourceGroup: EXISTING_RESOURCE_GROUP_NAME

docs/driver-parameters.md

@@ -67,6 +67,7 @@ pvc-92a4d7f2-f23b-4904-bad4-2cbfcff6e388
 
 Name | Meaning | Available Value | Mandatory | Default value
 --- | --- | --- | --- | ---
+volumeHandle | a value the driver can use to uniquely identify the storage blob container in the cluster. | A recommended way to produce a unique value is to combine the globally unique storage account name and container name: `{account-name}_{container-name}`. Be aware the character `#` is reserved for internal use and cannot be used in a volume handle. | Yes |
 volumeAttributes.resourceGroup | Azure resource group name | existing resource group name | No | if empty, driver will use the same resource group name as current k8s cluster
 volumeAttributes.storageAccount | existing storage account name | existing storage account name | Yes |
 volumeAttributes.containerName | existing container name | existing container name | Yes |