From e038f2df3a39a95a18396f1fbfee563b705e4448 Mon Sep 17 00:00:00 2001
From: Silvan Kaiser <silvan@quobyte.com>
Date: Fri, 13 Nov 2015 14:11:26 +0100
Subject: [PATCH] Add basic Quobyte Cinder driver documentation

Gives some short hints on basic concepts of the Quobyte Cinder driver
and where to get help.

Implements: blueprint quobyte-cinder-driver-doc

Change-Id: I25d2b9db329dfad173777c2fe90b9806c28cbe2b
---
 .../block-storage/drivers/quobyte-driver.xml  | 55 +++++++++++++++++++
 .../block-storage/section_misc.xml            |  1 -
 .../block-storage/section_volume-drivers.xml  |  1 +
 3 files changed, 56 insertions(+), 1 deletion(-)
 create mode 100644 doc/config-reference/block-storage/drivers/quobyte-driver.xml

diff --git a/doc/config-reference/block-storage/drivers/quobyte-driver.xml b/doc/config-reference/block-storage/drivers/quobyte-driver.xml
new file mode 100644
index 0000000000..a7d8013c85
--- /dev/null
+++ b/doc/config-reference/block-storage/drivers/quobyte-driver.xml
@@ -0,0 +1,55 @@
+<section xml:id="Quobyte-driver"
+    xmlns="http://docbook.org/ns/docbook"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    version="5.0">
+    <title>Quobyte driver</title>
+
+    <para>The <link xlink:href="http://www.quobyte.com/">Quobyte</link> volume
+    driver enables storing Block Storage service volumes on a Quobyte storage
+    back end. Block Storage service back ends are mapped to Quobyte volumes
+    and individual Block Storage service volumes are stored as files on a
+    Quobyte volume. Selection of the appropriate Quobyte volume is done by the
+    aforementioned back end configuration that specifies the Quobyte volume
+    explicitely.</para>
+
+    <note><para>Note the dual use of the term 'volume' in the context of Block
+    Storage service volumes and in the context of Quobyte volumes.
+    </para></note>
+
+    <para>For more information see
+    <link xlink:href="http://support.quobyte.com/">the Quobyte support webpage
+    </link>.</para>
+
+    <para>The Quobyte volume driver supports the following volume operations:
+    </para>
+    <itemizedlist>
+        <listitem><para>Create, delete, attach, and detach volumes</para>
+        </listitem>
+        <listitem><para>Secure NAS operation (Starting with Mitaka release
+        secure NAS operation is optional but still default)</para></listitem>
+        <listitem><para>Create and delete a snapshot</para></listitem>
+        <listitem><para>Create a volume from a snapshot</para></listitem>
+        <listitem><para>Extend a volume</para></listitem>
+        <listitem><para>Clone a volume</para></listitem>
+        <listitem><para>Copy a volume to image</para></listitem>
+        <listitem><para>Generic volume migration (no back end optimization)
+        </para></listitem>
+    </itemizedlist>
+
+
+    <note><para>When running VM instances off Quobyte volumes, ensure that the
+    <link xlink:href="https://wiki.openstack.org/wiki/Nova/Quobyte">
+    Quobyte Compute service driver</link> has been configured in your
+    OpenStack cloud.</para></note>
+
+    <para>To activate the Quobyte volume driver, configure the corresponding
+    volume_driver parameter:
+    <programlisting>volume_driver = cinder.volume.drivers.quobyte.QuobyteDriver
+    </programlisting></para>
+
+    <para>The following table contains the configuration options
+    supported by the Quobyte driver.</para>
+    <xi:include href="../../../common/tables/cinder-quobyte.xml" />
+
+</section>
diff --git a/doc/config-reference/block-storage/section_misc.xml b/doc/config-reference/block-storage/section_misc.xml
index a7e7e1b4fc..d144fe0fdb 100644
--- a/doc/config-reference/block-storage/section_misc.xml
+++ b/doc/config-reference/block-storage/section_misc.xml
@@ -39,7 +39,6 @@
     <xi:include href="../../common/tables/cinder-profiler.xml"/>
     <xi:include href="../../common/tables/cinder-pure.xml"/>
     <xi:include href="../../common/tables/cinder-qpid.xml"/>
-    <xi:include href="../../common/tables/cinder-quobyte.xml"/>
     <xi:include href="../../common/tables/cinder-quota.xml"/>
     <xi:include href="../../common/tables/cinder-rabbitmq.xml"/>
     <xi:include href="../../common/tables/cinder-redis.xml"/>
diff --git a/doc/config-reference/block-storage/section_volume-drivers.xml b/doc/config-reference/block-storage/section_volume-drivers.xml
index 66ca0b840d..726e904785 100644
--- a/doc/config-reference/block-storage/section_volume-drivers.xml
+++ b/doc/config-reference/block-storage/section_volume-drivers.xml
@@ -43,6 +43,7 @@
     <xi:include href="drivers/nfs-volume-driver.xml"/>
     <xi:include href="drivers/prophetstor-dpl-driver.xml"/>
     <xi:include href="drivers/pure-storage-driver.xml"/>
+    <xi:include href="drivers/quobyte-driver.xml"/>
     <xi:include href="drivers/scality-sofs-driver.xml"/>
     <xi:include href="drivers/sheepdog-driver.xml"/>
     <xi:include href="drivers/smbfs-volume-driver.xml"/>