From: Alfredo Deza <adeza@redhat.com>
Date: Thu, 17 Aug 2017 13:25:52 +0000 (-0400)
Subject: doc/ceph-volume create the intro to ceph-volume
X-Git-Tag: v13.0.0~49^2~9
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=68573d0be911a558a02600c6c9937e3a920c871d;p=ceph.git

doc/ceph-volume create the intro to ceph-volume

Signed-off-by: Alfredo Deza <adeza@redhat.com>
---

diff --git a/doc/ceph-volume/intro.rst b/doc/ceph-volume/intro.rst
new file mode 100644
index 000000000000..3869148880cc
--- /dev/null
+++ b/doc/ceph-volume/intro.rst
@@ -0,0 +1,19 @@
+.. _ceph-volume-overview:
+
+Overview
+--------
+The ``ceph-volume`` tool aims to be a single purpose command line tool to deploy
+logical volumes as OSDs, trying to maintain a similar API to ``ceph-disk`` when
+preparing, activating, and creating OSDs.
+
+It deviates from ``ceph-disk`` by not interacting or relying on the udev rules
+that come installed for Ceph. These rules allow automatic detection of
+previously setup devices that are in turn fed into ``ceph-disk`` to activate
+them.
+
+
+``ceph-volume lvm``
+-------------------
+By making use of :term:`LVM tags`, the :ref:`ceph-volume-lvm` sub-command is
+able to store and later re-discover and query devices associated with OSDs so
+that they can later activated.