From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: 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 6453796B22 for ; Fri, 1 Mar 2024 09:05:47 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 3E8DC1DC55 for ; Fri, 1 Mar 2024 09:05:47 +0100 (CET) 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 ; Fri, 1 Mar 2024 09:05:45 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id E94A1481EF for ; Fri, 1 Mar 2024 09:05:44 +0100 (CET) From: Markus Frank To: pve-devel@lists.proxmox.com Date: Fri, 1 Mar 2024 09:05:22 +0100 Message-Id: <20240301080526.57798-4-m.frank@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240301080526.57798-1-m.frank@proxmox.com> References: <20240301080526.57798-1-m.frank@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.181 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 v9 3/7] add doc section for the shared filesystem virtio-fs X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 01 Mar 2024 08:05:47 -0000 Signed-off-by: Markus Frank --- qm.adoc | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 92 insertions(+), 2 deletions(-) diff --git a/qm.adoc b/qm.adoc index fa6a772..fa1de72 100644 --- a/qm.adoc +++ b/qm.adoc @@ -1056,6 +1056,95 @@ 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. It takes advantage of the locality of virtual machines and the +hypervisor to get a higher throughput than the 9p remote file system protocol. + +To use virtio-fs, the https://gitlab.com/virtio-fs/virtiofsd[virtiofsd] daemon +needs to run in the background. In {pve}, this process starts immediately before +the start of QEMU. + +Linux VMs with kernel >=5.4 support this feature by default. + +There is a guide available on how to utilize virtio-fs in Windows VMs. +https://github.com/virtio-win/kvm-guest-drivers-windows/wiki/Virtiofs:-Shared-file-system + +Known Limitations +^^^^^^^^^^^^^^^^^ + +* Virtiofsd crashing means no recovery until VM is fully stopped and restarted. +* Virtiofsd not responding may result in NFS-like hanging access in the VM. +* Memory hotplug does not work in combination with virtio-fs (also results in +hanging access). +* Live migration does not work. +* Windows cannot understand ACLs. Therefore, disable it for Windows VMs, +otherwise the virtio-fs device will not be visible within the VMs. + +Add Mapping for Shared Directories +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To add a mapping for a shared directory, either use the API directly with +`pvesh` as described in the xref:resource_mapping[Resource Mapping] section: + +---- +pvesh create /cluster/mapping/dir --id dir1 \ + --map node=node1,path=/path/to/share1 \ + --map node=node2,path=/path/to/share2,submounts=1 \ + --xattr 1 \ + --acl 1 +---- + +The `acl` parameter automatically implies `xattr`, that is, it makes no +difference whether you set `xattr` to `0` if `acl` is set to `1`. + +Set `submounts` to `1` when multiple file systems are mounted in a shared +directory to prevent the guest from creating duplicates because of file system +specific inode IDs that get passed through. + + +Add virtio-fs to a VM +^^^^^^^^^^^^^^^^^^^^^ + +To share a directory using virtio-fs, add the parameter `virtiofs` (N can be +anything between 0 and 9) to the VM config and use a directory ID (dirid) that +has been configured in the resource mapping. Additionally, you can set the +`cache` option to either `always`, `never`, or `auto` (default: `auto`), +depending on your requirements. How the different caching modes behave can be +read at https://lwn.net/Articles/774495/ under the title "Caching Modes". To +enable writeback cache set `writeback` to `1`. + +If you want virtio-fs to honor the `O_DIRECT` flag, you can set the `direct-io` +parameter to `1` (default: `0`). This will degrade performance, but is useful if +applications do their own caching. + +Additionally, it is possible to overwrite the default mapping settings for +`xattr` and `acl` by setting them to either `1` or `0`. The `acl` parameter +automatically implies `xattr`, that is, it makes no difference whether you set +`xattr` to `0` if `acl` is set to `1`. + +---- +qm set -virtiofs0 dirid=,cache=always,direct-io=1 +qm set -virtiofs1 ,cache=never,xattr=1 +qm set -virtiofs2 ,acl=1,writeback=1 +---- + +To mount virtio-fs in a guest VM with the Linux kernel virtio-fs driver, run the +following command inside the guest: + +---- +mount -t virtiofs +---- + +The dirid associated with the path on the current node is also used as the mount +tag (name used to mount the device on the guest). + +For more information on available virtiofsd parameters, see the +https://gitlab.com/virtio-fs/virtiofsd[GitLab virtiofsd project page]. + [[qm_bootorder]] Device Boot Order ~~~~~~~~~~~~~~~~~ @@ -1662,8 +1751,9 @@ in the relevant tab in the `Resource Mappings` category, or on the cli with [thumbnail="screenshot/gui-datacenter-mapping-pci-edit.png"] -Where `` is the hardware type (currently either `pci` or `usb`) and -`` are the device mappings and other configuration parameters. +Where `` is the hardware type (currently either `pci`, `usb` or +xref:qm_virtiofs[dir]) and `` 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