Skip to content

Commit 9d2b95a

Browse files
authored
Update driver-parameters.md
1 parent 41f7c32 commit 9d2b95a

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/driver-parameters.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,18 @@ csi.storage.k8s.io/provisioner-secret-namespace | namespace where the secret is
1212
csi.storage.k8s.io/node-stage-secret-name | secret name that stores `username`, `password`(`domain` is optional) | existing secret name | Yes |
1313
csi.storage.k8s.io/node-stage-secret-namespace | namespace where the secret is | existing secret namespace | Yes |
1414

15+
- VolumeID(`volumeHandle`) is the identifier of the volume handled by the driver, format of VolumeID:
16+
```
17+
{smb-server-address}#{sub-dir-name}#{share-name}
18+
```
19+
> `sub-dir-name` could be empty if not provided
20+
1521
### PV/PVC Usage
1622
> get an [example](../deploy/example/pv-smb.yaml)
1723
1824
Name | Meaning | Available Value | Mandatory | Default value
1925
--- | --- | --- | --- | ---
26+
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 smb-server address, sub directory name and share name: `{smb-server-address}#{sub-dir-name}#{share-name}`. | Yes |
2027
volumeAttributes.source | Samba Server address | `//smb-server-address/sharename` </br>([Azure File](https://docs.microsoft.com/en-us/azure/storage/files/storage-files-introduction) format: `//accountname.file.core.windows.net/filesharename`) | Yes |
2128
volumeAttributes.subDir | existing sub directory under smb share | | No | sub directory must exist otherwise mount would fail
2229
nodeStageSecretRef.name | secret name that stores `username`, `password`(`domain` is optional) | existing secret name | Yes |

0 commit comments

Comments
 (0)