Add pointers and sidecar information in the README

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
This commit is contained in:
Humble Chirammal 2019-06-10 14:07:24 +05:30
parent 47d4e44af0
commit 9b384f38e6

View File

@ -6,8 +6,9 @@ Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreport
Status](https://travis-ci.org/ceph/ceph-csi.svg?branch=master)](https://travis-ci.org/ceph/ceph-csi) 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)] This repo contains [Container Storage Interface(CSI)]
(<https://github.com/container-storage-interface/>) driver, provisioner, (<https://github.com/container-storage-interface/>) Ceph CSI driver for RBD,
and attacher for Ceph RBD and CephFS. CephFS and kubernetes sidecar deployment yamls of provisioner, attacher,
node-driver-registrar and snapshotter for supporting CSI functionalities.
## Overview ## Overview
@ -17,8 +18,10 @@ attaching them to workloads.
Independent CSI plugins are provided to support RBD and CephFS backed volumes, Independent CSI plugins are provided to support RBD and CephFS backed volumes,
- For details about configuration and deployment of RBD and CephFS CSI plugins, - For details about configuration and deployment of RBD plugin, please refer
see documentation in `docs/`. [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/`. - For example usage of RBD and CephFS CSI plugins, see examples in `examples/`.
## Project status ## Project status