Move driver config opts out of catchall page

Adds a few bare bones driver config pages or moves config tables to
existing driver docs. Also removing hyperv and redis config tables
as those have been removed.

Change-Id: I3cf2c6c6de6e4346d7dc3fa154d8a6aa90d934a7

doc/source/configuration/block-storage/config-options.rst

@@ -11,17 +11,10 @@ These options can also be set in the ``cinder.conf`` file.
 .. include:: ../tables/cinder-compute.inc
 .. include:: ../tables/cinder-coordination.inc
 .. include:: ../tables/cinder-debug.inc
-.. include:: ../tables/cinder-drbd.inc
-.. include:: ../tables/cinder-flashsystem.inc
-.. include:: ../tables/cinder-hgst.inc
-.. include:: ../tables/cinder-huawei.inc
-.. include:: ../tables/cinder-hyperv.inc
 .. include:: ../tables/cinder-images.inc
 .. include:: ../tables/cinder-nas.inc
 .. include:: ../tables/cinder-profiler.inc
-.. include:: ../tables/cinder-pure.inc
 .. include:: ../tables/cinder-quota.inc
-.. include:: ../tables/cinder-redis.inc
 .. include:: ../tables/cinder-san.inc
 .. include:: ../tables/cinder-scheduler.inc
 .. include:: ../tables/cinder-scst.inc

doc/source/configuration/block-storage/drivers/drbd-driver.rst

@@ -0,0 +1,29 @@
+===========
+DRBD driver
+===========
+
+The DRBD driver allows Cinder to use DRBDmanage instances.
+
+Configuration
+~~~~~~~~~~~~~
+
+Set the following option in the ``cinder.conf`` file for the DRBD transport:
+
+.. code-block:: ini
+
+   volume_driver = cinder.volume.drivers.drbdmanagedrv.DrbdManageDrbdDriver
+
+Or use the following for iSCSI transport:
+
+.. code-block:: ini
+
+   volume_driver = cinder.volume.drivers.drbdmanagedrv.DrbdManageIscsiDriver
+
+
+The following table contains the configuration options supported by the
+DRBD drivers:
+
+.. config-table::
+   :config-target: DRBD
+
+   cinder.volume.drivers.drbdmanagedrv

doc/source/configuration/block-storage/drivers/hgst-driver.rst

@@ -0,0 +1,17 @@
+===================
+HGST Storage driver
+===================
+
+The HGST driver enables Cinder volumes using the HGST Flash Storage Suite.
+
+Set the following in your ``cinder.conf`` file, and use the following
+options to configure it.
+
+.. code-block:: ini
+
+   volume_driver = cinder.volume.drivers.hgst.HGSTDriver
+
+.. config-table::
+   :config-target: HGST Storage
+
+   cinder.volume.drivers.hgst

doc/source/configuration/block-storage/drivers/huawei-storage-driver.rst

@@ -514,3 +514,11 @@ of the Huawei volume driver.
    The ``Initiator Name``, ``Initiator TargetIP``, and
    ``Initiator TargetPortGroup`` are ``ISCSI`` parameters and therefore not
    applicable to ``FC``.
+
+The following are the Huawei driver specific options that may be set in
+`cinder.conf`:
+
+.. config-table::
+   :config-target: Huawei
+
+   cinder.volume.drivers.huawei.huawei_driver

doc/source/configuration/block-storage/drivers/ibm-flashsystem-volume-driver.rst

@@ -5,6 +5,29 @@ IBM FlashSystem volume driver
 The volume driver for FlashSystem provides OpenStack Block Storage hosts
 with access to IBM FlashSystems.
 
+Supported operations
+~~~~~~~~~~~~~~~~~~~~
+
+These operations are supported:
+
+-  Create, delete, attach, and detach volumes.
+
+-  Create, list, and delete volume snapshots.
+
+-  Create a volume from a snapshot.
+
+-  Copy an image to a volume.
+
+-  Copy a volume to an image.
+
+-  Clone a volume.
+
+-  Extend a volume.
+
+-  Get volume statistics.
+
+-  Manage and unmanage a volume.
+
 Configure FlashSystem
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -39,6 +62,32 @@ FlashSystem. For more detail, see the driver configuration flags
 for the user and password here: :ref:`config_fc_flags`
 or :ref:`config_iscsi_flags`.
 
