From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:51498) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1c1dO5-00039B-J1 for qemu-devel@nongnu.org; Tue, 01 Nov 2016 14:02:19 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1c1dO1-0005ea-6v for qemu-devel@nongnu.org; Tue, 01 Nov 2016 14:02:17 -0400 Received: from mx1.redhat.com ([209.132.183.28]:54490) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1c1dO0-0005eP-Vx for qemu-devel@nongnu.org; Tue, 01 Nov 2016 14:02:13 -0400 Received: from int-mx11.intmail.prod.int.phx2.redhat.com (int-mx11.intmail.prod.int.phx2.redhat.com [10.5.11.24]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 11D68C04B936 for ; Tue, 1 Nov 2016 18:02:12 +0000 (UTC) References: <1478003344-3208-1-git-send-email-prasanna.kalever@redhat.com> From: Eric Blake Message-ID: Date: Tue, 1 Nov 2016 13:02:10 -0500 MIME-Version: 1.0 In-Reply-To: <1478003344-3208-1-git-send-email-prasanna.kalever@redhat.com> Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="UiFN2xKuUmv9I1c9Jt0luUcM9g9g2LjxO" Subject: Re: [Qemu-devel] [PATCH v1 1/1] qemu-doc: update gluster protocol usage guide List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Prasanna Kumar Kalever , qemu-devel@nongnu.org Cc: jcody@redhat.com, vbellur@redhat.com This is an OpenPGP/MIME signed message (RFC 4880 and 3156) --UiFN2xKuUmv9I1c9Jt0luUcM9g9g2LjxO From: Eric Blake To: Prasanna Kumar Kalever , qemu-devel@nongnu.org Cc: jcody@redhat.com, vbellur@redhat.com Message-ID: Subject: Re: [Qemu-devel] [PATCH v1 1/1] qemu-doc: update gluster protocol usage guide References: <1478003344-3208-1-git-send-email-prasanna.kalever@redhat.com> In-Reply-To: <1478003344-3208-1-git-send-email-prasanna.kalever@redhat.com> Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable On 11/01/2016 07:29 AM, Prasanna Kumar Kalever wrote: > Document: > 1. The new debug and logfile options with their usages and > 2. New json format and its usage. >=20 > Signed-off-by: Prasanna Kumar Kalever > --- > qemu-doc.texi | 46 ++++++++++++++++++++++++++++++++-------------- > qemu-options.hx | 14 ++++++++++++-- > 2 files changed, 44 insertions(+), 16 deletions(-) >=20 > diff --git a/qemu-doc.texi b/qemu-doc.texi > index 023c140..a7c5722 100644 > --- a/qemu-doc.texi > +++ b/qemu-doc.texi > @@ -1041,35 +1041,50 @@ GlusterFS is an user space distributed file sys= tem. > =20 > You can boot from the GlusterFS disk image with the command: > @example > -qemu-system-x86_64 -drive file=3Dgluster[+@var{transport}]://[@var{ser= ver}[:@var{port}]]/@var{volname}/@var{image}[?socket=3D...] > +URI: > +qemu-system-x86_64 -drive file=3Dgluster[+@var{type}]://[@var{host}[:@= var{port}]]/@var{volume}/@var{path}[?socket=3D...] > + > +JSON: > +qemu-system-x86_64 'json:@{"driver":"qcow2","file":@{"driver":"gluster= ","volume":"testvol","path":"a.img","debug":"N","logfile":"...","server":= [@{"type":"tcp","host":"...","port":"..."@},@{"type":"unix","socket":"...= "@}]@}@}' "debug":"N" does not match the schema; the parameter is named "debug-level", and it is an integer not a string. The parameter is optional; you could just omit it. But if you are going to include it, give a reasonable example like "debug-level":0. Can you break up this long line for legibility? > @end example > =20 > @var{gluster} is the protocol. > =20 > -@var{transport} specifies the transport type used to connect to gluste= r > +@var{type} specifies the transport type used to connect to gluster > management daemon (glusterd). Valid transport types are > -tcp, unix and rdma. If a transport type isn't specified, then tcp > -type is assumed. > +tcp, unix. Incase of URI, if a transport type isn't specified, s/tcp, unix/tcp and unix/ s/Incase of URI/In the URI form/ > +then tcp type is assumed. > =20 > -@var{server} specifies the server where the volume file specification = for > -the given volume resides. This can be either hostname, ipv4 address > -or ipv6 address. ipv6 address needs to be within square brackets [ ]. > -If transport type is unix, then @var{server} field should not be speci= fied. > +@var{host} specifies the server where the volume file specification fo= r > +the given volume resides. This can be either hostname, ipv4 address. s/hostname, ipv4/a hostname or an ipv4/ > +If transport type is unix, then @var{host} field should not be specifi= ed. > Instead @var{socket} field needs to be populated with the path to unix= domain > socket. > =20 > @var{port} is the port number on which glusterd is listening. This is = optional > -and if not specified, QEMU will send 0 which will make gluster to use = the > -default port. If the transport type is unix, then @var{port} should no= t be > -specified. > +and if not specified, it default to port 24007. If the transport type = is unix, s/default/defaults/ > +then @var{port} should not be specified. > + > +@var{volume} is the name of the gluster volume which contains the disk= image. > + > +@var{path} is the path to the actual disk image that resides on gluste= r volume. > + > +@var{debug} is the logging level of the gluster protocol driver. Debug= levels Again, the schema for BlockdevOptionsGluster spells this debug-level, so you need to fix this paragraph. > +are 0-9, with 9 being the most verbose, and 0 representing no debuggin= g output. > +Default is level of 4. The current logging levels defined in the glus= ter source s/Default is level of 4/The default level is 4/ > +are 0 - None, 1 - Emergency, 2 - Alert, 3 - Critical, 4 - Error, 5 - W= arning, > +6 - Notice, 7 - Info, 8 - Debug, 9 - Trace > + > +@var{logfile} is a commandline option to mention log file path which h= elps in > +logging to the specified file and also help in persisting the gfapi lo= gs. The > +default is stderr. > + > =20 > @@ -1082,6 +1097,9 @@ qemu-system-x86_64 -drive file=3Dgluster+tcp://[1= :2:3:4:5:6:7:8]:24007/testvol/dir > qemu-system-x86_64 -drive file=3Dgluster+tcp://server.domain.com:24007= /testvol/dir/a.img > qemu-system-x86_64 -drive file=3Dgluster+unix:///testvol/dir/a.img?soc= ket=3D/tmp/glusterd.socket > qemu-system-x86_64 -drive file=3Dgluster+rdma://1.2.3.4:24007/testvol/= a.img > +qemu-system-x86_64 -drive file=3Dgluster://1.2.3.4/testvol/a.img,file.= debug=3D9,file.logfile=3D/var/log/qemu-gluster.log Should be file.debug-level > +qemu-system-x86_64 'json:@{"driver":"qcow2","file":@{"driver":"gluster= ","volume":"testvol","path":"a.img","debug":"9","logfile":"/var/log/qemu-= gluster.log","server":[@{"type":"tcp","host":"1.2.3.4","port":24007@},@{"= type":"unix","socket":"/var/run/glusterd.socket"@}]@}@}' > +qemu-system-x86_64 -drive driver=3Dqcow2,file.driver=3Dgluster,file.vo= lume=3Dtestvol,file.path=3D/path/a.img,file.debug=3D9,file.logfile=3D/var= /log/qemu-gluster.log,file.server.0.type=3Dtcp,file.server.0.host=3D1.2.3= =2E4,file.server.0.port=3D24007,file.server.1.type=3Dunix,file.server.1.s= ocket=3D/var/run/glusterd.socket Two more incorrect uses of debug. > +++ b/qemu-options.hx > @@ -2595,13 +2595,23 @@ TCP, Unix Domain Sockets and RDMA transport pro= tocols. > =20 > Syntax for specifying a VM disk image on GlusterFS volume is > @example > -gluster[+transport]://[server[:port]]/volname/image[?socket=3D...] > + > +URI: > +gluster[+type]://[host[:port]]/volume/path[?socket=3D...][,debug=3DN][= ,logfile=3D...] Again, isn't this debug-level? > + > +JSON: > +'json:@{"driver":"qcow2","file":@{"driver":"gluster","volume":"testvol= ","path":"a.img","debug":"N","logfile":"...","server":[@{"type":"tcp","ho= st":"...","port":"..."@},@{"type":"unix","socket":"..."@}]@}@}' and this example matches the incorrect commit message > @end example > =20 > =20 > Example > @example > -qemu-system-x86_64 --drive file=3Dgluster://192.0.2.1/testvol/a.img > +URI: > +qemu-system-x86_64 --drive file=3Dgluster://192.0.2.1/testvol/a.img,fi= le.debug=3D9,file.logfile=3D/var/log/qemu-gluster.log > + > +JSON: > +qemu-system-x86_64 'json:@{"driver":"qcow2","file":@{"driver":"gluster= ","volume":"testvol","path":"a.img","debug":"9","logfile":"/var/log/qemu-= gluster.log","server":[@{"type":"tcp","host":"1.2.3.4","port":24007@},@{"= type":"unix","socket":"/var/run/glusterd.socket"@}]@}@}' > +qemu-system-x86_64 -drive driver=3Dqcow2,file.driver=3Dgluster,file.vo= lume=3Dtestvol,file.path=3D/path/a.img,file.debug=3D9,file.logfile=3D/var= /log/qemu-gluster.log,file.server.0.type=3Dtcp,file.server.0.host=3D1.2.3= =2E4,file.server.0.port=3D24007,file.server.1.type=3Dunix,file.server.1.s= ocket=3D/var/run/glusterd.socket More uses of debug > @end example > =20 > See also @url{http://www.gluster.org}. >=20 --=20 Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org --UiFN2xKuUmv9I1c9Jt0luUcM9g9g2LjxO Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 Comment: Public key at http://people.redhat.com/eblake/eblake.gpg Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/ iQEcBAEBCAAGBQJYGNiiAAoJEKeha0olJ0Nq7swH/3ueQoYbLmOeLmU5dSFYWEmu qHZLaOd0l7x+g8QH5WMHdAs5nEO4BcQda5XS7XH3AATpLizcaP7U1CGYLDgK9WTv +ESRZVRbRUP2wjSR4xVr+9FeGMeAXlqaZRe5RHgCb27keN5XrtcjND2+VUV/E63G ugVP9ftx1lDWJtB2dcXaN8rm285rvLd+Zhodrpr+rEwhSdFQaKwBFzXiOnKPc7xY 0L9z0/viOSES88a5n6Cw/iY9GNf0AyicDnPTnFc9NmqIYrRngpW1hJnssGKv2w2F iSOuQXxNFQcOXt4Ho1ZH73Z21gY5UseZtgJEyW324IWcoh3ZGz67ue6TKX3j69g= =s7yw -----END PGP SIGNATURE----- --UiFN2xKuUmv9I1c9Jt0luUcM9g9g2LjxO--