Skip to content

Commit

Permalink
README update for v1.1.0 release
Browse files Browse the repository at this point in the history 
Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
  • Loading branch information
@humblec
humblec committed Jul 12, 2019
1 parent fa68c35 commit 5531c36
Showing 1 changed file with 36 additions and 33 deletions.
69 changes: 36 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreport
[![Build
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)]
(<https://github.com/container-storage-interface/>) Ceph CSI driver for RBD,
CephFS and kubernetes sidecar deployment yamls of provisioner, attacher,
Expand All @@ -26,52 +37,44 @@ Independent CSI plugins are provided to support RBD and CephFS backed volumes,

## Project status

Status: **Alpha**

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.
Status: **GA**

## Supported CO platforms

Ceph CSI drivers are currently developed and tested **exclusively** on Kubernetes
environments. There is work in progress to make this CO independent and thus
support other orchestration environments in the future.

For Kubernetes versions 1.11 and 1.12, please use [0.3 images and
deployments](https://github.com/ceph/ceph-csi/tree/csi-v0.3/deploy/).
NOTE:

For Kubernetes versions 1.13 and above, please use [1.0 images and
deployments](https://github.com/ceph/ceph-csi/tree/csi-v1.0/deploy/).
- **`csiv0.3`** is deprecated with release of **`csi v1.1.0`**

## Support Matrix

### Ceph-CSI features and available versions

| Plugin | Features | CSI driver Version |
|--------|-----------------------------------------------------------|--------------------|
| CephFS | Dynamically provision, de-provision File mode RWO volume | >=v0.3.0 |
| | Dynamically provision, de-provision File mode RWX volume | >=v0.3.0 |
| | Creating and deleting snapshot | - |
| | Provision volume from snapshot | - |
| | Provision volume from another volume | - |
| | Resize volume | - |
| | | |
| RBD | Dynamically provision, de-provision Block mode RWO volume | >=v0.3.0 |
| | Dynamically provision, de-provision Block mode RWX volume | >=v0.3.0 |
| | Dynamically provision, de-provision File mode RWO volume | v1.0.0 |
| | Creating and deleting snapshot | >=v0.3.0 |
| | Provision volume from snapshot | v1.0.0 |
| | Provision volume from another volume | - |
| | Resize volume | - |

### Ceph-CSI versions and CSI spec compatibility

| Ceph CSI driver Version | CSI spec version |
|-------------------------|------------------|
| v0.3.0 | v0.3 |
| v1.0.0 | v1.0.0 |
| Plugin | Features | Feature Status | CSI Driver Version | CSI Spec Version | Ceph Cluster Version | Kubernetes Version |
|--------|-----------------------------------------------------------|----------------|--------------------|------------------|----------------------|--------------------|
| RBD | Dynamically provision, de-provision Block mode RWO volume | GA | >=v1.0.0 | >=v1.0.0 | >= Mimic | >= v13.0.0 |

This comment has been minimized.

Sign in to view

Copy link
@dillaman

dillaman Jul 30, 2019

Quick question (against this merged PR): what is k8s version v13.0.0? Are all of these supposed to be v1.13?
| | Dynamically provision, de-provision Block mode RWX volume | GA | >=v1.0.0 | >=v1.0.0 | >= Mimic | >= v13.0.0 |
| | Dynamically provision, de-provision File mode RWO volume | GA | >=v1.0.0 | >=v1.0.0 | >= Mimic | >= v13.0.0 |
| | Creating and deleting snapshot | Alpha | >=v1.0.0 | >=v1.0.0 | >= Mimic | >= v13.0.0 |
| | Provision volume from snapshot | Alpha | >=v1.0.0 | >=v1.0.0 | >= Mimic | >= v13.0.0 |
| | Provision volume from another volume | - | - | - | - | - |
| | Resize volume | - | - | - | - | - |
| | Metrics Support | - | - | - | - | - |
| 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 RWX volume | Alpha | >=v1.1.0 | >=v1.0.0 | Nautilus | >=v13.0.0 |
| | Creating and deleting snapshot | - | - | - | - | - |
| | Provision volume from snapshot | - | - | - | - | - |
| | Provision volume from another volume | - | - | - | - | - |
| | Resize volume | - | - | - | - | - |
| | Metrics | - | - | - | - | - |
| | | | | | | |

`NOTE`: The `Alpha` status reflects possible non-backward
compatible changes in the future, and is thus not recommended
for production use.

### CSI spec and Kubernetes version compatibility

Expand Down

0 comments on commit 5531c36

Please sign in to comment.