+There are some common configuration options for either driver:
+
+.. list-table:: List of common configuration options for IBM FlashSystem drivers
+   :header-rows: 1
+
+   * - Flag name
+     - Type
+     - Default
+     - Description
+   * - ``san_ip``
+     - Required
+     -
+     - Management IP or host name
+   * - ``san_ssh_port``
+     - Optional
+     - 22
+     - Management port
+   * - ``san_login``
+     - Required
+     -
+     - Management login user name
+   * - ``san_password``
+     - Required
+     -
+     - Management login password
+
 IBM FlashSystem FC driver
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -75,49 +124,11 @@ as follows:
 To enable the IBM FlashSystem FC driver, configure the following options in the
 ``cinder.conf`` configuration file:
 
-.. list-table:: List of configuration flags for IBM FlashSystem FC driver
+.. config-table::
-   :header-rows: 1
+   :config-target: IBM FlashSystem FC
 
-   * - Flag name
+   cinder.volume.drivers.ibm.flashsystem_common
-     - Type
+   cinder.volume.drivers.ibm.flashsystem_fc
-     - Default
-     - Description
-   * - ``san_ip``
-     - Required
-     -
-     - Management IP or host name
-   * - ``san_ssh_port``
-     - Optional
-     - 22
-     - Management port
-   * - ``san_login``
-     - Required
-     -
-     - Management login user name
-   * - ``san_password``
-     - Required
-     -
-     - Management login password
-   * - ``flashsystem_connection_protocol``
-     - Required
-     -
-     - Connection protocol should be set to ``FC``
-   * - ``flashsystem_multipath_enabled``
-     - Required
-     -
-     - Enable multipath for FC connections
-   * - ``flashsystem_multihost_enabled``
-     - Optional
-     - ``True``
-     - Enable mapping vdisks to multiple hosts  [1]_
-
-.. [1]
-   This option allows the driver to map a vdisk to more than one host at
-   a time. This scenario occurs during migration of a virtual machine
-   with an attached volume; the volume is simultaneously mapped to both
-   the source and destination compute hosts. If your deployment does not
-   require attaching vdisks to multiple hosts, setting this flag to
-   ``False`` will provide added safety.
 
 IBM FlashSystem iSCSI driver
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -151,60 +162,19 @@ follows:
 To enable IBM FlashSystem iSCSI driver, configure the following options
 in the ``cinder.conf`` configuration file:
 
+.. config-table::
+   :config-target: IBM FlashSystem iSCSI
 
-.. list-table:: List of configuration flags for IBM FlashSystem iSCSI driver
+   cinder.volume.drivers.ibm.flashsystem_common
-   :header-rows: 1
+   cinder.volume.drivers.ibm.flashsystem_iscsi
 
-   * - Flag name
+.. note::
-     - Type
-     - Default
-     - Description
-   * - ``san_ip``
-     - Required
-     -
-     - Management IP or host name
-   * - ``san_ssh_port``
-     - Optional
-     - 22
-     - Management port
-   * - ``san_login``
-     - Required
-     -
-     - Management login user name
-   * - ``san_password``
-     - Required
-     -
-     - Management login password
-   * - ``flashsystem_connection_protocol``
-     - Required
-     -
-     - Connection protocol should be set to ``iSCSI``
-   * - ``flashsystem_multihost_enabled``
-     - Optional
-     - ``True``
-     - Enable mapping vdisks to multiple hosts  [2]_
-   * - ``iscsi_ip_address``
-     - Required
-     -
-     - Set to one of the iSCSI IP addresses obtained by FlashSystem GUI or CLI  [3]_
-   * - ``flashsystem_iscsi_portid``
-     - Required
-     -
-     - Set to the id of the ``iscsi_ip_address`` obtained by FlashSystem GUI or CLI  [4]_
 
