Merge "[config-ref] generate a cinder-nas table"

doc/config-reference/source/block-storage/volume-misc.rst

@@ -28,6 +28,7 @@ These options can also be set in the ``cinder.conf`` file.
 .. include:: ../tables/cinder-infortrend.rst
 .. include:: ../tables/cinder-keymgr.rst
 .. include:: ../tables/cinder-logging.rst
+.. include:: ../tables/cinder-nas.rst
 .. include:: ../tables/cinder-profiler.rst
 .. include:: ../tables/cinder-pure.rst
 .. include:: ../tables/cinder-qpid.rst

doc/config-reference/source/tables/cinder-nas.rst

@@ -0,0 +1,38 @@
+..
+    Warning: Do not edit this file. It is automatically generated from the
+    software project's code and your changes will be overwritten.
+
+    The tool to generate this file lives in openstack-doc-tools repository.
+
+    Please make any changes needed in the code, then run the
+    autogenerate-config-doc tool from the openstack-doc-tools repository, or
+    ask for help on the documentation mailing list, IRC channel or meeting.
+
+.. _cinder-nas:
+
+.. list-table:: Description of NAS configuration options
+   :header-rows: 1
+   :class: config-ref-table
+
+   * - Configuration option = Default value
+     - Description
+   * - **[DEFAULT]**
+     -
+   * - ``nas_ip`` =
+     - (StrOpt) IP address or Hostname of NAS system.
+   * - ``nas_login`` = ``admin``
+     - (StrOpt) User name to connect to NAS system.
+   * - ``nas_mount_options`` = ``None``
+     - (StrOpt) Options used to mount the storage backend file system where Cinder volumes are stored.
+   * - ``nas_password`` =
+     - (StrOpt) Password to connect to NAS system.
+   * - ``nas_private_key`` =
+     - (StrOpt) Filename of private key to use for SSH authentication.
+   * - ``nas_secure_file_operations`` = ``auto``
+     - (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.
+   * - ``nas_secure_file_permissions`` = ``auto``
+     - (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.
+   * - ``nas_share_path`` =
+     - (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 .
+   * - ``nas_ssh_port`` = ``22``
+     - (PortOpt) SSH port to use to connect to NAS system.

doc/config-reference/source/tables/cinder-storage_gpfs.rst

@@ -30,3 +30,13 @@
      - (BoolOpt) Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time.
    * - ``gpfs_storage_pool`` = ``system``
      - (StrOpt) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used.
+   * - ``nas_ip`` =
+     - (StrOpt) IP address or Hostname of NAS system.
+   * - ``nas_login`` = ``admin``
+     - (StrOpt) User name to connect to NAS system.
+   * - ``nas_password`` =
+     - (StrOpt) Password to connect to NAS system.
+   * - ``nas_private_key`` =
+     - (StrOpt) Filename of private key to use for SSH authentication.
+   * - ``nas_ssh_port`` = ``22``
+     - (PortOpt) SSH port to use to connect to NAS system.

tools/autogenerate-config-flagmappings/cinder.flagmappings

@@ -303,15 +303,15 @@ migration_create_volume_timeout_secs storage
 monkey_patch common
 monkey_patch_modules common
 my_ip common
-nas_ip storage_gpfs
-nas_login storage_gpfs
-nas_mount_options storage_gpfs
-nas_password storage_gpfs
-nas_private_key storage_gpfs
-nas_secure_file_operations storage_gpfs
-nas_secure_file_permissions storage_gpfs
-nas_share_path storage_gpfs
-nas_ssh_port storage_gpfs
+nas_ip nas storage_gpfs
+nas_login nas storage_gpfs
+nas_mount_options nas
+nas_password nas storage_gpfs
+nas_private_key nas storage_gpfs
+nas_secure_file_operations nas
+nas_secure_file_permissions nas
+nas_share_path nas
+nas_ssh_port nas storage_gpfs
 nas_volume_prov_type storage_glusterfs
 naviseccli_path emc
 netapp_controller_ips netapp_eseries_iscsi

tools/autogenerate-config-flagmappings/cinder.headers

@@ -30,6 +30,7 @@ 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