mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2024-11-27 00:30:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #468 from humblec/readme

Browse Source 
README update for v1.1.0 release
This commit is contained in:
Humble Devassy Chirammal 2019-07-12 13:24:16 +05:30 committed by GitHub
commit 4b3bf68b37
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@ -5,6 +5,17 @@ Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreport
[![Build [![Build
Status](https://travis-ci.org/ceph/ceph-csi.svg?branch=master)](https://travis-ci.org/ceph/ceph-csi) Status](https://travis-ci.org/ceph/ceph-csi.svg?branch=master)](https://travis-ci.org/ceph/ceph-csi)
- [Ceph CSI](#Ceph-CSI)
- [Overview](#Overview)
- [Project status](#Project-status)
- [Supported CO platforms](#Supported-CO-platforms)
- [Support Matrix](#Support-Matrix)
- [Ceph-CSI features and available versions](#Ceph-CSI-features-and-available-versions)
- [CSI spec and Kubernetes version compatibility](#CSI-spec-and-Kubernetes-version-compatibility)
- [Contributing to this repo](#Contributing-to-this-repo)
- [Troubleshooting](#Troubleshooting)
- [Contact](#Contact)
This repo contains [Container Storage Interface(CSI)] This repo contains [Container Storage Interface(CSI)]
(<https://github.com/container-storage-interface/>) Ceph CSI driver for RBD, (<https://github.com/container-storage-interface/>) Ceph CSI driver for RBD,
CephFS and kubernetes sidecar deployment yamls of provisioner, attacher, CephFS and kubernetes sidecar deployment yamls of provisioner, attacher,
@ -26,12 +37,7 @@ Independent CSI plugins are provided to support RBD and CephFS backed volumes,
## Project status ## Project status
Status: **Alpha** Status: **GA**
The **alpha** status reflects possible non-backward compatible changes in the
future, and is thus not recommended for production use. There is work in progress
that would change on-disk metadata for certain operations, possibly breaking
backward compatibility.
## Supported CO platforms ## Supported CO platforms
@ -39,39 +45,36 @@ Ceph CSI drivers are currently developed and tested **exclusively** on Kubernete
environments. There is work in progress to make this CO independent and thus environments. There is work in progress to make this CO independent and thus
support other orchestration environments in the future. support other orchestration environments in the future.
For Kubernetes versions 1.11 and 1.12, please use [0.3 images and NOTE:
deployments](https://github.com/ceph/ceph-csi/tree/csi-v0.3/deploy/).
For Kubernetes versions 1.13 and above, please use [1.0 images and - **`csiv0.3`** is deprecated with release of **`csi v1.1.0`**
deployments](https://github.com/ceph/ceph-csi/tree/csi-v1.0/deploy/).
## Support Matrix ## Support Matrix
### Ceph-CSI features and available versions ### Ceph-CSI features and available versions
| Plugin | Features | CSI driver Version | | Plugin | Features | Feature Status | CSI Driver Version | CSI Spec Version | Ceph Cluster Version | Kubernetes Version |
|--------|-----------------------------------------------------------|--------------------| |--------|-----------------------------------------------------------|----------------|--------------------|------------------|----------------------|--------------------|
| CephFS | Dynamically provision, de-provision File mode RWO volume | >=v0.3.0 | | RBD | Dynamically provision, de-provision Block mode RWO volume | GA | >=v1.0.0 | >=v1.0.0 | >= Mimic | >= v13.0.0 |
| | Dynamically provision, de-provision File mode RWX volume | >=v0.3.0 | | | Dynamically provision, de-provision Block mode RWX volume | GA | >=v1.0.0 | >=v1.0.0 | >= Mimic | >= v13.0.0 |
| | Creating and deleting snapshot | - | | | Dynamically provision, de-provision File mode RWO volume | GA | >=v1.0.0 | >=v1.0.0 | >= Mimic | >= v13.0.0 |
| | Provision volume from snapshot | - | | | Creating and deleting snapshot | Alpha | >=v1.0.0 | >=v1.0.0 | >= Mimic | >= v13.0.0 |
| | Provision volume from another volume | - | | | Provision volume from snapshot | Alpha | >=v1.0.0 | >=v1.0.0 | >= Mimic | >= v13.0.0 |
| | Resize volume | - | | | Provision volume from another volume | - | - | - | - | - |
| | | | | | Resize volume | - | - | - | - | - |
| RBD | Dynamically provision, de-provision Block mode RWO volume | >=v0.3.0 | | | Metrics Support | - | - | - | - | - |
| | Dynamically provision, de-provision Block mode RWX volume | >=v0.3.0 | | CephFS | Dynamically provision, de-provision File mode RWO volume | Alpha | >=v1.1.0 | >=v1.0.0 | Nautilus | >=v13.0.0 |
| | Dynamically provision, de-provision File mode RWO volume | v1.0.0 | | | Dynamically provision, de-provision File mode RWX volume | Alpha | >=v1.1.0 | >=v1.0.0 | Nautilus | >=v13.0.0 |
| | Creating and deleting snapshot | >=v0.3.0 | | | Creating and deleting snapshot | - | - | - | - | - |
| | Provision volume from snapshot | v1.0.0 | | | Provision volume from snapshot | - | - | - | - | - |
| | Provision volume from another volume | - | | | Provision volume from another volume | - | - | - | - | - |
| | Resize volume | - | | | Resize volume | - | - | - | - | - |
| | Metrics | - | - | - | - | - |
| | | | | | | |
### Ceph-CSI versions and CSI spec compatibility `NOTE`: The `Alpha` status reflects possible non-backward
compatible changes in the future, and is thus not recommended
| Ceph CSI driver Version | CSI spec version | for production use.
|-------------------------|------------------|
| v0.3.0 | v0.3 |
| v1.0.0 | v1.0.0 |
### CSI spec and Kubernetes version compatibility ### CSI spec and Kubernetes version compatibility