From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <m.frank@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 808E0C226 for <pve-devel@lists.proxmox.com>; Thu, 6 Jul 2023 12:55:05 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 62F221D847 for <pve-devel@lists.proxmox.com>; Thu, 6 Jul 2023 12:54:35 +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>; Thu, 6 Jul 2023 12:54:34 +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 7261746BEA for <pve-devel@lists.proxmox.com>; Thu, 6 Jul 2023 12:54:34 +0200 (CEST) From: Markus Frank <m.frank@proxmox.com> To: pve-devel@lists.proxmox.com Date: Thu, 6 Jul 2023 12:54:13 +0200 Message-Id: <20230706105421.54949-4-m.frank@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230706105421.54949-1-m.frank@proxmox.com> References: <20230706105421.54949-1-m.frank@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.207 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: [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: Thu, 06 Jul 2023 10:55:05 -0000 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. +The parameter `hugepages` must be disabled to use virtio-fs. + +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: + +---- +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 +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 +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: +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