Add config reference for IBM SONAS/7k cinder driver

Adds a stub section for the  IBM SONAS and Storwize V7000 Unified
driver for cinder.

Change-Id: If072eaed3e7362b69f21cd579b5355f5c0d90932
Closes-Bug: 1284215

doc/common/tables/cinder-ibmnas.xml

@@ -4,7 +4,7 @@
      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_ibmnas">
-    <caption>Description of IBM NAS volume driver configuration options</caption>
+    <caption>Description of IBM SONAS and Storwise V7000 volume driver configuration options</caption>
     <col width="50%"/>
     <col width="50%"/>
     <thead>
@@ -21,6 +21,42 @@
         <td><option>ibmnas_platform_type</option> = <replaceable>v7ku</replaceable></td>
         <td>(StrOpt) IBMNAS platform type to be used as backend storage; valid values are - v7ku : for using IBM Storwize V7000 Unified, sonas : for using IBM Scale Out NAS, gpfs-nas : for using NFS based IBM GPFS deployments.</td>
       </tr>
+      <tr>
+        <td><option>nas_ip</option> = <replaceable></replaceable></td>
+        <td>(StrOpt) IP address or Hostname of NAS system.</td>
+      </tr>
+      <tr>
+        <td><option>nas_login</option> = <replaceable>admin</replaceable></td>
+        <td>(StrOpt) User name to connect to NAS system.</td>
+      </tr>
+      <tr>
+        <td><option>nas_mount_options</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) Options used to mount the storage backend file system where Cinder volumes are stored.</td>
+      </tr>
+      <tr>
+        <td><option>nas_password</option> = <replaceable></replaceable></td>
+        <td>(StrOpt) Password to connect to NAS system.</td>
+      </tr>
+      <tr>
+        <td><option>nas_private_key</option> = <replaceable></replaceable></td>
+        <td>(StrOpt) Filename of private key to use for SSH authentication.</td>
+      </tr>
+      <tr>
+        <td><option>nas_secure_file_operations</option> = <replaceable>auto</replaceable></td>
+        <td>(StrOpt) Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.</td>
+      </tr>
+      <tr>
+        <td><option>nas_secure_file_permissions</option> = <replaceable>auto</replaceable></td>
+        <td>(StrOpt) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.</td>
+      </tr>
+      <tr>
+        <td><option>nas_share_path</option> = <replaceable></replaceable></td>
+        <td>(StrOpt) Path to the share to use for storing Cinder volumes. For example:  "/srv/export1" for an NFS server export available at 10.0.5.10:/srv/export1 .</td>
+      </tr>
+      <tr>
+        <td><option>nas_ssh_port</option> = <replaceable>22</replaceable></td>
+        <td>(IntOpt) SSH port to use to connect to NAS system.</td>
+      </tr>
     </tbody>
   </table>
 </para>

doc/common/tables/cinder-nas.xml

@@ -1,58 +0,0 @@
-<?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_nas">
-    <caption>Description of NAS 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>nas_ip</option> = <replaceable></replaceable></td>
-        <td>(StrOpt) IP address or Hostname of NAS system.</td>
-      </tr>
-      <tr>
-        <td><option>nas_login</option> = <replaceable>admin</replaceable></td>
-        <td>(StrOpt) User name to connect to NAS system.</td>
-      </tr>
-      <tr>
-        <td><option>nas_mount_options</option> = <replaceable>None</replaceable></td>
-        <td>(StrOpt) Options used to mount the storage backend file system where Cinder volumes are stored.</td>
-      </tr>
-      <tr>
-        <td><option>nas_password</option> = <replaceable></replaceable></td>
-        <td>(StrOpt) Password to connect to NAS system.</td>
-      </tr>
-      <tr>
-        <td><option>nas_private_key</option> = <replaceable></replaceable></td>
-        <td>(StrOpt) Filename of private key to use for SSH authentication.</td>
-      </tr>
-      <tr>
-        <td><option>nas_secure_file_operations</option> = <replaceable>auto</replaceable></td>
-        <td>(StrOpt) Allow network-attached storage systems to operate in a secure environment where root level access is not permitted. If set to False, access is as the root user and insecure. If set to True, access is not as root. If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.</td>
-      </tr>
-      <tr>
-        <td><option>nas_secure_file_permissions</option> = <replaceable>auto</replaceable></td>
-        <td>(StrOpt) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.</td>
-      </tr>
-      <tr>
-        <td><option>nas_share_path</option> = <replaceable></replaceable></td>
-        <td>(StrOpt) Path to the share to use for storing Cinder volumes. For example:  "/srv/export1" for an NFS server export available at 10.0.5.10:/srv/export1 .</td>
-      </tr>
-      <tr>
-        <td><option>nas_ssh_port</option> = <replaceable>22</replaceable></td>
-        <td>(IntOpt) SSH port to use to connect to NAS system.</td>
-      </tr>
-    </tbody>
-  </table>
-</para>

