From 59176660fdacc3eb79faccf69d95d2baed6d5fec Mon Sep 17 00:00:00 2001 From: Shatadru Bandyopadhyay Date: Wed, 18 Dec 2019 11:37:17 +0530 Subject: [PATCH] doc: clarify usage of use_multipath_for_image_xfer parameter use_multipath_for_image_xfer and enforce_multipath_for_image_xfer need to be used for each backend section or in [backend_defaults] section in cinder.conf using it in default section will not have any effect. This patch fixes multiple driver doc regarding use_multipath_for_image_xfer and enforce_multipath_for_image_xfer parameter also added same help text in driver.py so that the sample config file indicates the same. Change-Id: I5c9b3e5142833f276e10c432a7705a8cd118be7c Closes-Bug: 1856612 --- cinder/volume/driver.py | 10 ++++++++-- .../block-storage/drivers/MacroSAN-storage-driver.rst | 6 ++++-- .../block-storage/drivers/dell-emc-powermax-driver.rst | 6 +++--- .../block-storage/drivers/dell-emc-unity-driver.rst | 4 +++- .../block-storage/drivers/dell-emc-xtremio-driver.rst | 3 ++- .../block-storage/drivers/huawei-storage-driver.rst | 5 +++-- .../block-storage/drivers/infortrend-volume-driver.rst | 4 +++- 7 files changed, 26 insertions(+), 12 deletions(-) diff --git a/cinder/volume/driver.py b/cinder/volume/driver.py index 6c9c474897f..4f28a7eb6ec 100644 --- a/cinder/volume/driver.py +++ b/cinder/volume/driver.py @@ -312,12 +312,18 @@ image_opts = [ cfg.BoolOpt('use_multipath_for_image_xfer', default=False, help='Do we attach/detach volumes in cinder using multipath ' - 'for volume to image and image to volume transfers?'), + 'for volume to image and image to volume transfers? ' + 'This parameter needs to be configured for each backend ' + 'section or in [backend_defaults] section as a common ' + 'configuration for all backends.'), cfg.BoolOpt('enforce_multipath_for_image_xfer', default=False, help='If this is set to True, attachment of volumes for ' 'image transfer will be aborted when multipathd is not ' - 'running. Otherwise, it will fallback to single path.'), + 'running. Otherwise, it will fallback to single path. ' + 'This parameter needs to be configured for each backend ' + 'section or in [backend_defaults] section as a common ' + 'configuration for all backends.'), ] diff --git a/doc/source/configuration/block-storage/drivers/MacroSAN-storage-driver.rst b/doc/source/configuration/block-storage/drivers/MacroSAN-storage-driver.rst index 9f8f3762b9f..456b12e5c7c 100644 --- a/doc/source/configuration/block-storage/drivers/MacroSAN-storage-driver.rst +++ b/doc/source/configuration/block-storage/drivers/MacroSAN-storage-driver.rst @@ -23,11 +23,13 @@ To use the MacroSAN drivers, the following are required: - HTTPS or HTTP must be enabled on the array When creating a volume from image, install the ``multipath`` tool and add the -following configuration keys in the ``[DEFAULT]`` configuration group of -the ``/etc/cinder/cinder.conf`` file: +following configuration keys for each backend section or in +``[backend_defaults]`` section as a common configuration for all backends in +``/etc/cinder/cinder.conf`` file: .. code-block:: ini + [cinder-iscsi-a] use_multipath_for_image_xfer = True When creating a instance from image, install the ``multipath`` tool and add the diff --git a/doc/source/configuration/block-storage/drivers/dell-emc-powermax-driver.rst b/doc/source/configuration/block-storage/drivers/dell-emc-powermax-driver.rst index 9b4d2f60333..3efb2945611 100644 --- a/doc/source/configuration/block-storage/drivers/dell-emc-powermax-driver.rst +++ b/doc/source/configuration/block-storage/drivers/dell-emc-powermax-driver.rst @@ -1091,9 +1091,9 @@ On Compute (Nova) node, add the following flag in the ``[libvirt]`` section of volume_use_multipath = True -On Cinder controller node, iSCSI MPIO can be set globally in the -[DEFAULT] section or set individually in the PowerMax backend stanza in -:file:`/etc/cinder/cinder.conf`: +On Cinder controller node, multipath for image transfer can be enabled in +``/etc/cinder/cinder.conf`` for each backend section or +in ``[backend_defaults]`` section as a common configuration for all backends. .. code-block:: ini diff --git a/doc/source/configuration/block-storage/drivers/dell-emc-unity-driver.rst b/doc/source/configuration/block-storage/drivers/dell-emc-unity-driver.rst index 11f8de52b7e..d6b7d6d7d78 100644 --- a/doc/source/configuration/block-storage/drivers/dell-emc-unity-driver.rst +++ b/doc/source/configuration/block-storage/drivers/dell-emc-unity-driver.rst @@ -145,7 +145,9 @@ Driver configuration # service multipath-tools restart -#. Enable multipath for image transfer in ``/etc/cinder/cinder.conf``. +#. Enable multipath for image transfer in ``/etc/cinder/cinder.conf`` for each + backend or in ``[backend_defaults]`` section as a common configuration + for all backends. .. code-block:: ini diff --git a/doc/source/configuration/block-storage/drivers/dell-emc-xtremio-driver.rst b/doc/source/configuration/block-storage/drivers/dell-emc-xtremio-driver.rst index c4e1d172ab0..ab24b906fd3 100644 --- a/doc/source/configuration/block-storage/drivers/dell-emc-xtremio-driver.rst +++ b/doc/source/configuration/block-storage/drivers/dell-emc-xtremio-driver.rst @@ -160,7 +160,8 @@ modified as follows: - Multipathing The ``use_multipath_for_image_xfer`` parameter in the ``cinder.conf`` file - should be set to ``True`` as follows: + should be set to ``True`` for each backend or in ``[backend_defaults]`` + section as a common configuration for all backends. .. code-block:: ini diff --git a/doc/source/configuration/block-storage/drivers/huawei-storage-driver.rst b/doc/source/configuration/block-storage/drivers/huawei-storage-driver.rst index 8b19ab94851..fc30eccbd80 100644 --- a/doc/source/configuration/block-storage/drivers/huawei-storage-driver.rst +++ b/doc/source/configuration/block-storage/drivers/huawei-storage-driver.rst @@ -123,8 +123,9 @@ iSCSI storage or Fibre Channel storage. **Pre-requisites** When creating a volume from image, install the ``multipath`` tool and add the -following configuration keys in the ``[DEFAULT]`` configuration group of -the ``/etc/cinder/cinder.conf`` file: +following configuration keys for each backend section or in +``[backend_defaults]`` section as a common configuration for all backends in +``/etc/cinder/cinder.conf`` file: .. code-block:: ini diff --git a/doc/source/configuration/block-storage/drivers/infortrend-volume-driver.rst b/doc/source/configuration/block-storage/drivers/infortrend-volume-driver.rst index c9bc891aafd..a7740e76ae2 100644 --- a/doc/source/configuration/block-storage/drivers/infortrend-volume-driver.rst +++ b/doc/source/configuration/block-storage/drivers/infortrend-volume-driver.rst @@ -103,7 +103,9 @@ Fibre Channel configuration example Multipath configuration ----------------------- -* Enable multipath for image transfer in ``/etc/cinder/cinder.conf``. +* Enable multipath for image transfer in ``/etc/cinder/cinder.conf`` for each + back end or in ``[backend_defaults]`` section as a common configuration + for all backends. .. code-block:: ini