From f779dece392924d976143fdf3d910f0ba6a6f8a5 Mon Sep 17 00:00:00 2001 From: yangyapeng Date: Wed, 14 Oct 2015 02:08:39 -0400 Subject: [PATCH] Adding IQN to the glossary Abbreviation of IQN is not easy to understand, add a description about it.Document containing the glossary, for example: doc/admin-guide-cloud/source/ts_non_existent_host.rst doc/admin-guide-cloud/source/ts_cinder_config.rst doc/admin-guide-cloud/source/ts-duplicate-3par-host.rst doc/admin-guide-cloud/source/blockstorage-manage-volumes.rst Change-Id: Ia9588d4f2e081f2b7d8f6a63286c9fdbf60f6a96 --- .../source/blockstorage-manage-volumes.rst | 2 +- .../source/ts-duplicate-3par-host.rst | 2 +- .../source/ts_cinder_config.rst | 2 +- .../source/ts_non_existent_host.rst | 4 ++-- doc/glossary/glossary-terms.xml | 17 +++++++++++++++++ 5 files changed, 22 insertions(+), 5 deletions(-) diff --git a/doc/admin-guide-cloud/source/blockstorage-manage-volumes.rst b/doc/admin-guide-cloud/source/blockstorage-manage-volumes.rst index ed94a32aac..d69dfbd5b8 100644 --- a/doc/admin-guide-cloud/source/blockstorage-manage-volumes.rst +++ b/doc/admin-guide-cloud/source/blockstorage-manage-volumes.rst @@ -27,7 +27,7 @@ to a server instance. #. Use the :command:`cinder create` command to create a volume. This command creates an LV into the volume group (VG) ``cinder-volumes``. #. Use the nova :command:`volume-attach` command to attach the volume - to an instance. This command creates a unique iSCSI IQN that is + to an instance. This command creates a unique :term:`IQN` that is exposed to the compute node. * The compute node, which runs the instance, now has an active diff --git a/doc/admin-guide-cloud/source/ts-duplicate-3par-host.rst b/doc/admin-guide-cloud/source/ts-duplicate-3par-host.rst index 283c7caaa7..690cdccc5c 100644 --- a/doc/admin-guide-cloud/source/ts-duplicate-3par-host.rst +++ b/doc/admin-guide-cloud/source/ts-duplicate-3par-host.rst @@ -10,7 +10,7 @@ Problem This error may be caused by a volume being exported outside of OpenStack using a host name different from the system name that OpenStack expects. -This error could be displayed with the IQN if the host was exported +This error could be displayed with the :term:`IQN` if the host was exported using iSCSI:: Duplicate3PARHost: 3PAR Host already exists: Host wwn 50014380242B9750 \ diff --git a/doc/admin-guide-cloud/source/ts_cinder_config.rst b/doc/admin-guide-cloud/source/ts_cinder_config.rst index 9104060bce..6426487e34 100644 --- a/doc/admin-guide-cloud/source/ts_cinder_config.rst +++ b/doc/admin-guide-cloud/source/ts_cinder_config.rst @@ -110,7 +110,7 @@ these suggested solutions. The OpenStack Block Storage uses ``tgtd`` as the default iSCSI helper and implements persistent targets. This means that in the case of a ``tgt`` restart or even a node reboot your existing volumes on that node - will be restored automatically with their original IQN. + will be restored automatically with their original :term:`IQN`. In order to make this possible the iSCSI target information needs to be stored in a file on creation that can be queried in case of diff --git a/doc/admin-guide-cloud/source/ts_non_existent_host.rst b/doc/admin-guide-cloud/source/ts_non_existent_host.rst index 52096cf953..2ac4acaab0 100644 --- a/doc/admin-guide-cloud/source/ts_non_existent_host.rst +++ b/doc/admin-guide-cloud/source/ts_non_existent_host.rst @@ -7,8 +7,8 @@ Problem This error could be caused by a volume being exported outside of OpenStack using a host name different from the system name that -OpenStack expects. This error could be displayed with the IQN if the -host was exported using iSCSI. +OpenStack expects. This error could be displayed with the :term:`IQN` +if the host was exported using iSCSI. :: diff --git a/doc/glossary/glossary-terms.xml b/doc/glossary/glossary-terms.xml index c71b36f817..c5c241596f 100644 --- a/doc/glossary/glossary-terms.xml +++ b/doc/glossary/glossary-terms.xml @@ -4771,6 +4771,23 @@ + + IQN + + iSCSI Qualified Name (IQN) + + + + iSCSI Qualified Name (IQN) is the format most commonly used + for iSCSI names, which uniquely identify nodes in an iSCSI network. + All IQNs follow the pattern iqn.yyyy-mm.domain:identifier, where + 'yyyy-mm' is the year and month in which the domain was registered, + 'domain' is the reversed domain name of the issuing organization, and + 'identifier' is an optional string which makes each IQN under the same + domain unique. For example, 'iqn.2015-10.org.openstack.408ae959bce1'. + + + iSCSI