From nobody Mon May 6 11:49:27 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 154774807715444.737905343321586; Thu, 17 Jan 2019 10:01:17 -0800 (PST) Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id DAC5090901; Thu, 17 Jan 2019 18:01:13 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 369FE600C6; Thu, 17 Jan 2019 18:01:13 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 2A3333F602; Thu, 17 Jan 2019 18:01:12 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id x0HI1Ans006894 for ; Thu, 17 Jan 2019 13:01:10 -0500 Received: by smtp.corp.redhat.com (Postfix) id C66BB60933; Thu, 17 Jan 2019 18:01:10 +0000 (UTC) Received: from unknown0050b6a41c42.attlocal.net.com (ovpn-116-60.phx2.redhat.com [10.3.116.60]) by smtp.corp.redhat.com (Postfix) with ESMTP id 796A4608E5 for ; Thu, 17 Jan 2019 18:01:03 +0000 (UTC) From: John Ferlan To: libvir-list@redhat.com Date: Thu, 17 Jan 2019 13:00:59 -0500 Message-Id: <20190117180059.10631-1-jferlan@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH] docs: Add more iscsi-direct references to storage pages X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.29]); Thu, 17 Jan 2019 18:01:16 +0000 (UTC) Content-Type: text/plain; charset="utf-8" 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 --- noted while working on other stuff... Also although 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 type, which is one of dir, fs, netfs, disk, - iscsi, logical, scsi + iscsi, + iscsi-direct(since 4.7.0), + logical, scsi (all since 0.4.1), mpath (since 0.7.1), rbd (since 0.9.13), sheepdog @@ -125,11 +127,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. Contai= ns 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 +337,7 @@

host
Provides the source for pools backed by storage from a remote server (pool types netfs, iscsi, + iscsi-direct, rbd, sheepdog, gluster). Wi= ll be used in combination with a directory or device element. Contains an attribute name @@ -348,11 +352,19 @@ server. See the storage driver page f= or any restrictions for specific storage backends. Since 0.4.1
+
initiator
+
Required by the iscsi-direct pool in order to provi= de + 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 @@ =20

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 u= ses libiscsi. - It require a host, a path which is the target iqn and an initiator i= qn. + It requires a host, a path which is the target IQN, and an initiator= IQN.

=20

Example pool input

@@ -457,12 +457,12 @@ =20

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 eleme= nt.

=20

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 ele= ment.

=20

SCSI pool

--=20 2.20.1 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list