doc: update README
This commit is contained in:
parent
9134dcca07
commit
76ad4b6f22
20
README.md
20
README.md
@ -3,23 +3,17 @@
|
|||||||
|
|
||||||
### Overview
|
### Overview
|
||||||
|
|
||||||
This is a repository for [NFS](https://en.wikipedia.org/wiki/Network_File_System) [CSI](https://kubernetes-csi.github.io/docs/) Driver.
|
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`
|
||||||
Currently it implements bare minimum of the [CSI spec](https://github.com/container-storage-interface/spec) and is in the alpha state
|
|
||||||
of the development.
|
|
||||||
|
|
||||||
#### CSI Feature matrix
|
### Container Images & Kubernetes Compatibility:
|
||||||
|
|driver version | supported k8s version |
|
||||||
| **nfs.csi.k8s.io** | K8s version compatibility | CSI versions compatibility | Dynamic Provisioning | Resize | Snapshots | Raw Block | AccessModes | Status |
|
|----------------|-----------------------|
|
||||||
|--------------------|---------------------------|----------------------------|----------------------|--------|-----------|-----------|--------------------------|------------------------------------------------------------------------------|
|
|master branch | 1.19+ |
|
||||||
|master | 1.16 + | v1.0 + | yes | no | no | no | Read/Write Multiple Pods | Alpha |
|
|v2.0.0 | 1.14+ |
|
||||||
|v2.0.0 | 1.14 + | v1.0 + | no | no | no | no | Read/Write Multiple Pods | Alpha |
|
|
||||||
|
|
||||||
### Requirements
|
### Requirements
|
||||||
|
|
||||||
The CSI NFS driver requires Kubernetes cluster of version 1.14 or newer and
|
This driver requires existing NFSv3 or NFSv4 server.
|
||||||
preexisting NFS server, whether it is deployed on cluster or provisioned
|
|
||||||
independently. The plugin itself provides only a communication layer between
|
|
||||||
resources in the cluster and the NFS server.
|
|
||||||
|
|
||||||
### Install driver on a Kubernetes cluster
|
### Install driver on a Kubernetes cluster
|
||||||
- install by [kubectl](./docs/install-csi-driver.md)
|
- install by [kubectl](./docs/install-csi-driver.md)
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user