openstack/cinder
Code Issues Proposed changes

doc: clarify usage of use_multipath_for_image_xfer parameter

Browse Source 
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
This commit is contained in:
Shatadru Bandyopadhyay 2019-12-18 11:37:17 +05:30
parent 632f178e8e
commit 59176660fd
7 changed files with 26 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
cinder/volume/driver.py
View File

@ -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.'),
]

6
doc/source/configuration/block-storage/drivers/MacroSAN-storage-driver.rst
View File

@ -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

6
doc/source/configuration/block-storage/drivers/dell-emc-powermax-driver.rst
View File

@ -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

4
doc/source/configuration/block-storage/drivers/dell-emc-unity-driver.rst
View File

@ -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

3
doc/source/configuration/block-storage/drivers/dell-emc-xtremio-driver.rst
View File

@ -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

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

@ -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

4
doc/source/configuration/block-storage/drivers/infortrend-volume-driver.rst
View File

@ -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