Merge "Modularize cinder tables and use them in Config Guide"

doc/common/tables/cinder-api.xml

@@ -63,30 +63,6 @@
                        <td>volume_api_class=cinder.volume.api.API</td>
                        <td>(StrOpt) The full class name of the volume API class to use</td>
               </tr>
-              <tr>
-                       <td>xenapi_connection_password=None</td>
-                       <td>(StrOpt) Password for XenAPI connection</td>
-              </tr>
-              <tr>
-                       <td>xenapi_connection_url=None</td>
-                       <td>(StrOpt) URL for XenAPI connection</td>
-              </tr>
-              <tr>
-                       <td>xenapi_connection_username=root</td>
-                       <td>(StrOpt) Username for XenAPI connection</td>
-              </tr>
-              <tr>
-                       <td>xenapi_nfs_server=None</td>
-                       <td>(StrOpt) NFS server to be used by XenAPINFSDriver</td>
-              </tr>
-              <tr>
-                       <td>xenapi_nfs_serverpath=None</td>
-                       <td>(StrOpt) Path of exported NFS, used by XenAPINFSDriver</td>
-              </tr>
-              <tr>
-                       <td>xenapi_sr_base_path=/var/run/sr-mount</td>
-                       <td>(StrOpt) Base path to the storage repository</td>
-              </tr>
        </tbody>
         </table>
         </para>

doc/common/tables/cinder-storage.xml

@@ -267,30 +267,6 @@
                        <td>num_volume_device_scan_tries=3</td>
                        <td>(IntOpt) The maximum number of times to rescan targetsto find volume</td>
               </tr>
-              <tr>
-                       <td>rbd_ceph_conf=</td>
-                       <td>(StrOpt) path to the ceph configuration file to use</td>
-              </tr>
-              <tr>
-                       <td>rbd_flatten_volume_from_snapshot=False</td>
-                       <td>(BoolOpt) flatten volumes created from snapshots to remove dependency</td>
-              </tr>
-              <tr>
-                       <td>rbd_max_clone_depth=5</td>
-                       <td>(IntOpt) maximum number of nested clones that can be taken of a volume before enforcing a flatten prior to next clone. A value of zero disables cloning</td>
-              </tr>
-              <tr>
-                       <td>rbd_pool=rbd</td>
-                       <td>(StrOpt) the RADOS pool in which rbd volumes are stored</td>
-              </tr>
-              <tr>
-                       <td>rbd_secret_uuid=None</td>
-                       <td>(StrOpt) the libvirt uuid of the secret for the rbd_uservolumes</td>
-              </tr>
-              <tr>
-                       <td>rbd_user=None</td>
-                       <td>(StrOpt) the RADOS client name for accessing rbd volumes - only set when using cephx authentication</td>
-              </tr>
               <tr>
                        <td>san_clustername=</td>
                        <td>(StrOpt) Cluster name to use for creating volumes</td>
@@ -443,10 +419,6 @@
                        <td>volume_name_template=volume-%s</td>
                        <td>(StrOpt) Template string to be used to generate volume names</td>
               </tr>
-              <tr>
-                       <td>volume_tmp_dir=None</td>
-                       <td>(StrOpt) where to store temporary image files if the volume driver does not write them directly to the volume</td>
-              </tr>
               <tr>
                        <td>volume_topic=cinder-volume</td>
                        <td>(StrOpt) the topic volume nodes listen on</td>

