From 06766dd34e15a6e90ae7e53a9a3edde8c153ebae Mon Sep 17 00:00:00 2001 From: Simon Dodsley Date: Thu, 30 May 2024 09:48:35 -0400 Subject: [PATCH] Update documentation This patch adds a definition for NQN into the glossary and adds additional items to the confog-options page to cover the parameters for volume_name_template and snapshot_name_template. Change-Id: Idd6b7fe41ce10a4f18a4bf554ab2e72303337dd1 --- doc/source/common/glossary.rst | 35 ++++++++++++++++--- .../block-storage/config-options.rst | 3 +- 2 files changed, 32 insertions(+), 6 deletions(-) diff --git a/doc/source/common/glossary.rst b/doc/source/common/glossary.rst index 77308ab0a13..9b30b875778 100644 --- a/doc/source/common/glossary.rst +++ b/doc/source/common/glossary.rst @@ -17,8 +17,33 @@ vocabulary for Cinder concepts. 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'. + 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`` + + NVMe Qualified Name (NQN) + + NQN is the format most commonly used for NVMe names, which uniquely + identify hosts or NVM subsystems in a network. + NQNs can follow one of two supported formats. + + The first format, used by organizations that own a domain, is + ``nqn.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 NQN unique under the same domain name. + + For example: ``nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432`` + + The second format is used to create unique identifiers when there is + not a naming authority or there is not a requirement for a human + interpretable string. This format is + ``nqn.2014-08.org.nvmexpress:uuid:identifier``, where only the + ``identifier`` is variable and consists of a 128-bit UUID based on the + definition in RFC 4122 represented as a string. + + For example: ``nqn.2014-08.org.nvmexpress:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6`` diff --git a/doc/source/configuration/block-storage/config-options.rst b/doc/source/configuration/block-storage/config-options.rst index 9ccb612e8de..af7bebedc48 100644 --- a/doc/source/configuration/block-storage/config-options.rst +++ b/doc/source/configuration/block-storage/config-options.rst @@ -81,9 +81,10 @@ These options can also be set in the ``cinder.conf`` file. .. config-table:: :config-target: common - :exclusive-list: global_opts + :exclusive-list: global_opts,db_opts cinder.common.config + cinder.db.api .. config-table:: :config-target: [profiler]