Skip to content

Commit 18833b3

Browse files
committed
doc: fix volumeHandle format
1 parent 2a7c580 commit 18833b3

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

deploy/example/nfs-provisioner/nginx-pod.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ spec:
1616
- nfsvers=4.1
1717
csi:
1818
driver: nfs.csi.k8s.io
19-
# volumeHandle format: {nfs-server-address}#{sub-dir-name}#{share-name}
19+
# volumeHandle format: {nfs-server-address}#{share-name}#{sub-dir-name}
2020
# make sure this value is unique for every share in the cluster
2121
volumeHandle: nfs-server.default.svc.cluster.local/share##
2222
volumeAttributes:

deploy/example/pv-nfs-csi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ spec:
1616
- nfsvers=4.1
1717
csi:
1818
driver: nfs.csi.k8s.io
19-
# volumeHandle format: {nfs-server-address}#{sub-dir-name}#{share-name}
19+
# volumeHandle format: {nfs-server-address}#{share-name}#{sub-dir-name}
2020
# make sure this value is unique for every share in the cluster
2121
volumeHandle: nfs-server.default.svc.cluster.local/share##
2222
volumeAttributes:

docs/driver-parameters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ onDelete | when volume is deleted, keep the directory if it's `retain` | `delete
1414

1515
- VolumeID(`volumeHandle`) is the identifier of the volume handled by the driver, format of VolumeID:
1616
```
17-
{nfs-server-address}#{sub-dir-name}#{share-name}
17+
{nfs-server-address}#{share-name}#{sub-dir-name}
1818
```
1919
> example: `nfs-server.default.svc.cluster.local/share#subdir#`
2020
@@ -23,7 +23,7 @@ onDelete | when volume is deleted, keep the directory if it's `retain` | `delete
2323
2424
Name | Meaning | Example Value | Mandatory | Default value
2525
--- | --- | --- | --- | ---
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 nfs-server address, sub directory name and share name: `{nfs-server-address}#{sub-dir-name}#{share-name}`. | Yes |
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 nfs-server address, sub directory name and share name: `{nfs-server-address}#{share-name}#{sub-dir-name}`. | Yes |
2727
volumeAttributes.server | NFS Server address | domain name `nfs-server.default.svc.cluster.local` <br>or IP address `127.0.0.1` | Yes |
2828
volumeAttributes.share | NFS share path | `/` | Yes |
2929
volumeAttributes.mountPermissions | mounted folder permissions. The default is `0`, if set as non-zero, driver will perform `chmod` after mount | | No |

0 commit comments

Comments
 (0)