doc/common/tables/cinder-storage_ceph.xml

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+        <!-- Warning: Do not edit this file. It is automatically
+             generated and your changes will be overwritten.
+             The tool to do so lives in the tools directory of this
+             repository -->
+        <para xmlns="http://docbook.org/ns/docbook" version="5.0">
+        <table rules="all">
+          <caption>Description of configuration options for storage_ceph</caption>
+           <col width="50%"/>
+           <col width="50%"/>
+           <thead>
+              <tr>
+                  <td>Configuration option=Default value</td>
+                  <td>Description</td>
+              </tr>
+          </thead>
+          <tbody>
+              <tr>
+                       <td>rbd_ceph_conf=</td>
+                       <td>(StrOpt) path to the ceph configuration file to use</td>
+              </tr>
+              <tr>
+                       <td>rbd_flatten_volume_from_snapshot=False</td>
+                       <td>(BoolOpt) flatten volumes created from snapshots to remove dependency</td>
+              </tr>
+              <tr>
+                       <td>rbd_max_clone_depth=5</td>
+                       <td>(IntOpt) maximum number of nested clones that can be taken of a volume before enforcing a flatten prior to next clone. A value of zero disables cloning</td>
+              </tr>
+              <tr>
+                       <td>rbd_pool=rbd</td>
+                       <td>(StrOpt) the RADOS pool in which rbd volumes are stored</td>
+              </tr>
+              <tr>
+                       <td>rbd_secret_uuid=None</td>
+                       <td>(StrOpt) the libvirt uuid of the secret for the rbd_uservolumes</td>
+              </tr>
+              <tr>
+                       <td>rbd_user=None</td>
+                       <td>(StrOpt) the RADOS client name for accessing rbd volumes - only set when using cephx authentication</td>
+              </tr>
+              <tr>
+                       <td>volume_tmp_dir=None</td>
+                       <td>(StrOpt) where to store temporary image files if the volume driver does not write them directly to the volume</td>
+              </tr>
+       </tbody>
+        </table>
+        </para>

doc/common/tables/cinder-storage_xen.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+        <!-- Warning: Do not edit this file. It is automatically
+             generated and your changes will be overwritten.
+             The tool to do so lives in the tools directory of this
+             repository -->
+        <para xmlns="http://docbook.org/ns/docbook" version="5.0">
+        <table rules="all">
+          <caption>Description of configuration options for storage_xen</caption>
+           <col width="50%"/>
+           <col width="50%"/>
+           <thead>
+              <tr>
+                  <td>Configuration option=Default value</td>
+                  <td>Description</td>
+              </tr>
+          </thead>
+          <tbody>
+              <tr>
+                       <td>xenapi_connection_password=None</td>
+                       <td>(StrOpt) Password for XenAPI connection</td>
+              </tr>
+              <tr>
+                       <td>xenapi_connection_url=None</td>
+                       <td>(StrOpt) URL for XenAPI connection</td>
+              </tr>
+              <tr>
+                       <td>xenapi_connection_username=root</td>
+                       <td>(StrOpt) Username for XenAPI connection</td>
+              </tr>
+              <tr>
+                       <td>xenapi_nfs_server=None</td>
+                       <td>(StrOpt) NFS server to be used by XenAPINFSDriver</td>
+              </tr>
+              <tr>
+                       <td>xenapi_nfs_serverpath=None</td>
+                       <td>(StrOpt) Path of exported NFS, used by XenAPINFSDriver</td>
+              </tr>
+              <tr>
+                       <td>xenapi_sr_base_path=/var/run/sr-mount</td>
+                       <td>(StrOpt) Base path to the storage repository</td>
+              </tr>
+       </tbody>
+        </table>
+        </para>

doc/config-reference/block-storage/drivers/ceph-rbd-volume-driver.xml

@@ -134,4 +134,10 @@
                 xlink:href="http://www.sebastien-han.fr/blog/2012/06/10/introducing-ceph-to-openstack/"
                 >http://www.sebastien-han.fr/blog/2012/06/10/introducing-ceph-to-openstack/</link>.</para>
     </simplesect>
+    <simplesect>
+      <title>Driver Options</title>
+    <para>The following table contains the configuration options
+    supported by the Ceph RADOS Block Device driver.</para>
+    <xi:include href="../../../common/tables/cinder-storage_ceph.xml" />
+    </simplesect>
 </section>

doc/config-reference/block-storage/drivers/xenapi-nfs.xml

