doc: refine doc

kubernetes-sigs · Jan 15, 2023 · df6e5ab · df6e5ab
1 parent b53e400
commit df6e5ab
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/deploy/example/pv-azurefile-csi.yaml b/deploy/example/pv-azurefile-csi.yaml
@@ -2,6 +2,8 @@
 apiVersion: v1
 kind: PersistentVolume
 metadata:
+  annotations:
+    pv.kubernetes.io/provisioned-by: file.csi.azure.com
   name: pv-azurefile
 spec:
   capacity:
@@ -22,8 +24,8 @@ spec:
     driver: file.csi.azure.com
     readOnly: false
     # make sure volumeid is unique for every identical share in the cluster
-    # `#` is not allowed in self defined volumeHandle
-    volumeHandle: unique-volumeid
+    # the # character is reserved for internal use
+    volumeHandle: account-name_file-share-name
     volumeAttributes:
       resourceGroup: EXISTING_RESOURCE_GROUP_NAME  # optional, only set this when storage account is not in the same resource group as agent node
       shareName: EXISTING_FILE_SHARE_NAME  # only file share name, don't use full path

diff --git a/deploy/example/pv-azurefile-nfs.yaml b/deploy/example/pv-azurefile-nfs.yaml
@@ -2,6 +2,8 @@
 apiVersion: v1
 kind: PersistentVolume
 metadata:
+  annotations:
+    pv.kubernetes.io/provisioned-by: file.csi.azure.com
   name: pv-azurefile
 spec:
   capacity:
@@ -13,8 +15,8 @@ spec:
     driver: file.csi.azure.com
     readOnly: false
     # make sure volumeid is unique for every identical share in the cluster
-    # `#` is not allowed in self defined volumeHandle
-    volumeHandle: unique-volumeid
+    # the # character is reserved for internal use
+    volumeHandle: account-name_file-share-name
     volumeAttributes:
       resourceGroup: EXISTING_RESOURCE_GROUP_NAME  # optional, only set this when storage account is not in the same resource group as agent node
       storageAccount: EXISTING_STORAGE_ACCOUNT_NAME

diff --git a/docs/driver-parameters.md b/docs/driver-parameters.md
@@ -66,7 +66,7 @@ pvc-92a4d7f2-f23b-4904-bad4-2cbfcff6e388
 
 Name | Meaning | Available Value | Mandatory | Default value
 --- | --- | --- | --- | ---
-volumeHandle | Specify a value the driver can use to uniquely identify the share in the cluster. | A recommended way to produce a unique value is to combine the globally unique storage account name and share name: {account-name}_{file-share-name}. Note: The # character is reserved for internal use and can't be used in a volume handle. | Yes |
+volumeHandle | Specify a value the driver can use to uniquely identify the share in the cluster. | A recommended way to produce a unique value is to combine the globally unique storage account name and share name: {account-name}_{file-share-name}. Note: The # character is reserved for internal use. | 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.shareName | Azure file share name | existing Azure file share name | Yes |