openstack/cinder
Code Issues Proposed changes

Update documentation

Browse Source 
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
This commit is contained in:
Simon Dodsley 2024-05-30 09:48:35 -04:00
parent 2ad9fe9156
commit 06766dd34e
2 changed files with 32 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/source/common/glossary.rst
View File

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

3
doc/source/configuration/block-storage/config-options.rst
View File

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