Skip to content

Commit e0df4f3

Browse files
authored
doc: Revise blobfuse parameters and account key tips
Updated descriptions for blobfuse parameters and tips for account key management.
1 parent f6071a1 commit e0df4f3

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
@@ -65,7 +65,7 @@ softDeleteBlobs | Enable [soft delete for blobs](https://learn.microsoft.com/en-
6565
softDeleteContainers | Enable [soft delete for containers](https://learn.microsoft.com/en-us/azure/storage/blobs/soft-delete-container-overview), specify the days to retain deleted containers | "7" | No | Soft Delete Containers is disabled if empty
6666
enableBlobVersioning | Enable [blob versioning](https://learn.microsoft.com/en-us/azure/storage/blobs/versioning-overview), can't enabled when `protocol` is `nfs` or `isHnsEnabled` is `true` | `true`,`false` | No | versioning for blobs is disabled if empty
6767
--- | **Following parameters are only for blobfuse** | --- | --- |
68-
storeAccountKey | Should the storage account key be stored in a Kubernetes secret <br> (Note: if set to `false`, the driver will use the kubelet identity to obtain the account key) | `true`,`false` | No | `true`
68+
storeAccountKey | Should the storage account key be stored in a Kubernetes secret <br> (Note: if set to `false`, the driver will use the kubelet identity to obtain the account key during volume mount) | `true`,`false` | No | `true`
6969
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`
7070
secretName | specify secret name to store account key | | No |
7171
secretNamespace | specify the namespace of secret to store account key | `default`,`kube-system`, etc | No | pvc namespace
@@ -148,7 +148,7 @@ kubectl create secret generic azure-secret --from-literal azurestoragespnclients
148148
```
149149

150150
### Tips
151-
- mounting blobfuse requires account key, if `nodeStageSecretRef` field is not provided in PV config, azure file driver would try to get `azure-storage-account-{accountname}-secret` in the pod namespace first, if that secret does not exist, it would get account key by Azure storage account API directly using kubelet identity (make sure kubelet identity has reader access to the storage account).
151+
- mounting blobfuse requires account key, if `nodeStageSecretRef` field is not provided in PV config, azure file driver would try to get `azure-storage-account-{accountname}-secret` in the pod namespace first, if that secret does not exist, the driver will use the kubelet identity to obtain the account key during volume mount (make sure kubelet identity has reader access to the storage account).
152152
> If you have recently rotated the account key, it is important to update the account key stored in the Kubernetes secret. Additionally, the application pods that reference the Azure blob volume should be restarted after the secret has been updated. In cases where two pods share the same PVC on the same node, it is necessary to reschedule the pods to a different node without that PVC mounted to ensure that remounting occurs successfully. To safely rotate the account key without experiencing downtime, you can follow the steps outlined [here](https://github.com/kubernetes-sigs/azurefile-csi-driver/issues/1218#issuecomment-1851996062).
153153
- mounting blob storage NFSv3 does not need account key, NFS mount access is configured by following setting:
154154
- `Firewalls and virtual networks`: select `Enabled from selected virtual networks and IP addresses` with same vnet as agent node

0 commit comments

Comments
 (0)