Skip to content

Commit f7ed9ea

Browse files
Implement requested changes
Signed-off-by: Thomas Spear <81998567+tspearconquest@users.noreply.github.com>
1 parent e3971fa commit f7ed9ea

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/driver-parameters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ protocol | file share protocol | `smb`, `nfs` | No | `smb`
4747
networkEndpointType | specify network endpoint type for the storage account created by driver. If `privateEndpoint` is specified, a private endpoint will be created for the storage account. For other cases, a service endpoint will be created for `nfs` protocol by default. | "",`privateEndpoint` | No | `` <br>for AKS cluster, make sure cluster Control plane identity (that is, your AKS cluster name) is added to the Contributor role in the resource group hosting the VNet
4848
location | specify Azure storage account location | `eastus`, `westus`, etc. | No | if empty, driver will use the same location name as current k8s cluster
4949
resourceGroup | specify the resource group in which Azure file share will be created | existing resource group name | No | if empty, driver will use the same resource group name as current k8s cluster
50-
clientID | specify Azure client ID who will create Azure file share | Azure client ID | No | if empty, kubelet MID will be used
5150
subscriptionID | specify Azure subscription ID where Azure file share will be created | Azure subscription ID | No | if not empty, `resourceGroup` must be provided
5251
shareName | specify Azure file share name | existing or new Azure file name | No | if empty, driver will generate an Azure file share name
5352
shareNamePrefix | specify Azure file share name prefix created by driver | can only contain lowercase letters, numbers, hyphens, and length should be less than 21 | No |
@@ -71,6 +70,7 @@ secretName | specify secret name to store account key | | No |
7170
secretNamespace | specify the namespace of secret to store account key | `default`,`kube-system`, etc | No | pvc namespace (`csi.storage.k8s.io/pvc/namespace`)
7271
useDataPlaneAPI | specify whether use [data plane API](https://github.com/Azure/azure-sdk-for-go/blob/master/storage/share.go) for file share create/delete/resize, this could solve the SRP API throttling issue since data plane API has almost no limit, while it would fail when there is firewall or vnet setting on storage account | `true`,`false` | No | `false`
7372
enableMultichannel | specify whether enable [SMB multi-channel](https://learn.microsoft.com/en-us/azure/storage/files/files-smb-protocol?tabs=azure-portal#smb-multichannel) for **Premium** storage account <br> Note: this feature is used with `max_channels=4` (or 2,3) mount option | `true`,`false` | No | `false`
73+
clientID | specify Azure client ID who will create Azure file share | Azure client ID | No | if empty, kubelet managed identity will be used
7474
--- | **Following parameters are only for NFS protocol** | --- | --- |
7575
allowSharedKeyAccess | Allow or disallow shared key access for storage account created by driver | `true`,`false` | No | `true`
7676
rootSquashType | specify root squashing behavior on the share. The default is `NoRootSquash` | `AllSquash`, `NoRootSquash`, `RootSquash` | No |
@@ -108,7 +108,6 @@ pvc-92a4d7f2-f23b-4904-bad4-2cbfcff6e388
108108
Name | Meaning | Available Value | Mandatory | Default value
109109
--- | --- | --- | --- | ---
110110
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}. If you plan to use resize, you must follow the VolumeID format in Dynamic Provisioning. | Yes |
111-
volumeAttributes.clientID | specify Azure client ID who will mount Azure file share | Azure client ID | No | if empty, kubelet MID will be used
112111
volumeAttributes.subscriptionID | specify Azure subscription ID where Azure file share is located | Azure subscription ID | No | if not empty, `resourceGroup` must be provided
113112
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
114113
volumeAttributes.storageAccount | existing storage account name | existing storage account name | Yes |
@@ -121,6 +120,7 @@ volumeAttributes.storageEndpointSuffix | specify Azure storage endpoint suffix |
121120
volumeAttributes.secretName | secret name that stores storage account name and key | | No |
122121
volumeAttributes.secretNamespace | secret namespace | `default`,`kube-system`, etc | No | pvc namespace (`csi.storage.k8s.io/pvc/namespace`)
123122
volumeAttributes.getLatestAccountKey | whether getting the latest account key based on the creation time, this driver would get the first key by default | `true`,`false` | No | `false`
123+
volumeAttributes.clientID | specify Azure client ID who will mount Azure file share | Azure client ID | No | if empty, kubelet managed identity will be used
124124
nodeStageSecretRef.name | secret name that stores storage account name and key | existing secret name | Yes |
125125
nodeStageSecretRef.namespace | secret namespace | k8s namespace | Yes |
126126
--- | **Following parameters are only for NFS protocol** | --- | --- |

0 commit comments

Comments
 (0)