From e1d38d49b6e683ce197561687258bac3fdecbb9d Mon Sep 17 00:00:00 2001
From: Teruaki Ishizaki <ishizaki.teruaki@lab.ntt.co.jp>
Date: Fri, 11 Sep 2015 18:51:50 +0900
Subject: [PATCH] Sheepdog: Follow the changes for cinder driver

This patch includes the changes for adding new configs
to Sheepdog driver of cinder.

In addition, the page of supported operations is added.

Change-Id: I5e3b05e7e435c6c6fd03a8f25cc7c71300e5b587
---
 doc/common/samples/cinder.conf.sample         | 11 +++++
 doc/common/tables/cinder-sheepdog.xml         | 30 +++++++++++++
 .../block-storage/drivers/sheepdog-driver.xml | 43 +++++++++++++++++--
 .../cinder.headers                            |  2 +-
 4 files changed, 81 insertions(+), 5 deletions(-)
 create mode 100644 doc/common/tables/cinder-sheepdog.xml

diff --git a/doc/common/samples/cinder.conf.sample b/doc/common/samples/cinder.conf.sample
index 9ed1c208a7..79609bdccf 100644
--- a/doc/common/samples/cinder.conf.sample
+++ b/doc/common/samples/cinder.conf.sample
@@ -2043,6 +2043,17 @@
 #scality_sofs_volume_dir=cinder/volumes
 
 
+#
+# Options defined in cinder.volume.drivers.sheepdog
+#
+
+# IP address of sheep daemon.
+#sheepdog_store_address = 127.0.0.1
+
+# Port of sheep daemon.
+#sheepdog_store_port = 7000
+
+
 #
 # Options defined in cinder.volume.drivers.smbfs
 #
diff --git a/doc/common/tables/cinder-sheepdog.xml b/doc/common/tables/cinder-sheepdog.xml
new file mode 100644
index 0000000000..8e54f93563
--- /dev/null
+++ b/doc/common/tables/cinder-sheepdog.xml
@@ -0,0 +1,30 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<para xmlns="http://docbook.org/ns/docbook" version="5.0">
+  <!-- Warning: Do not edit this file. It is automatically
+     generated and your changes will be overwritten.
+     The tool to do so lives in openstack-doc-tools repository. -->
+  <table rules="all" xml:id="config_table_cinder_sheepdog">
+    <caption>Description of Sheepdog driver configuration options</caption>
+    <col width="50%"/>
+    <col width="50%"/>
+    <thead>
+      <tr>
+        <th>Configuration option = Default value</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <th colspan="2">[DEFAULT]</th>
+      </tr>
+      <tr>
+        <td><option>sheepdog_store_address</option> = <replaceable>127.0.0.1</replaceable></td>
+        <td>(StrOpt) IP address of sheep daemon.</td>
+      </tr>
+      <tr>
+        <td><option>sheepdog_store_port</option> = <replaceable>7000</replaceable></td>
+        <td>(IntOpt) Port of sheep daemon.</td>
+      </tr>
+    </tbody>
+  </table>
+</para>
diff --git a/doc/config-reference/block-storage/drivers/sheepdog-driver.xml b/doc/config-reference/block-storage/drivers/sheepdog-driver.xml
index dc3d2f0ce9..2e8370ea82 100644
--- a/doc/config-reference/block-storage/drivers/sheepdog-driver.xml
+++ b/doc/config-reference/block-storage/drivers/sheepdog-driver.xml
@@ -13,8 +13,43 @@
     <para>More information can be found on <link
             xlink:href="http://sheepdog.github.io/sheepdog/">Sheepdog Project</link>.</para>
     <para>This driver enables use of Sheepdog through Qemu/KVM.</para>
-    <para>Set the following
-            <literal>volume_driver</literal> in
-            <filename>cinder.conf</filename>:</para>
-    <programlisting>volume_driver=cinder.volume.drivers.sheepdog.SheepdogDriver</programlisting>
+
+    <section xml:id="sheepdog-supported-operations">
+      <title>Supported operations</title>
+        <para>Sheepdog driver supports these operations:</para>
+        <itemizedlist>
+        <listitem>
+          <para>Create, delete, attach, and detach volumes.</para>
+        </listitem>
+        <listitem>
+          <para>Create, list, and delete volume snapshots.</para>
+        </listitem>
+        <listitem>
+          <para>Create a volume from a snapshot.</para>
+        </listitem>
+        <listitem>
+          <para>Copy an image to a volume.</para>
+        </listitem>
+        <listitem>
+          <para>Copy a volume to an image.</para>
+        </listitem>
+        <listitem>
+          <para>Clone a volume.</para>
+        </listitem>
+        <listitem>
+          <para>Extend a volume.</para>
+        </listitem>
+        </itemizedlist>
+    </section>
+
+    <section xml:id="sheepdog-configuration">
+      <title>Configuration</title>
+      <para>Set the following
+              <literal>volume_driver</literal> in
+              <filename>cinder.conf</filename>:</para>
+      <programlisting>volume_driver=cinder.volume.drivers.sheepdog.SheepdogDriver</programlisting>
+      <para>The following table contains the configuration options
+        supported by the Sheepdog driver.</para>
+      <xi:include href="../../../common/tables/cinder-sheepdog.xml"/>
+    </section>
 </section>
diff --git a/tools/autogenerate-config-flagmappings/cinder.headers b/tools/autogenerate-config-flagmappings/cinder.headers
index 22dd0bd393..f7d25ef209 100644
--- a/tools/autogenerate-config-flagmappings/cinder.headers
+++ b/tools/autogenerate-config-flagmappings/cinder.headers
@@ -46,7 +46,7 @@ san SAN
 san-solaris Solaris SAN
 scality Scality SOFS volume driver
 scst SCST volume driver
-sheepdog Sheepdog Object Storage
+sheepdog Sheepdog driver
 solidfire SolidFire driver
 smbfs Samba volume driver
 storage storage