mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-12-23 21:40:20 +00:00
a4ea40cd15
Add link to go-report card and travis build status in readme file. Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
# Ceph CSI 1.0.0
|
|
|
|
[![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)
|
|
|
|
[Container Storage Interface
|
|
(CSI)](https://github.com/container-storage-interface/) driver, provisioner,
|
|
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.
|
|
|
|
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/`.
|
|
|
|
## Troubleshooting
|
|
|
|
Please submit an issue at: [Issues](https://github.com/ceph/ceph-csi/issues)
|
|
|
|
## Slack Channels
|
|
|
|
Join us at [Rook ceph-csi Channel](https://rook-io.slack.com/messages/CG3HUV94J/details/)
|