Merge pull request #1163 from AkihiroSuda/dev

vz: update docs

Author: AkihiroSuda

docs/mount.md

@@ -8,7 +8,7 @@ The default mount type is shown in the following table:
 | ---------------- | ----------------------------------- |
 | < 0.10           | reverse-sshfs + Builtin SFTP server |
 | >= 0.10          | reverse-sshfs + OpenSSH SFTP server |
-| >= 1.0 (Planned) | 9p                                  |
+| >= 1.0 (Planned) | 9p for QEMU, virtiofs for VZ        |
 
 ## Mount types
 
@@ -49,6 +49,9 @@ Lima prior to v0.10 had used "builtin" as the SFTP driver.
 - A compromised `sshfs` process in the guest may have an access to unexposed host directories.
 
 ### 9p
+> **Warning**
+> "9p" mode is experimental
+
 The "9p" mount type is implemented by using QEMU's virtio-9p-pci devices.
 virtio-9p-pci is also known as "virtfs", but note that this is unrelated to [virtio-fs](https://virtio-fs.gitlab.io/).
 
@@ -81,6 +84,12 @@ The "9p" mount type requires Lima v0.10.0 or later.
 - The "9p" mount type is known to be incompatible with CentOS, Rocky Linux, and AlmaLinux as their kernel do not support `CONFIG_NET_9P_VIRTIO`.
 
 ### virtiofs
+> **Warning**
+> "virtiofs" mode is experimental
+
+| :zap: Requirement | Lima >= 0.14, macOS >= 13.0 |
+|-------------------|-----------------------------|
+
 The "virtiofs" mount type is implemented by using apple Virtualization.Framework shared directory (uses virtio-fs) device. 
 Linux guest kernel must enable the CONFIG_VIRTIO_FS support for this support.
 
@@ -92,7 +101,5 @@ mounts:
 - location: "~"
 ```
 
-The "vz" mount type requires Lima v0.14.0 or later.
-
 #### Caveats
-- The "virtiofs" mount type is supported only on macOS 13 or above with `vmType: vz` config.
+- The "virtiofs" mount type is supported only on macOS 13 or above with `vmType: vz` config. See also [`vmtype.md`](./vmtype.md).

docs/vmtype.md

@@ -9,6 +9,12 @@ Lima supports two ways of running guest machines:
 This option is used by default if "vmType" is not set.
 
 ## VZ
+> **Warning**
+> "vz" mode is experimental
+
+| :zap: Requirement | Lima >= 0.14, macOS >= 13.0 |
+|-------------------|-----------------------------|
+
 "vz" option makes use of native virtualization support provided by macOS Virtualization.Framework.
 
 An example configuration:
@@ -32,4 +38,4 @@ mountType: "virtiofs"
 ### Known Issues
 - "vz" doesn't support `legacyBoot: true` option, so guest machine like centos-stream, archlinux, oraclelinux will not work
 - Host to guest networking (`networks` section in lima yaml) is not supported
-- When running lima using "vz", `${LIMA_HOME}/<INSTANCE>/serial.log` will not contain kernel boot logs
+- When running lima using "vz", `${LIMA_HOME}/<INSTANCE>/serial.log` will not contain kernel boot logs

examples/default.yaml

@@ -5,6 +5,10 @@
 # Default values in this YAML file are specified by `null` instead of Lima's "builtin default" values,
 # so they can be overridden by the $LIMA_HOME/_config/default.yaml mechanism documented at the end of this file.
 
+# VM type: "qemu" or "vz" (on macOS 13 and later).
+# 🟢 Builtin default: "qemu"
+vmType: null
+
 # Arch: "default", "x86_64", "aarch64".
 # 🟢 Builtin default: "default" (corresponds to the host architecture)
 arch: null
@@ -88,7 +92,8 @@ mounts:
   # 🔵 This file: true (only for "/tmp/lima")
   writable: true
 
-# Mount type for above mounts, such as "reverse-sshfs" (from sshocker) or "9p" (EXPERIMENTAL, from QEMU’s virtio-9p-pci, aka virtfs)
+# Mount type for above mounts, such as "reverse-sshfs" (from sshocker), "9p" (EXPERIMENTAL, from QEMU’s virtio-9p-pci, aka virtfs),
+# or "virtiofs" (EXPERIMENTAL, needs `vmType: vz`)
 # 🟢 Builtin default: "reverse-sshfs"
 mountType: null
 

examples/experimental/vz.yaml

@@ -1,4 +1,5 @@
 # Example to run ubuntu using vmType: vz instead of qemu (Default)
+# This example requires Lima v0.14.0 or later.
 vmType: "vz"
 images:
 - location: "https://cloud-images.ubuntu.com/releases/22.04/release/ubuntu-22.04-server-cloudimg-amd64.img"