From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 483BD1FF15C for ; Wed, 19 Feb 2025 12:49:57 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 424DF1F6E7; Wed, 19 Feb 2025 12:49:51 +0100 (CET) Message-ID: <10c885a7-2588-4940-a69a-6279401e3c26@proxmox.com> Date: Wed, 19 Feb 2025 12:49:44 +0100 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird From: Fiona Ebner To: Proxmox VE development discussion , Markus Frank References: <20250122100901.74830-1-m.frank@proxmox.com> <20250122100901.74830-4-m.frank@proxmox.com> Content-Language: en-US In-Reply-To: <20250122100901.74830-4-m.frank@proxmox.com> X-SPAM-LEVEL: Spam detection results: 0 AWL -0.197 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 KAM_SHORT 0.001 Use of a URL Shortener for very short URL 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 RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [gitlab.com, lwn.net] Subject: Re: [pve-devel] [PATCH docs v13 3/12] 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: , Reply-To: Proxmox VE development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" Am 22.01.25 um 11:08 schrieb Markus Frank: > Signed-off-by: Markus Frank > --- > qm.adoc | 92 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-- > 1 file changed, 90 insertions(+), 2 deletions(-) > > diff --git a/qm.adoc b/qm.adoc > index 4bb8f2c..5ad79c1 100644 > --- a/qm.adoc > +++ b/qm.adoc > @@ -1202,6 +1202,93 @@ 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 designed for virtual environments. It allows > +to share a directory tree available on the host by mounting it within VMs. It > +does not use the network stack and aims to offer similar performance and > +semantics as the source file system. > + > +To use virtio-fs, the https://gitlab.com/virtio-fs/virtiofsd[virtiofsd] daemon > +needs to run in the background. This happens automatically in {pve} when > +starting a related VM. Nit: "related" sounds a bit vague IMHO. Maybe be explicit with something like "when starting a VM using a virtio-fs mount" > + > +Linux VMs with kernel >=5.4 support virtio-fs 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 > +^^^^^^^^^^^^^^^^^ > + > +* If Virtiofsd should crash, its mount point will hang in the VM until the VM Nit: "If Virtiofsd should crash" -> "If virtiofsd crashes" > +is completely stopped. > +* Virtiofsd not responding may result in NFS-like hanging access in the VM. Nit: again, I'd not capitalize virtiofsd "NFS-like hanging access" might not be clear to all users. Maybe something like "a hanging mount in the VM, similar to an unreachable NFS" > +* Memory hotplug does not work in combination with virtio-fs (also results in > +hanging access). > +* Memory related features such as live migration, snapshots, and hibernate are > +not available with virtio-fs devices. > +* Windows cannot understand ACLs. Therefore, disable it for Windows VMs, "ACLs" -> "ACLs in the context of virtio-fs" or "ACLs for virtio-fs mounts" Nit: "disable it" -> "disable ACLs", never hurts to be explicit in docs > +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, you can 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 \ The example still uses 'submounts' rather than 'announce-submounts'. > +---- > + > +Set `announce-submounts` to `1` if multiple filesystems are mounted in a shared > +directory, to tell the guest which directories are mount points to prevent data Nit: I'd split it in two sentences: "directory. This tells" > +loss/corruption. With `announce-submounts`, virtiofsd reports a different device > +number for each submount it encounters. Without it, duplicates may be created > +because inode IDs are only unique on a single filesystem. > + > +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 "Caching Modes" section. 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. > + I'd add a sentence describing expose-acl and expose-xattr first. And mention again that expose-acl should not be used for Windows to make it unlikely that user miss it. > +The `expose-acl` parameter automatically implies `expose-xattr`, that is, it > +makes no difference if you set `expose-xattr` to `0` if `expose-acl` is set to > +`1`. > + > +---- > +qm set -virtiofs0 dirid=,cache=always,direct-io=1 > +qm set -virtiofs1 ,cache=never,expose-xattr=1 > +qm set -virtiofs2 ,expose-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 > ~~~~~~~~~~~~~~~~~ > @@ -1885,8 +1972,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 _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel