Merge pull request #306 from andyzhangx/refine-pv-doc

doc: refine PV doc

deploy/example/README.md

@@ -1,7 +1,5 @@
 # CSI driver example
 
-After the NFS CSI Driver is deployed in your cluster, you can follow this documentation to quickly deploy some examples. 
-
 You can use NFS CSI Driver to provision Persistent Volumes statically or dynamically. Please read [Kubernetes Persistent Volumes documentation](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) for more information about Static and Dynamic provisioning.
 
 Please refer to [driver parameters](../../docs/driver-parameters.md) for more detailed usage.
@@ -35,13 +33,7 @@ kubectl create -f https://raw.githubusercontent.com/kubernetes-csi/csi-driver-nf
 kubectl create -f https://raw.githubusercontent.com/kubernetes-csi/csi-driver-nfs/master/deploy/example/pvc-nfs-csi-static.yaml
 ```
 
-## Deployment/Statefulset Usage
+## Create a deployment
-
+```console
-- Follow the following command to create `Deployment` and `Statefulset` .
+kubectl create -f https://raw.githubusercontent.com/kubernetes-csi/csi-driver-nfs/master/deploy/example/deployment.yaml
-
-```bash
-# create Deployment and Statefulset
-git clone https://github.com/kubernetes-csi/csi-driver-nfs.git
-cd csi-driver-nfs
-./hack/verify-examples.sh
 ```

deploy/example/pv-nfs-csi.yaml

@@ -9,8 +9,9 @@ spec:
   accessModes:
     - ReadWriteMany
   persistentVolumeReclaimPolicy: Retain
+  storageClassName: nfs-csi
   mountOptions:
-    - nconnect=8
+    - nconnect=8  # only supported on linux kernel version >= 5.3
     - hard
     - nfsvers=4.1
   csi:

deploy/example/pvc-nfs-csi-static.yaml

@@ -10,4 +10,4 @@ spec:
     requests:
       storage: 10Gi
   volumeName: pv-nfs
-  storageClassName: ""
+  storageClassName: nfs-csi

deploy/example/storageclass-nfs.yaml

@@ -13,6 +13,6 @@ parameters:
 reclaimPolicy: Delete
 volumeBindingMode: Immediate
 mountOptions:
-  - nconnect=8
+  - nconnect=8  # only supported on linux kernel version >= 5.3
   - hard
   - nfsvers=4.1