ceph-csi/README.md

99 lines
4.5 KiB
Markdown
Raw Normal View History

# Ceph CSI
2018-01-20 20:04:38 +00:00
[![Go Report
Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreportcard.com/report/github.com/ceph/ceph-csi)
[![Build
Status](https://travis-ci.org/ceph/ceph-csi.svg?branch=master)](https://travis-ci.org/ceph/ceph-csi)
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,
node-driver-registrar and snapshotter for supporting CSI functionalities.
2018-07-31 09:31:12 +00:00
## Overview
2018-03-26 13:02:34 +00:00
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.
2018-03-26 13:02:34 +00:00
Independent CSI plugins are provided to support RBD and CephFS backed volumes,
2018-03-26 13:02:34 +00:00
- For details about configuration and deployment of RBD plugin, please refer
[rbd doc](https://github.com/ceph/ceph-csi/blob/master/docs/deploy-rbd.md) and
for CephFS plugin configuration and deployment please
refer [cephfs doc](https://github.com/ceph/ceph-csi/blob/master/docs/deploy-cephfs.md).
- 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/).
2018-01-20 20:04:38 +00:00
## 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 |
### CSI spec and Kubernetes version compatibility
Please refer to the [matrix](https://kubernetes-csi.github.io/docs/#kubernetes-releases)
in the Kubernetes documentation.
## Contributing to this repo
Please follow [development-guide]
(<https://github.com/ceph/ceph-csi/tree/master/docs/development-guide.md>) and
[coding style guidelines](<https://github.com/ceph/ceph-csi/tree/master/docs/coding.md>)
if you are interested to contribute to this repo.
2018-01-20 20:04:38 +00:00
## Troubleshooting
2018-07-31 09:31:12 +00:00
Please submit an issue at: [Issues](https://github.com/ceph/ceph-csi/issues)
2019-02-11 14:07:22 +00:00
## Contact
2019-02-11 14:07:22 +00:00
Please use the following to reach members of the community:
- Slack: Join our [slack channel](https://cephcsi.slack.com)
- Forums: [ceph-csi](https://groups.google.com/forum/#!forum/ceph-csi)
- Twitter: [@CephCsi](https://twitter.com/CephCsi)