From 583bc0899c3d83de17c18420dfc72a041d2cbaeb Mon Sep 17 00:00:00 2001 From: Mark Goddard Date: Mon, 21 Jan 2019 10:05:25 +0000 Subject: [PATCH] Use new target_* options in documentation 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 --- contrib/block-box/etc/cinder.conf | 4 ++-- contrib/block-box/etc/cinder.conf.keystone | 2 +- contrib/block-box/etc/cinder.conf.sf | 2 +- doc/source/admin/blockstorage-lio-iscsi-support.rst | 4 ++-- doc/source/admin/blockstorage-multi-backend.rst | 2 +- .../block-storage/drivers/lvm-volume-driver.rst | 4 ++-- doc/source/configuration/tables/cinder-storage.inc | 12 ++++++------ doc/source/install/cinder-storage-install-obs.rst | 4 ++-- doc/source/install/cinder-storage-install-rdo.rst | 4 ++-- doc/source/install/cinder-storage-install-ubuntu.rst | 4 ++-- etc/cinder/rootwrap.d/volume.filters | 2 +- 11 files changed, 22 insertions(+), 22 deletions(-) diff --git a/contrib/block-box/etc/cinder.conf b/contrib/block-box/etc/cinder.conf index 73b20903d34..faf6b376669 100644 --- a/contrib/block-box/etc/cinder.conf +++ b/contrib/block-box/etc/cinder.conf @@ -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 diff --git a/contrib/block-box/etc/cinder.conf.keystone b/contrib/block-box/etc/cinder.conf.keystone index 74168d360c6..f165022e992 100644 --- a/contrib/block-box/etc/cinder.conf.keystone +++ b/contrib/block-box/etc/cinder.conf.keystone @@ -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 diff --git a/contrib/block-box/etc/cinder.conf.sf b/contrib/block-box/etc/cinder.conf.sf index d4397f1fa05..9817ae2e53d 100644 --- a/contrib/block-box/etc/cinder.conf.sf +++ b/contrib/block-box/etc/cinder.conf.sf @@ -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 diff --git a/doc/source/admin/blockstorage-lio-iscsi-support.rst b/doc/source/admin/blockstorage-lio-iscsi-support.rst index b2d525ff98d..914ed3cdcc6 100644 --- a/doc/source/admin/blockstorage-lio-iscsi-support.rst +++ b/doc/source/admin/blockstorage-lio-iscsi-support.rst @@ -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 diff --git a/doc/source/admin/blockstorage-multi-backend.rst b/doc/source/admin/blockstorage-multi-backend.rst index 49bdfdf17a9..3c9f8559b90 100644 --- a/doc/source/admin/blockstorage-multi-backend.rst +++ b/doc/source/admin/blockstorage-multi-backend.rst @@ -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] diff --git a/doc/source/configuration/block-storage/drivers/lvm-volume-driver.rst b/doc/source/configuration/block-storage/drivers/lvm-volume-driver.rst index 10fb618b73a..ae685d7996f 100644 --- a/doc/source/configuration/block-storage/drivers/lvm-volume-driver.rst +++ b/doc/source/configuration/block-storage/drivers/lvm-volume-driver.rst @@ -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 diff --git a/doc/source/configuration/tables/cinder-storage.inc b/doc/source/configuration/tables/cinder-storage.inc index 447fd1bb514..c5365402e20 100644 --- a/doc/source/configuration/tables/cinder-storage.inc +++ b/doc/source/configuration/tables/cinder-storage.inc @@ -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`` diff --git a/doc/source/install/cinder-storage-install-obs.rst b/doc/source/install/cinder-storage-install-obs.rst index 603cfa9aa3c..3ecf1d9d801 100644 --- a/doc/source/install/cinder-storage-install-obs.rst +++ b/doc/source/install/cinder-storage-install-obs.rst @@ -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 diff --git a/doc/source/install/cinder-storage-install-rdo.rst b/doc/source/install/cinder-storage-install-rdo.rst index 0a6134fe8f0..0c98c1a71b2 100644 --- a/doc/source/install/cinder-storage-install-rdo.rst +++ b/doc/source/install/cinder-storage-install-rdo.rst @@ -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 diff --git a/doc/source/install/cinder-storage-install-ubuntu.rst b/doc/source/install/cinder-storage-install-ubuntu.rst index 14026815a10..ba5a6101b39 100644 --- a/doc/source/install/cinder-storage-install-ubuntu.rst +++ b/doc/source/install/cinder-storage-install-ubuntu.rst @@ -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 diff --git a/etc/cinder/rootwrap.d/volume.filters b/etc/cinder/rootwrap.d/volume.filters index 74498591b83..713807f48cc 100644 --- a/etc/cinder/rootwrap.d/volume.filters +++ b/etc/cinder/rootwrap.d/volume.filters @@ -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