From 9b384f38e66b01a844ebd5cef16fce7775b56a9c Mon Sep 17 00:00:00 2001 From: Humble Chirammal Date: Mon, 10 Jun 2019 14:07:24 +0530 Subject: [PATCH] Add pointers and sidecar information in the README Signed-off-by: Humble Chirammal --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7183f8b88..b190dad3f 100644 --- a/README.md +++ b/README.md @@ -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) This repo contains [Container Storage Interface(CSI)] -() driver, provisioner, -and attacher for Ceph RBD and CephFS. +() Ceph CSI driver for RBD, +CephFS and kubernetes sidecar deployment yamls of provisioner, attacher, +node-driver-registrar and snapshotter for supporting CSI functionalities. ## Overview @@ -17,8 +18,10 @@ attaching them to workloads. Independent CSI plugins are provided to support RBD and CephFS backed volumes, -- For details about configuration and deployment of RBD and CephFS CSI plugins, - see documentation in `docs/`. +- 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