@@ -11,8 +11,8 @@
 <para>
 This driver is not accessing the NFS share directly, it is only accessing the
 share through XenAPI Storage Manager. This driver should be considered as a
-reference implementation for using XenAPI's storage manager in OpenStack (
+reference implementation for using XenAPI's storage manager in OpenStack
-present in XenServer and XCP).
+(present in XenServer and XCP).
 </para>
 
 <simplesect>
@@ -30,7 +30,7 @@ present in XenServer and XCP).
             <para>An NFS share, that is configured for XenServer/XCP. For the
             specific requirements, export options, please refer to the
             administration guide of your specific XenServer version. It is also
-            requirement, that the NFS share is accessible by all the XenServers
+            required that the NFS share is accessible by all the XenServers
             components within your cloud.</para>
         </listitem>
         <listitem>
@@ -91,10 +91,14 @@ present in XenServer and XCP).
     <title>Configuration Options</title>
     <para>Assuming the following setup:</para>
     <itemizedlist>
-        <listitem><para>XenServer box at <literal>10.2.2.1</literal></para></listitem>
+        <listitem><para>XenServer box at <literal>10.2.2.1</literal></para>
-        <listitem><para>XenServer password is <literal>r00tme</literal></para></listitem>
+        </listitem>
-        <listitem><para>NFS server is <literal>nfs.example.com</literal></para></listitem>
+        <listitem><para>XenServer password is <literal>r00tme</literal></para>
-        <listitem><para>NFS export is at <literal>/volumes</literal></para></listitem>
+        </listitem>
+        <listitem><para>NFS server is <literal>nfs.example.com</literal></para>
+        </listitem>
+        <listitem><para>NFS export is at <literal>/volumes</literal></para>
+        </listitem>
     </itemizedlist>
 
     <para>To use XenAPINFS as your cinder driver, set the following
@@ -108,5 +112,9 @@ xenapi_connection_password = r00tme
 xenapi_nfs_server = nfs.example.com
 xenapi_nfs_serverpath = /volumes
 </programlisting>
+
+    <para>The following table contains the configuration options
+    supported by the XenAPINFS driver.</para>
+    <xi:include href="../../../common/tables/cinder-storage_xen.xml" />
 </simplesect>
 </section>

tools/autogenerate-config-docs/flagmappings/cinder.flagmappings

@@ -236,12 +236,12 @@ rabbit_retry_interval rpc
 rabbit_use_ssl rpc
 rabbit_userid rpc
 rabbit_virtual_host rpc
-rbd_ceph_conf storage
+rbd_ceph_conf storage_ceph
-rbd_flatten_volume_from_snapshot storage
+rbd_flatten_volume_from_snapshot storage_ceph
-rbd_max_clone_depth storage
+rbd_max_clone_depth storage_ceph
-rbd_pool storage
+rbd_pool storage_ceph
-rbd_secret_uuid storage
+rbd_secret_uuid storage_ceph
-rbd_user storage
+rbd_user storage_ceph
 reservation_expire common
 reserved_percentage common
 restore_discard_excess_bytes backups
@@ -333,19 +333,19 @@ volume_driver storage
 volume_group storage
 volume_manager storage
 volume_name_template storage
-volume_tmp_dir storage
+volume_tmp_dir storage_ceph
 volume_topic storage
 volume_transfer_key_length storage
 volume_transfer_salt_length storage
 volume_usage_audit_period storage
 volumes_dir storage
 windows_iscsi_lun_path storage
-xenapi_connection_password api
+xenapi_connection_password storage_xen
-xenapi_connection_url api
+xenapi_connection_url storage_xen
-xenapi_connection_username api
+xenapi_connection_username storage_xen
-xenapi_nfs_server api
+xenapi_nfs_server storage_xen
-xenapi_nfs_serverpath api
+xenapi_nfs_serverpath storage_xen
-xenapi_sr_base_path api
+xenapi_sr_base_path storage_xen
 xiv_ds8k_connection_type storage
 xiv_ds8k_proxy storage
 zadara_default_stripesize storage