doc/config-reference/block-storage/drivers/ibm-sonas-7k-driver.xml

@@ -0,0 +1,16 @@
+<section xml:id="ibm-sonas-7k-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>IBM SONAS and Storwise V7000 volume driver</title>
+    <para>
+      The IBM Storage Driver for OpenStack is a Block Storage driver
+      that supports IBM SONAS and V7000 storage systems over NFS.
+    </para>
+    <para>
+      Set the following in your <filename>cinder.conf</filename>, and
+      use the table of options to configure it.
+    </para>
+    <programlisting language="ini">volume_driver = cinder.volume.drivers.ibm.ibmnas</programlisting>
+    <xi:include href="../../../common/tables/cinder-ibmnas.xml"/>
+</section>

doc/config-reference/block-storage/section_misc.xml

@@ -36,13 +36,11 @@
     <xi:include href="../../common/tables/cinder-hpmsa.xml"/>
     <xi:include href="../../common/tables/cinder-hpxp.xml"/>
     <xi:include href="../../common/tables/cinder-huawei.xml"/>
-    <xi:include href="../../common/tables/cinder-ibmnas.xml"/>
     <xi:include href="../../common/tables/cinder-images.xml"/>
     <xi:include href="../../common/tables/cinder-infortrend.xml"/>
     <xi:include href="../../common/tables/cinder-keymgr.xml"/>
     <xi:include href="../../common/tables/cinder-lenovo.xml"/>
     <xi:include href="../../common/tables/cinder-logging.xml"/>
-    <xi:include href="../../common/tables/cinder-nas.xml"/>
     <xi:include href="../../common/tables/cinder-openvstorage.xml"/>
     <xi:include href="../../common/tables/cinder-profiler.xml"/>
     <xi:include href="../../common/tables/cinder-pure.xml"/>

doc/config-reference/block-storage/section_volume-drivers.xml

@@ -29,6 +29,7 @@
     <xi:include href="drivers/huawei-storage-driver.xml"/>
     <xi:include href="drivers/ibm-gpfs-volume-driver.xml"/>
     <xi:include href="drivers/ibm-storwize-svc-driver.xml"/>
+    <xi:include href="drivers/ibm-sonas-7k-driver.xml"/>
     <xi:include href="drivers/ibm-xiv-volume-driver.xml"/>
     <xi:include href="drivers/ibm-flashsystem-volume-driver.xml"/>
     <xi:include href="drivers/lvm-volume-driver.xml"/>

tools/autogenerate-config-flagmappings/cinder.flagmappings

@@ -276,15 +276,15 @@ migration_create_volume_timeout_secs storage
 monkey_patch common
 monkey_patch_modules common
 my_ip common
-nas_ip nas
+nas_ip ibmnas
-nas_login nas
+nas_login ibmnas
-nas_mount_options nas
+nas_mount_options ibmnas
-nas_password nas
+nas_password ibmnas
-nas_private_key nas
+nas_private_key ibmnas
-nas_secure_file_operations nas
+nas_secure_file_operations ibmnas
-nas_secure_file_permissions nas
+nas_secure_file_permissions ibmnas
-nas_share_path nas
+nas_share_path ibmnas
-nas_ssh_port nas
+nas_ssh_port ibmnas
 naviseccli_path emc
 netapp_controller_ips netapp_eseries_iscsi
 netapp_copyoffload_tool_path netapp_cdot_nfs

tools/autogenerate-config-flagmappings/cinder.headers

@@ -25,12 +25,11 @@ hplefthand HP LeftHand/StoreVirtual driver
 hpmsa HP MSA Fiber Channel driver
 hpxp HP XP volume driver
 huawei Huawei storage driver
-ibmnas IBM NAS volume driver
+ibmnas IBM SONAS and Storwise V7000 volume driver
 images images
 infortrend Infortrend volume driver
 lenovo Lenovo volume driver
 lvm LVM
-nas NAS
 netapp_7mode_iscsi NetApp 7-Mode iSCSI driver
 netapp_7mode_nfs NetApp 7-Mode NFS driver
 netapp_cdot_iscsi NetApp cDOT iSCSI driver