noon
Found that it was missing in formatstorage and had a few typos
in the storage driver page.
Signed-off-by: John Ferlan <jferlan(a)redhat.com>
---
noted while working on other stuff...
Also although <initiator> is supported by the "iscsi" pool as well,
it's
not something ever documented since commit 6aabcb5bd (0.7.5). I could add
a note that it's optional to use with the "iscsi" pool if desired.
docs/formatstorage.html.in | 20 ++++++++++++++++----
docs/storage.html.in | 8 ++++----
2 files changed, 20 insertions(+), 8 deletions(-)
diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in
index b6bf3edbd2..979e170c08 100644
--- a/docs/formatstorage.html.in
+++ b/docs/formatstorage.html.in
@@ -18,7 +18,9 @@
The top level tag for a storage pool document is 'pool'. It has
a single attribute <code>type</code>, which is one of
<code>dir</code>,
<code>fs</code>, <code>netfs</code>,
<code>disk</code>,
- <code>iscsi</code>, <code>logical</code>,
<code>scsi</code>
+ <code>iscsi</code>,
+ <code>iscsi-direct</code>(<span class="since">since
4.7.0</span>),
+ <code>logical</code>, <code>scsi</code>
(all <span class="since">since 0.4.1</span>),
<code>mpath</code>
(<span class="since">since 0.7.1</span>),
<code>rbd</code>
(<span class="since">since 0.9.13</span>),
<code>sheepdog</code>
@@ -125,11 +127,12 @@
<dt><code>device</code></dt>
<dd>Provides the source for pools backed by physical devices
(pool types <code>fs</code>, <code>logical</code>,
<code>disk</code>,
- <code>iscsi</code>, <code>zfs</code>,
<code>vstorage</code>).
+ <code>iscsi</code>, <code>iscsi-direct</code>,
<code>zfs</code>,
+ <code>vstorage</code>).
May be repeated multiple times depending on backend driver. Contains
a required attribute <code>path</code> which is either the fully
qualified path to the block device node or for <code>iscsi</code>
- the iSCSI Qualified Name (IQN).
+ or <code>iscsi-direct</code> the iSCSI Qualified Name (IQN).
<span class="since">Since 0.4.1</span>
<p>An optional attribute <code>part_separator</code> for each
<code>path</code> may be supplied. Valid values for the attribute
@@ -334,6 +337,7 @@
<dt><code>host</code></dt>
<dd>Provides the source for pools backed by storage from a
remote server (pool types <code>netfs</code>,
<code>iscsi</code>,
+ <code>iscsi-direct</code>,
<code>rbd</code>, <code>sheepdog</code>,
<code>gluster</code>). Will be
used in combination with a <code>directory</code>
or <code>device</code> element. Contains an attribute
<code>name</code>
@@ -348,11 +352,19 @@
server. See the <a href="storage.html">storage driver
page</a> for
any restrictions for specific storage backends.
<span class="since">Since 0.4.1</span></dd>
+ <dt><code>initiator</code></dt>
+ <dd>Required by the <code>iscsi-direct</code> pool in order to
provide
+ the iSCSI Qualified Name (IQN) to communicate with the pool's
+ <code>device</code> target IQN. There is one sub-element
+ <code>iqn</code> with the <code>name</code> attribute to
describe
+ the IQN for the initiator.
+ <span class="since">Since 4.7.0</span></dd>
<dt><code>auth</code></dt>
<dd>If present, the <code>auth</code> element provides the
authentication credentials needed to access the source by the
setting of the <code>type</code> attribute (pool
- types <code>iscsi</code>, <code>rbd</code>). The
<code>type</code>
+ types <code>iscsi</code>, <code>iscsi-direct</code>,
<code>rbd</code>).
+ The <code>type</code>
must be either "chap" or "ceph". Use "ceph" for
Ceph RBD (Rados Block Device) network sources and use "iscsi" for CHAP
(Challenge-Handshake Authentication Protocol) iSCSI
diff --git a/docs/storage.html.in b/docs/storage.html.in
index 9adcc2a87f..c8617aace5 100644
--- a/docs/storage.html.in
+++ b/docs/storage.html.in
@@ -437,9 +437,9 @@
<h2><a id="StorageBackendISCSIDirect">iSCSI direct
pool</a></h2>
<p>
- This is a variant of the iSCSI pool. Instead of unsing iscsiadm, it uses
+ This is a variant of the iSCSI pool. Instead of using iscsiadm, it uses
libiscsi.
- It require a host, a path which is the target iqn and an initiator iqn.
+ It requires a host, a path which is the target IQN, and an initiator IQN.
</p>
<h3>Example pool input</h3>
@@ -457,12 +457,12 @@
<h3>Valid pool format types</h3>
<p>
- The iSCSI volume pool does not use the pool format type element.
+ The iSCSI direct volume pool does not use the pool format type element.
</p>
<h3>Valid volume format types</h3>
<p>
- The iSCSI volume pool does not use the volume format type element.
+ The iSCSI direct volume pool does not use the volume format type element.
</p>
<h2><a id="StorageBackendSCSI">SCSI pool</a></h2>
--
2.20.1