-.. [2]
-   This option allows the driver to map a vdisk to more than one host at
-   a time. This scenario occurs during migration of a virtual machine
-   with an attached volume; the volume is simultaneously mapped to both
-   the source and destination compute hosts. If your deployment does not
-   require attaching vdisks to multiple hosts, setting this flag to
-   ``False`` will provide added safety.
-
-.. [3]
    On the cluster of the FlashSystem, the ``iscsi_ip_address`` column is the
    seventh column ``IP_address`` of the output of ``lsportip``.
 
-.. [4]
+.. note::
+
    On the cluster of the FlashSystem, port ID column is the first
    column ``id`` of the output of ``lsportip``,
    not the sixth column ``port_id``.
@@ -218,25 +188,11 @@ IBM FlashSystem only works when:
 
    open_access_enabled=off
 
-Supported operations
+.. note::
-~~~~~~~~~~~~~~~~~~~~
 
-These operations are supported:
+    The ``flashsystem_multihost_enabled`` setting allows the driver to map a
-
+    vdisk to more than one host at a time. This scenario occurs during
--  Create, delete, attach, and detach volumes.
+    migration of a virtual machine with an attached volume; the volume is
-
+    simultaneously mapped to both the source and destination compute hosts. If
--  Create, list, and delete volume snapshots.
+    your deployment does not require attaching vdisks to multiple hosts,
-
+    setting this flag to ``False`` will provide added safety.
--  Create a volume from a snapshot.
-
--  Copy an image to a volume.
-
--  Copy a volume to an image.
-
--  Clone a volume.
-
--  Extend a volume.
-
--  Get volume statistics.
-
--  Manage and unmanage a volume.

doc/source/configuration/block-storage/drivers/pure-storage-driver.rst

@@ -317,3 +317,14 @@ Metrics reported include, but are not limited to:
 In conjunction with QOS extra-specs, you can create very complex algorithms to
 manage volume placement. More detailed documentation on this is available in
 other external documentation.
+
+Configuration Options
+~~~~~~~~~~~~~~~~~~~~~
+
+The following list all Pure driver specific configuration options that can be
+set in `cinder.conf`:
+
+.. config-table::
+   :config-target: Pure
+
+   cinder.volume.drivers.pure

doc/source/configuration/block-storage/volume-drivers.rst

@@ -41,7 +41,9 @@ Driver Configuration Reference
    drivers/dell-emc-vnx-driver
    drivers/dell-emc-vmax-driver
    drivers/emc-xtremio-driver
+   drivers/drbd-driver
    drivers/fujitsu-eternus-dx-driver
+   drivers/hgst-driver
    drivers/hpe-3par-driver
    drivers/hpe-lefthand-driver
    drivers/hp-msa-driver

doc/source/configuration/tables/cinder-drbd.inc

