From: John Ferlan Date: Thu, 17 Jan 2019 17:49:00 +0000 (-0500) Subject: docs: Add more iscsi-direct references to storage pages X-Git-Tag: v5.1.0-rc1~384 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6bf28f386017cae86b7b22c28223b85ed64cf57f;p=thirdparty%2Flibvirt.git docs: Add more iscsi-direct references to storage pages Found that it was missing in formatstorage and had a few typos in the storage driver page. Signed-off-by: John Ferlan Reviewed-by: Cole Robinson --- diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index b6bf3edbd2..be4aa26105 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -19,14 +19,15 @@ a single attribute type, which is one of dir, fs, netfs, disk, iscsi, logical, scsi - (all since 0.4.1), mpath - (since 0.7.1), rbd - (since 0.9.13), sheepdog - (since 0.10.0), - gluster (since - 1.2.0), zfs (since - 1.2.8) or vstorage (since - 3.1.0). This corresponds to the + (all since 0.4.1), + mpath (since 0.7.1), + rbd (since 0.9.13), + sheepdog (since 0.10.0), + gluster (since 1.2.0), + zfs (since 1.2.8), + vstorage (since 3.1.0), + or iscsi-direct (since 4.7.0). + This corresponds to the storage backend drivers listed further along in this document.

General metadata

@@ -125,11 +126,12 @@
device
Provides the source for pools backed by physical devices (pool types fs, logical, disk, - iscsi, zfs, vstorage). + iscsi, iscsi-direct, zfs, + vstorage). May be repeated multiple times depending on backend driver. Contains a required attribute path which is either the fully qualified path to the block device node or for iscsi - the iSCSI Qualified Name (IQN). + or iscsi-direct the iSCSI Qualified Name (IQN). Since 0.4.1

An optional attribute part_separator for each path may be supplied. Valid values for the attribute @@ -334,6 +336,7 @@

host
Provides the source for pools backed by storage from a remote server (pool types netfs, iscsi, + iscsi-direct, rbd, sheepdog, gluster). Will be used in combination with a directory or device element. Contains an attribute name @@ -348,11 +351,19 @@ server. See the storage driver page for any restrictions for specific storage backends. Since 0.4.1
+
initiator
+
Required by the iscsi-direct pool in order to provide + the iSCSI Qualified Name (IQN) to communicate with the pool's + device target IQN. There is one sub-element + iqn with the name attribute to describe + the IQN for the initiator. + Since 4.7.0
auth
If present, the auth element provides the authentication credentials needed to access the source by the setting of the type attribute (pool - types iscsi, rbd). The type + types iscsi, iscsi-direct, rbd). + The type 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 @@

iSCSI direct pool

- 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.

Example pool input

@@ -457,12 +457,12 @@

Valid pool format types

- 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.

Valid volume format types

- 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.

SCSI pool