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

Update README contents

Browse Source 
Minor reorg of README contents.

Also calling out alpha status of the plugins.

Signed-off-by: ShyamsundarR <srangana@redhat.com>
This commit is contained in:
ShyamsundarR 2019-04-25 15:12:36 -04:00 committed by mergify[bot]
parent 4b33c4a9df
commit 3f35bfd4d7
1 changed files with 29 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -1,4 +1,4 @@
# Ceph CSI 1.0.0 # Ceph CSI
[![Go Report [![Go Report
Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreportcard.com/report/github.com/ceph/ceph-csi) 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 ## Overview
Ceph CSI plugins implement an interface between CSI enabled Container Ceph CSI plugins implement an interface between CSI enabled Container Orchestrator
Orchestrator (CO) and CEPH cluster. (CO) and Ceph cluster. It allows dynamically provisioning Ceph volumes and
It allows dynamically provisioning CEPH volumes and attaching them to attaching them to workloads.
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.
For details about configuration and deployment of RBD and Independent CSI plugins are provided to support RBD and CephFS backed volumes,
CephFS CSI plugins, see documentation in `docs/`.
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 ## Support Matrix