2018-11-29 18:16:37 +00:00
|
|
|
# Ceph CSI 1.0.0
|
2018-01-20 20:04:38 +00:00
|
|
|
|
2019-04-04 06:43:48 +00:00
|
|
|
This repo containes [Container Storage Interface(CSI)]
|
|
|
|
(<https://github.com/container-storage-interface/>) driver, provisioner,
|
2019-02-07 09:58:38 +00:00
|
|
|
and attacher for Ceph RBD and CephFS.
|
2018-02-06 18:30:05 +00:00
|
|
|
|
2018-07-31 09:31:12 +00:00
|
|
|
## Overview
|
2018-03-26 13:02:34 +00:00
|
|
|
|
2019-02-07 09:58:38 +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.
|
|
|
|
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.
|
2018-03-26 13:02:34 +00:00
|
|
|
|
2019-02-07 09:58:38 +00:00
|
|
|
For details about configuration and deployment of RBD and
|
|
|
|
CephFS CSI plugins, see documentation in `docs/`.
|
2018-03-26 13:02:34 +00:00
|
|
|
|
2018-07-31 09:31:12 +00:00
|
|
|
For example usage of RBD and CephFS CSI plugins, see examples in `examples/`.
|
2018-01-20 20:04:38 +00:00
|
|
|
|
2019-04-04 06:43:48 +00:00
|
|
|
## 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
|
|
|
|
|
|
|
## Slack Channels
|
|
|
|
|
|
|
|
Join us at [Rook ceph-csi Channel](https://rook-io.slack.com/messages/CG3HUV94J/details/)
|