From 3b2a93742c4f744815f0b1cf1cf670f783b92076 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.de>
Date: Wed, 18 Feb 2015 18:51:25 +0100
Subject: [PATCH] Add some minimal volume driver description

Document Datera, FusionIO and Nimble volume drivers in a minimal way
using information that was quickly accessible.

The format follows the proposed blueprint.

Implements bp move-driver-docs

Change-Id: Ib695e3a293d9a6915612e38452999a29dd34286c
---
 .../drivers/datera-volume-driver.xml          | 21 ++++++++++++++++++
 .../drivers/fusionio-volume-driver.xml        | 22 +++++++++++++++++++
 .../drivers/nimble-volume-driver.xml          | 22 +++++++++++++++++++
 .../block-storage/section_misc.xml            |  3 ---
 .../block-storage/section_volume-drivers.xml  |  2 ++
 5 files changed, 67 insertions(+), 3 deletions(-)
 create mode 100644 doc/config-reference/block-storage/drivers/datera-volume-driver.xml
 create mode 100644 doc/config-reference/block-storage/drivers/fusionio-volume-driver.xml
 create mode 100644 doc/config-reference/block-storage/drivers/nimble-volume-driver.xml

diff --git a/doc/config-reference/block-storage/drivers/datera-volume-driver.xml b/doc/config-reference/block-storage/drivers/datera-volume-driver.xml
new file mode 100644
index 0000000000..9f9f5796dd
--- /dev/null
+++ b/doc/config-reference/block-storage/drivers/datera-volume-driver.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section 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"
+    xml:id="fusionio-volume-driver">
+    <title>Datera volume driver</title>
+
+    <!-- <para>The volume driver configures XXX. More information about the driver is available at
+         <xlink href="http://example.com">example.com</xlink>.
+         </para>
+    -->
+    <para>
+      Set the following in your <filename>cinder.conf</filename> to
+      use the Datera volume driver:
+    </para>
+    <programlisting>volume_driver = cinder.volume.drivers.datera.DateraDriver</programlisting>
+    <para>
+      Use the following options to configure the volume driver:
+    </para>
+    <xi:include href="../../../common/tables/cinder-datera.xml"/>
+</section>
diff --git a/doc/config-reference/block-storage/drivers/fusionio-volume-driver.xml b/doc/config-reference/block-storage/drivers/fusionio-volume-driver.xml
new file mode 100644
index 0000000000..21bd0c942d
--- /dev/null
+++ b/doc/config-reference/block-storage/drivers/fusionio-volume-driver.xml
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section 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"
+    xml:id="fusionio-volume-driver">
+    <title>FusionIO volume driver for the ioControl Hybrid storage subsystem</title>
+
+    <!-- <para>The volume driver configures XXX. More information about the driver is available at
+         <xlink href="http://example.com">example.com</xlink>.
+         </para>
+    -->
+
+    <para>
+      Set the following in your <filename>cinder.conf</filename> to
+      use the FusionIO volume driver:
+    </para>
+    <programlisting>volume_driver = cinder.volume.drivers.fio_ioControl.fio_ioControl</programlisting>
+    <para>
+      Use the following options to configure the volume driver:
+    </para>
+    <xi:include href="../../../common/tables/cinder-fusionio.xml"/>
+</section>
diff --git a/doc/config-reference/block-storage/drivers/nimble-volume-driver.xml b/doc/config-reference/block-storage/drivers/nimble-volume-driver.xml
new file mode 100644
index 0000000000..b352c4af17
--- /dev/null
+++ b/doc/config-reference/block-storage/drivers/nimble-volume-driver.xml
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section 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"
+    xml:id="nimble-volume-driver">
+    <title>Nimble volume driver</title>
+
+    <!-- <para>The volume driver configures XXX. More information about the driver is available at
+         <xlink href="http://example.com">example.com</xlink>.
+         </para>
+    -->
+
+    <para>
+      Set the following in your <filename>cinder.conf</filename> to
+      use the Nimble volume driver:
+    </para>
+    <programlisting>volume_driver = cinder.volume.drivers.nimble.NimbleISCSIDriver</programlisting>
+    <para>
+      Use the following options to configure the volume driver:
+    </para>
+    <xi:include href="../../../common/tables/cinder-nimble.xml"/>
+</section>
diff --git a/doc/config-reference/block-storage/section_misc.xml b/doc/config-reference/block-storage/section_misc.xml
index 2f172ef3bf..c745af7224 100644
--- a/doc/config-reference/block-storage/section_misc.xml
+++ b/doc/config-reference/block-storage/section_misc.xml
@@ -15,7 +15,6 @@
     <xi:include href="../../common/tables/cinder-huawei.xml"/>
     <xi:include href="../../common/tables/cinder-nas.xml"/>
     <xi:include href="../../common/tables/cinder-hpmsa.xml"/>
-    <xi:include href="../../common/tables/cinder-nimble.xml"/>
     <xi:include href="../../common/tables/cinder-pure.xml"/>
     <xi:include href="../../common/tables/cinder-database.xml"/>
     <xi:include href="../../common/tables/cinder-keymgr.xml"/>
@@ -48,9 +47,7 @@
     <xi:include href="../../common/tables/cinder-debug.xml"/>
     <xi:include href="../../common/tables/cinder-testing.xml"/>
     <xi:include href="../../common/tables/cinder-profiler.xml"/>
-    <xi:include href="../../common/tables/cinder-fusionio.xml"/>
     <xi:include href="../../common/tables/cinder-ibmnas.xml"/>
-    <xi:include href="../../common/tables/cinder-datera.xml"/>
     <xi:include href="../../common/tables/cinder-cloudbyte.xml"/>
     <xi:include href="../../common/tables/cinder-drbd.xml"/>
     <xi:include href="../../common/tables/cinder-flashsystem.xml"/>
diff --git a/doc/config-reference/block-storage/section_volume-drivers.xml b/doc/config-reference/block-storage/section_volume-drivers.xml
index 9eb5dde59c..1be7e2d279 100644
--- a/doc/config-reference/block-storage/section_volume-drivers.xml
+++ b/doc/config-reference/block-storage/section_volume-drivers.xml
@@ -23,6 +23,7 @@
     <xi:include href="drivers/emc-vnx-direct-driver.xml"/>
     <xi:include href="drivers/emc-xtremio-driver.xml"/>
     <xi:include href="drivers/fujitsu-dx-volume-driver.xml"/>
+    <xi:include href="drivers/fusionio-volume-driver.xml"/>
     <xi:include href="drivers/glusterfs-driver.xml"/>
     <xi:include href="drivers/hds-hnas-driver.xml"/>
     <xi:include href="drivers/hds-hus-driver.xml"/>
@@ -37,6 +38,7 @@
     <xi:include href="drivers/lvm-volume-driver.xml"/>
     <xi:include href="drivers/netapp-volume-driver.xml"/>
     <xi:include href="drivers/nexenta-volume-driver.xml"/>
+    <xi:include href="drivers/nimble-volume-driver.xml"/>
     <xi:include href="drivers/nfs-volume-driver.xml"/>
     <xi:include href="drivers/prophetstor-dpl-driver.xml"/>
     <xi:include href="drivers/pure-storage-driver.xml"/>