openstack/cinder
Code Issues Proposed changes

Use new target_* options in documentation

Browse Source 
Various iscsi_* options were replaced with target_* options. The former
were initially deprecated and have now been removed.

This patch updates relevant documentation to use the new names.

There were some other hits in the documentation and code for these
names, but these appeared to be for third-party drivers, and I don't
have the context about which, if any, need to change.

Change-Id: Ic37ea85f4ec778644bc9d49f513e58dc28c87907
This commit is contained in:
Mark Goddard 2019-01-21 10:05:25 +00:00
parent c92fd87c0f
commit 583bc0899c
11 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
contrib/block-box/etc/cinder.conf
View File

@ -21,6 +21,6 @@ connection = mysql+pymysql://cinder:password@mariadb/cinder?charset=utf8
lvm_type = thin
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
volume_group = cinder-volumes
iscsi_protocol = iscsi
iscsi_helper = tgtadm
target_protocol = iscsi
target_helper = tgtadm
volume_backend_name=lvm

2
contrib/block-box/etc/cinder.conf.keystone
View File

@ -1,7 +1,7 @@
[DEFAULT]
rootwrap_config = /etc/cinder/rootwrap.conf
api_paste_confg = /etc/cinder/api-paste.ini
iscsi_helper = tgtadm
target_helper = tgtadm
volume_name_template = volume-%s
volume_group = cinder-volumes
verbose = True

2
contrib/block-box/etc/cinder.conf.sf
View File

@ -1,7 +1,7 @@
[DEFAULT]
rootwrap_config = /etc/cinder/rootwrap.conf
api_paste_confg = /etc/cinder/api-paste.ini
iscsi_helper = tgtadm
target_helper = tgtadm
volume_name_template = volume-%s
volume_group = cinder-volumes
verbose = True

4
doc/source/admin/blockstorage-lio-iscsi-support.rst
View File

@ -2,9 +2,9 @@
Use LIO iSCSI support
=====================
The default mode for the ``iscsi_helper`` tool is ``tgtadm``.
The default mode for the ``target_helper`` tool is ``tgtadm``.
To use LIO iSCSI, install the ``python-rtslib`` package, and set
``iscsi_helper=lioadm`` in the ``cinder.conf`` file.
``target_helper=lioadm`` in the ``cinder.conf`` file.
Once configured, you can use the :command:`cinder-rtstool` command to
manage the volumes. This command enables you to create, delete, and

2
doc/source/admin/blockstorage-multi-backend.rst
View File

@ -111,7 +111,7 @@ an example:
[backend_default]
image_volume_cache_enabled = True
volume_clear = none
iscsi_helper = tgtadm
target_helper = tgtadm
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
[backend1]

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

@ -13,14 +13,14 @@ the following options to configure for iSCSI transport:
.. code-block:: ini
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
iscsi_protocol = iscsi
target_protocol = iscsi
Use the following options to configure for the iSER transport:
.. code-block:: ini
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
iscsi_protocol = iser
target_protocol = iser
.. config-table::
:config-target: LVM

12
doc/source/configuration/tables/cinder-storage.inc
View File

@ -24,22 +24,22 @@
- (Floating point) Multiplier used for weighing free capacity. Negative numbers mean to stack vs spread.
* - ``enabled_backends`` = ``None``
- (List) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options
* - ``iscsi_helper`` = ``tgtadm``
* - ``target_helper`` = ``tgtadm``
- (String) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, scstadmin for SCST target support, ietadm for iSCSI Enterprise Target, iscsictl for Chelsio iSCSI Target or fake for testing.
* - ``iscsi_iotype`` = ``fileio``
- (String) Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device
* - ``iscsi_ip_address`` = ``$my_ip``
* - ``target_ip_address`` = ``$my_ip``
- (String) The IP address that the iSCSI daemon is listening on
* - ``iscsi_port`` = ``3260``
* - ``target_port`` = ``3260``
- (Port number) The port that the iSCSI daemon is listening on
* - ``iscsi_protocol`` = ``iscsi``
* - ``target_protocol`` = ``iscsi``
- (String) Determines the iSCSI protocol for new iSCSI volumes, created with tgtadm or lioadm target helpers. In order to enable RDMA, this parameter should be set with the value "iser". The supported iSCSI protocol values are "iscsi" and "iser".
* - ``iscsi_target_flags`` =
- (String) Sets the target-specific flags for the iSCSI target. Only used for tgtadm to specify backing device flags using bsoflags option. The specified string is passed as is to the underlying tool.
* - ``iscsi_target_prefix`` = ``iqn.2010-10.org.openstack:``
* - ``target_prefix`` = ``iqn.2010-10.org.openstack:``
- (String) Prefix for iSCSI volumes
* - ``iscsi_write_cache`` = ``on``
- (String) Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if iscsi_helper is set to tgtadm.
- (String) Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if target_helper is set to tgtadm.
* - ``iser_helper`` = ``tgtadm``
- (String) The name of the iSER target user-land tool to use
* - ``iser_ip_address`` = ``$my_ip``

4
doc/source/install/cinder-storage-install-obs.rst
View File

@ -205,8 +205,8 @@ Install and configure components
# ...
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
volume_group = cinder-volumes
iscsi_protocol = iscsi
iscsi_helper = tgtadm
target_protocol = iscsi
target_helper = tgtadm
.. end

4
doc/source/install/cinder-storage-install-rdo.rst
View File

@ -214,8 +214,8 @@ Install and configure components
[lvm]
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
volume_group = cinder-volumes
iscsi_protocol = iscsi
iscsi_helper = lioadm
target_protocol = iscsi
target_helper = lioadm
.. end

4
doc/source/install/cinder-storage-install-ubuntu.rst
View File

@ -204,8 +204,8 @@ Install and configure components
# ...
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
volume_group = cinder-volumes
iscsi_protocol = iscsi
iscsi_helper = tgtadm
target_protocol = iscsi
target_helper = tgtadm
.. end

2
etc/cinder/rootwrap.d/volume.filters
View File

@ -2,7 +2,7 @@
# This file should be owned by (and only-writeable by) the root user
[Filters]
# cinder/volume/iscsi.py: iscsi_helper '--op' ...
# cinder/volume/targets/iscsi.py: target_helper '--op' ...
iscsictl: CommandFilter, iscsictl, root
cinder-rtstool: CommandFilter, cinder-rtstool, root