From 3f35bfd4d770adbb31480bec7575787d56eaab50 Mon Sep 17 00:00:00 2001 From: ShyamsundarR Date: Thu, 25 Apr 2019 15:12:36 -0400 Subject: [PATCH] Update README contents Minor reorg of README contents. Also calling out alpha status of the plugins. Signed-off-by: ShyamsundarR --- README.md | 41 +++++++++++++++++++++++++++++------------ 1 file changed, 29 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index fc7850c6f..60fc63eb7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Ceph CSI 1.0.0 +# Ceph CSI [![Go Report Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreportcard.com/report/github.com/ceph/ceph-csi) @@ -11,19 +11,36 @@ and attacher for Ceph RBD and CephFS. ## Overview -Ceph CSI plugins implement an interface between CSI enabled Container -Orchestrator (CO) and CEPH cluster. -It allows dynamically provisioning CEPH volumes and attaching them to -workloads. -Current implementation of Ceph CSI plugins was tested in Kubernetes -environment (requires Kubernetes 1.13+), but the code does not rely on -any Kubernetes specific calls (WIP to make it k8s agnostic) and -should be able to run with any CSI enabled CO. +Ceph CSI plugins implement an interface between CSI enabled Container Orchestrator +(CO) and Ceph cluster. It allows dynamically provisioning Ceph volumes and +attaching them to workloads. -For details about configuration and deployment of RBD and -CephFS CSI plugins, see documentation in `docs/`. +Independent CSI plugins are provided to support RBD and CephFS backed volumes, -For example usage of RBD and CephFS CSI plugins, see examples in `examples/`. +- For details about configuration and deployment of RBD and CephFS CSI plugins, + see documentation in `docs/`. +- For example usage of RBD and CephFS CSI plugins, see examples in `examples/`. + +## 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. + +## 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/). + +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/). ## Support Matrix