@@ -1,42 +0,0 @@
-..
-    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-drbd:
-
-.. list-table:: Description of DRBD configuration options
-   :header-rows: 1
-   :class: config-ref-table
-
-   * - Configuration option = Default value
-     - Description
-   * - **[DEFAULT]**
-     -
-   * - ``drbdmanage_devs_on_controller`` = ``True``
-     - (Boolean) If set, the c-vol node will receive a useable /dev/drbdX device, even if the actual data is stored on other nodes only. This is useful for debugging, maintenance, and to be able to do the iSCSI export from the c-vol node.
-   * - ``drbdmanage_disk_options`` = ``{"c-min-rate": "4M"}``
-     - (String) Disk options to set on new resources. See http://www.drbd.org/en/doc/users-guide-90/re-drbdconf for all the details.
-   * - ``drbdmanage_net_options`` = ``{"connect-int": "4", "allow-two-primaries": "yes", "ko-count": "30", "max-buffers": "20000", "ping-timeout": "100"}``
-     - (String) Net options to set on new resources. See http://www.drbd.org/en/doc/users-guide-90/re-drbdconf for all the details.
-   * - ``drbdmanage_redundancy`` = ``1``
-     - (Integer) Number of nodes that should replicate the data.
-   * - ``drbdmanage_resize_plugin`` = ``drbdmanage.plugins.plugins.wait_for.WaitForVolumeSize``
-     - (String) Volume resize completion wait plugin.
-   * - ``drbdmanage_resize_policy`` = ``{"timeout": "60"}``
-     - (String) Volume resize completion wait policy.
-   * - ``drbdmanage_resource_options`` = ``{"auto-promote-timeout": "300"}``
-     - (String) Resource options to set on new resources. See http://www.drbd.org/en/doc/users-guide-90/re-drbdconf for all the details.
-   * - ``drbdmanage_resource_plugin`` = ``drbdmanage.plugins.plugins.wait_for.WaitForResource``
-     - (String) Resource deployment completion wait plugin.
-   * - ``drbdmanage_resource_policy`` = ``{"ratio": "0.51", "timeout": "60"}``
-     - (String) Resource deployment completion wait policy.
-   * - ``drbdmanage_snapshot_plugin`` = ``drbdmanage.plugins.plugins.wait_for.WaitForSnapshot``
-     - (String) Snapshot completion wait plugin.
-   * - ``drbdmanage_snapshot_policy`` = ``{"count": "1", "timeout": "60"}``
-     - (String) Snapshot completion wait policy.

doc/source/configuration/tables/cinder-flashsystem.inc

@@ -1,28 +0,0 @@
-..
-    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-flashsystem:
-
-.. list-table:: Description of IBM FlashSystem volume driver configuration options
-   :header-rows: 1
-   :class: config-ref-table
-
-   * - Configuration option = Default value
-     - Description
-   * - **[DEFAULT]**
-     -
-   * - ``flashsystem_connection_protocol`` = ``FC``
-     - (String) Connection protocol should be FC. (Default is FC.)
-   * - ``flashsystem_iscsi_portid`` = ``0``
-     - (Integer) Default iSCSI Port ID of FlashSystem. (Default port is 0.)
-   * - ``flashsystem_multihostmap_enabled`` = ``True``
-     - (Boolean) Allows vdisk to multi host mapping. (Default is True)
-   * - ``flashsystem_multipath_enabled`` = ``False``
-     - (Boolean) DEPRECATED: This option no longer has any affect. It is deprecated and will be removed in the next release.

doc/source/configuration/tables/cinder-hgst.inc

@@ -1,32 +0,0 @@
-..
-    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-hgst:
-
-.. list-table:: Description of HGST volume driver configuration options
-   :header-rows: 1
-   :class: config-ref-table
-
-   * - Configuration option = Default value
-     - Description
-   * - **[DEFAULT]**
-     -
-   * - ``hgst_net`` = ``Net 1 (IPv4)``
-     - (String) Space network name to use for data transfer
-   * - ``hgst_redundancy`` = ``0``
-     - (String) Should spaces be redundantly stored (1/0)
-   * - ``hgst_space_group`` = ``disk``
-     - (String) Group to own created spaces
-   * - ``hgst_space_mode`` = ``0600``
-     - (String) UNIX mode for created spaces
-   * - ``hgst_space_user`` = ``root``
-     - (String) User to own created spaces
-   * - ``hgst_storage_servers`` = ``os:gbd0``
-     - (String) Comma separated list of Space storage servers:devices. ex: os1_stor:gbd0,os2_stor:gbd0

doc/source/configuration/tables/cinder-huawei.inc

