-
Notifications
You must be signed in to change notification settings - Fork 260
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #264 from andyzhangx/mountoptions-doc
doc: update mountOptions for DeleteVolume doc
- Loading branch information
Showing
2 changed files
with
35 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,46 @@ | ||
## Driver Parameters | ||
> This driver requires existing and already configured NFSv3 or NFSv4 server, it supports dynamic provisioning of Persistent Volumes via Persistent Volume Claims by creating a new sub directory under NFS server. | ||
### Storage Class Usage (Dynamic Provisioning) | ||
### storage class usage (dynamic provisioning) | ||
> [`StorageClass` example](../deploy/example/storageclass-nfs.yaml) | ||
Name | Meaning | Example Value | Mandatory | Default value | ||
--- | --- | --- | --- | --- | ||
server | NFS Server endpoint | Domain name `nfs-server.default.svc.cluster.local` <br>Or IP address `127.0.0.1` | Yes | | ||
server | NFS Server address | domain name `nfs-server.default.svc.cluster.local` <br>or IP address `127.0.0.1` | Yes | | ||
share | NFS share path | `/` | Yes | | ||
|
||
### PV/PVC Usage (Static Provisioning) | ||
### PV/PVC usage (static provisioning) | ||
> [`PersistentVolume` example](../deploy/example/pv-nfs-csi.yaml) | ||
Name | Meaning | Example Value | Mandatory | Default value | ||
--- | --- | --- | --- | --- | ||
volumeAttributes.server | NFS Server endpoint | Domain name `nfs-server.default.svc.cluster.local` <br>Or IP address `127.0.0.1` | Yes | | ||
volumeAttributes.server | NFS Server address | domain name `nfs-server.default.svc.cluster.local` <br>or IP address `127.0.0.1` | Yes | | ||
volumeAttributes.share | NFS share path | `/` | Yes | | ||
|
||
|
||
### Tips | ||
#### provide `mountOptions` for `DeleteVolume` | ||
> since `DeleteVolumeRequest` does not provide `mountOptions`, following is the workaround to provide `mountOptions` for `DeleteVolume`, check details [here](https://github.com/kubernetes-csi/csi-driver-nfs/issues/260) | ||
- create a secret with `mountOptions` | ||
```console | ||
kubectl create secret generic mount-options --from-literal mountOptions="nfsvers=3" | ||
``` | ||
- define a storage class with `csi.storage.k8s.io/provisioner-secret-name` and `csi.storage.k8s.io/provisioner-secret-namespace` setting: | ||
```yaml | ||
apiVersion: storage.k8s.io/v1 | ||
kind: StorageClass | ||
metadata: | ||
name: nfs-csi | ||
provisioner: nfs.csi.k8s.io | ||
parameters: | ||
server: nfs-server.default.svc.cluster.local | ||
share: / | ||
# csi.storage.k8s.io/provisioner-secret is only needed for providing mountOptions in DeleteVolume | ||
csi.storage.k8s.io/provisioner-secret-name: "mount-options" | ||
csi.storage.k8s.io/provisioner-secret-namespace: "default" | ||
reclaimPolicy: Delete | ||
volumeBindingMode: Immediate | ||
mountOptions: | ||
- hard | ||
- nfsvers=3 | ||
``` |