From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <c.heiss@proxmox.com> Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 05E8FD938 for <pve-devel@lists.proxmox.com>; Mon, 17 Jul 2023 10:08:23 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id D9FC6AC92 for <pve-devel@lists.proxmox.com>; Mon, 17 Jul 2023 10:08:22 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for <pve-devel@lists.proxmox.com>; Mon, 17 Jul 2023 10:08:22 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id EDD0E425E8 for <pve-devel@lists.proxmox.com>; Mon, 17 Jul 2023 10:08:21 +0200 (CEST) Date: Mon, 17 Jul 2023 10:08:20 +0200 From: Christoph Heiss <c.heiss@proxmox.com> To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>, Markus Frank <m.frank@proxmox.com> Message-ID: <jsx6amnxxhnnq3uz657lgodc7jrugsxasbl52drbq4l34odapa@cu32q4igoxzw> References: <20230706105421.54949-1-m.frank@proxmox.com> <20230706105421.54949-4-m.frank@proxmox.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20230706105421.54949-4-m.frank@proxmox.com> X-SPAM-LEVEL: Spam detection results: 0 AWL -0.209 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment POISEN_SPAM_PILL 0.1 Meta: its spam POISEN_SPAM_PILL_1 0.1 random spam to be learned in bayes POISEN_SPAM_PILL_3 0.1 random spam to be learned in bayes SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: Re: [pve-devel] [PATCH docs v6 1/1] added shared filesystem doc for virtio-fs X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com> List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>, <mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe> List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/> List-Post: <mailto:pve-devel@lists.proxmox.com> List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help> List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe> X-List-Received-Date: Mon, 17 Jul 2023 08:08:23 -0000 w.r.t the subject line: s/added/add/, should not be past-tense As mentioned in the cover letter reply, a sentence explaining what the mount tag is and about the virtio/WinFsp drivers situation would also be useful. On Thu, Jul 06, 2023 at 12:54:13PM +0200, Markus Frank wrote: > > Signed-off-by: Markus Frank <m.frank@proxmox.com> > --- > qm.adoc | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-- > 1 file changed, 58 insertions(+), 2 deletions(-) > > diff --git a/qm.adoc b/qm.adoc > index e35dbf0..00a0668 100644 > --- a/qm.adoc > +++ b/qm.adoc > @@ -997,6 +997,61 @@ recommended to always use a limiter to avoid guests using too many host > resources. If desired, a value of '0' for `max_bytes` can be used to disable > all limits. > > +[[qm_virtiofs]] > +Virtio-fs > +~~~~~~~~~ > + > +Virtio-fs is a shared file system, that enables sharing a directory between > +host and guest VM while taking advantage of the locality of virtual machines > +and the hypervisor to get a higher throughput than 9p. Maybe add a sentence about availability/compatibility? E.g. it is supported since Linux 5.4 from what I could quickly gather. Minimum virtio drivers version for Windows would also be useful, I guess. There are always some people who try to run some ancient software. > +The parameter `hugepages` must be disabled to use virtio-fs. This can probably be reworded a bit, to make it clear that this means the VM configuration parameter. Something like e.g.: "This feature is incompatible with the hugepages feature. The `hugepages` VM configuration option must thus be disabled if virtio-fs is to be used." > + > +Add mapping for Shared Directories > +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ > + > +To add a mapping, go to the Resource Mapping tab in Datacenter in the WebUI, > +use the API directly with pvesh as described in the > +xref:resource_mapping[Resource Mapping] section, > +or add the mapping to the configuration file /etc/pve/mapping/dir.cfg: nit: The path should be surrounded with backticks for monospacing > + > +---- > +some-dir-id > + map node=node1,path=/share/,xattr=1,acl=1,submounts=1 > + map node=node2,path=/share/,xattr=1 > + map node=node3,path=/different-share-path/,submounts=1 > + map node=node4,path=/foobar/ > + map node=node5,path=/somewhere/,acl=1 > +---- > + > +The Parameter `acl` automatically implies `xattr`, so there would be no need to nit: ^^^^^^^^^ should be lowercase > +set `xattr` for node1 in this example. > +Set `submounts` to `1` when using multiple file systems in the shared directory. > + > +Add virtiofs to VM > +^^^^^^^^^^^^^^^^^^ > + > +To share a directory with virtio-fs, you need to specify the directory ID nit: s/with/using/ ^^^^ > +that has been configured in the Resource Mapping. Additionally, you can set > +the `cache` option to either `always`, `never`, or `auto`, depending on your > +requirements. If you want virtio-fs to honor the `O_DIRECT` flag, you can set the > +`direct-io` parameter to `1`. > + > +---- > +qm set <vmid> -virtiofs0 dirid=<dirid>,tag=<mount tag>,cache=always,direct-io=1 > +qm set <vmid> -virtiofs1 <dirid>,tag=<mount tag>,cache=never > +qm set <vmid> -virtiofs2 <dirid>,tag=<mount tag> > +---- > + > +To mount virtio-fs in a guest VM with the Linux kernel virtiofs driver, run the > +following command: > + > +---- > +mount -t virtiofs <mount tag> <mount point> > +---- > + > +For more information on the virtiofsd parameters, see: Maybe better written like: "For more information on available virtiofsd parameters, see the https://gitlab.com/virtio-fs/virtiofsd[GitLab project page]." > +https://gitlab.com/virtio-fs/virtiofsd[GitLab virtiofsd] > + > [[qm_bootorder]] > Device Boot Order > ~~~~~~~~~~~~~~~~~ > @@ -1600,8 +1655,9 @@ in the relevant tab in the `Resource Mappings` category, or on the cli with > # pvesh create /cluster/mapping/<type> <options> > ---- > > -Where `<type>` is the hardware type (currently either `pci` or `usb`) and > -`<options>` are the device mappings and other configuration parameters. > +Where `<type>` is the hardware type (currently either `pci`, `usb` or > +xref:qm_virtiofs[dir]) and `<options>` are the device mappings and other > +configuration parameters. > > Note that the options must include a map property with all identifying > properties of that hardware, so that it's possible to verify the hardware did > -- > 2.39.2 > > > > _______________________________________________ > pve-devel mailing list > pve-devel@lists.proxmox.com > https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel > >