From 646a21a00308193fc2d2c87511f9cfb685bbd991 Mon Sep 17 00:00:00 2001
From: Tom Fifield <tom@openstack.org>
Date: Fri, 10 Jan 2014 14:31:49 +0800
Subject: [PATCH] Add section for LVM driver

The config reference was missing a section for the default driver,
LVM. This adds a new section, with the config options needed to use
it and fixes the incorrect mention in the section lead-in.

Closes-Bug 1208205

Change-Id: Idefab5dbd69c37d637bc2a3f75880d8e341379ee
---
 .../drivers/lvm-volume-driver.xml             | 19 +++++++++++++++++++
 .../block-storage/section_volume-drivers.xml  |  4 ++--
 2 files changed, 21 insertions(+), 2 deletions(-)
 create mode 100644 doc/config-reference/block-storage/drivers/lvm-volume-driver.xml

diff --git a/doc/config-reference/block-storage/drivers/lvm-volume-driver.xml b/doc/config-reference/block-storage/drivers/lvm-volume-driver.xml
new file mode 100644
index 0000000000..8eee6e8e81
--- /dev/null
+++ b/doc/config-reference/block-storage/drivers/lvm-volume-driver.xml
@@ -0,0 +1,19 @@
+<section xml:id="lvm-volume-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>LVM</title>
+    <para>The default volume back-end uses local volumes managed by LVM.</para>
+    <para>This driver supports different transport protocols to attach
+    volumes, currently ISCSI and ISER.</para>
+    <para>
+     Set the following in your
+    <filename>cinder.conf</filename>, and use the following options to
+    configure for ISCSI transport:
+   </para>
+    <programlisting language="ini">volume_driver=cinder.volume.drivers.lvm.ISCSIDriver</programlisting>
+    <para>and for the ISER transport:</para>
+    <programlisting language="ini">volume_driver=cinder.volume.drivers.lvm.ISERDriver</programlisting>
+    <xi:include href="../../../common/tables/cinder-lvm.xml"/>
+</section>
diff --git a/doc/config-reference/block-storage/section_volume-drivers.xml b/doc/config-reference/block-storage/section_volume-drivers.xml
index e32a1a1d3f..f92abbe897 100644
--- a/doc/config-reference/block-storage/section_volume-drivers.xml
+++ b/doc/config-reference/block-storage/section_volume-drivers.xml
@@ -12,8 +12,7 @@
             >https://github.com/openstack/cinder</link>). To set a
         volume driver, use the <literal>volume_driver</literal> flag.
         The default is:</para>
-    <programlisting>volume_driver=cinder.volume.driver.ISCSIDriver
-iscsi_helper=tgtadm</programlisting>
+    <programlisting>volume_driver=cinder.volume.drivers.lvm.LVMISCSIDriver</programlisting>
     <xi:include href="drivers/ceph-rbd-volume-driver.xml"/>
     <xi:include href="drivers/coraid-driver.xml"/>
     <xi:include href="drivers/dell-equallogic-driver.xml"/>
@@ -26,6 +25,7 @@ iscsi_helper=tgtadm</programlisting>
     <xi:include href="drivers/ibm-xiv-volume-driver.xml"/>
     <xi:include href="drivers/ibm-gpfs-volume-driver.xml"/>
     <xi:include href="drivers/ibm-storwize-svc-driver.xml"/>
+    <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/nfs-volume-driver.xml"/>