@@ -1,34 +0,0 @@
-..
-    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-huawei:
-
-.. list-table:: Description of Huawei storage driver configuration options
-   :header-rows: 1
-   :class: config-ref-table
-
-   * - Configuration option = Default value
-     - Description
-   * - **[DEFAULT]**
-     -
-   * - ``cinder_huawei_conf_file`` = ``/etc/cinder/cinder_huawei_conf.xml``
-     - (String) The configuration file for the Cinder Huawei driver.
-   * - ``hypermetro_devices`` = ``None``
-     - (String) The remote device hypermetro will use.
-   * - ``metro_domain_name`` = ``None``
-     - (String) The remote metro device domain name.
-   * - ``metro_san_address`` = ``None``
-     - (String) The remote metro device request url.
-   * - ``metro_san_password`` = ``None``
-     - (String) The remote metro device san password.
-   * - ``metro_san_user`` = ``None``
-     - (String) The remote metro device san user.
-   * - ``metro_storage_pools`` = ``None``
-     - (String) The remote metro device pool names.

doc/source/configuration/tables/cinder-hyperv.inc

@@ -1,22 +0,0 @@
-..
-    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-hyperv:
-
-.. list-table:: Description of HyperV volume driver configuration options
-   :header-rows: 1
-   :class: config-ref-table
-
-   * - Configuration option = Default value
-     - Description
-   * - **[hyperv]**
-     -
-   * - ``force_volumeutils_v1`` = ``False``
-     - (Boolean) DEPRECATED: Force V1 volume utility class

doc/source/configuration/tables/cinder-pure.inc

@@ -1,34 +0,0 @@
-..
-    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-pure:
-
-.. list-table:: Description of Pure Storage driver configuration options
-   :header-rows: 1
-   :class: config-ref-table
-
-   * - Configuration option = Default value
-     - Description
-   * - **[DEFAULT]**
-     -
-   * - ``pure_api_token`` = ``None``
-     - (String) REST API authorization token.
-   * - ``pure_automatic_max_oversubscription_ratio`` = ``True``
-     - (Boolean) Automatically determine an oversubscription ratio based on the current total data reduction values. If used this calculated value will override the max_over_subscription_ratio config option.
-   * - ``pure_eradicate_on_delete`` = ``False``
-     - (Boolean) When enabled, all Pure volumes, snapshots, and protection groups will be eradicated at the time of deletion in Cinder. Data will NOT be recoverable after a delete with this set to True! When disabled, volumes and snapshots will go into pending eradication state and can be recovered.
-   * - ``pure_replica_interval_default`` = ``900``
-     - (Integer) Snapshot replication interval in seconds.
-   * - ``pure_replica_retention_long_term_default`` = ``7``
-     - (Integer) Retain snapshots per day on target for this time (in days.)
-   * - ``pure_replica_retention_long_term_per_day_default`` = ``3``
-     - (Integer) Retain how many snapshots for each day.
-   * - ``pure_replica_retention_short_term_default`` = ``14400``
-     - (Integer) Retain all snapshots on target for this time (in seconds.)

doc/source/configuration/tables/cinder-redis.inc

@@ -1,36 +0,0 @@
-..
-    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-redis:
-
-.. list-table:: Description of Redis configuration options
-   :header-rows: 1
-   :class: config-ref-table
-
-   * - Configuration option = Default value
-     - Description
-   * - **[matchmaker_redis]**
-     -
-   * - ``check_timeout`` = ``20000``
-     - (Integer) Time in ms to wait before the transaction is killed.
-   * - ``host`` = ``127.0.0.1``
-     - (String) DEPRECATED: Host to locate redis. Replaced by [DEFAULT]/transport_url
-   * - ``password`` =
-     - (String) DEPRECATED: Password for Redis server (optional). Replaced by [DEFAULT]/transport_url
-   * - ``port`` = ``6379``
-     - (Port number) DEPRECATED: Use this port to connect to redis host. Replaced by [DEFAULT]/transport_url
-   * - ``sentinel_group_name`` = ``oslo-messaging-zeromq``
-     - (String) Redis replica set name.
-   * - ``sentinel_hosts`` =
-     - (List) DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode), e.g., [host:port, host1:port ... ] Replaced by [DEFAULT]/transport_url
-   * - ``socket_timeout`` = ``10000``
-     - (Integer) Timeout in ms on blocking socket operations.
-   * - ``wait_timeout`` = ``2000``
-     - (Integer) Time in ms to wait between connection attempts.