Merge pull request #248 from andyzhangx/readme-update

doc: update README
This commit is contained in:
Andy Zhang 2021-11-29 13:26:03 +08:00 committed by GitHub
commit 6b243d093e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3,23 +3,17 @@
### Overview
This is a repository for [NFS](https://en.wikipedia.org/wiki/Network_File_System) [CSI](https://kubernetes-csi.github.io/docs/) Driver.
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.
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`
#### CSI Feature matrix
| **nfs.csi.k8s.io** | K8s version compatibility | CSI versions compatibility | Dynamic Provisioning | Resize | Snapshots | Raw Block | AccessModes | Status |
|--------------------|---------------------------|----------------------------|----------------------|--------|-----------|-----------|--------------------------|------------------------------------------------------------------------------|
|master | 1.16 + | v1.0 + | yes | no | no | no | Read/Write Multiple Pods | Alpha |
|v2.0.0 | 1.14 + | v1.0 + | no | no | no | no | Read/Write Multiple Pods | Alpha |
### Container Images & Kubernetes Compatibility:
|driver version | supported k8s version |
|----------------|-----------------------|
|master branch | 1.19+ |
|v2.0.0 | 1.14+ |
### Requirements
The CSI NFS driver requires Kubernetes cluster of version 1.14 or newer and
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.
This driver requires existing NFSv3 or NFSv4 server.
### Install driver on a Kubernetes cluster
- install by [kubectl](./docs/install-csi-driver.md)