Skip to content

Commit 6b243d0

Browse files
authored
Merge pull request #248 from andyzhangx/readme-update
doc: update README
2 parents 9134dcc + 76ad4b6 commit 6b243d0

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

README.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,17 @@
33

44
### Overview
55

6-
This is a repository for [NFS](https://en.wikipedia.org/wiki/Network_File_System) [CSI](https://kubernetes-csi.github.io/docs/) Driver.
7-
Currently it implements bare minimum of the [CSI spec](https://github.com/container-storage-interface/spec) and is in the alpha state
8-
of the development.
6+
This is a repository for [NFS](https://en.wikipedia.org/wiki/Network_File_System) [CSI](https://kubernetes-csi.github.io/docs/) Driver, csi plugin name: `nfs.csi.k8s.io`
97

10-
#### CSI Feature matrix
11-
12-
| **nfs.csi.k8s.io** | K8s version compatibility | CSI versions compatibility | Dynamic Provisioning | Resize | Snapshots | Raw Block | AccessModes | Status |
13-
|--------------------|---------------------------|----------------------------|----------------------|--------|-----------|-----------|--------------------------|------------------------------------------------------------------------------|
14-
|master | 1.16 + | v1.0 + | yes | no | no | no | Read/Write Multiple Pods | Alpha |
15-
|v2.0.0 | 1.14 + | v1.0 + | no | no | no | no | Read/Write Multiple Pods | Alpha |
8+
### Container Images & Kubernetes Compatibility:
9+
|driver version | supported k8s version |
10+
|----------------|-----------------------|
11+
|master branch | 1.19+ |
12+
|v2.0.0 | 1.14+ |
1613

1714
### Requirements
1815

19-
The CSI NFS driver requires Kubernetes cluster of version 1.14 or newer and
20-
preexisting NFS server, whether it is deployed on cluster or provisioned
21-
independently. The plugin itself provides only a communication layer between
22-
resources in the cluster and the NFS server.
16+
This driver requires existing NFSv3 or NFSv4 server.
2317

2418
### Install driver on a Kubernetes cluster
2519
- install by [kubectl](./docs/install-csi-driver.md)

0 commit comments

Comments
 (0)