phoebus_os/docs/VIRTUAL-MACHINES.md
Phoebus e98d4ed38e
Some checks are pending
ci / test (push) Waiting to run
feat(vm): configure guest integration and VirGL defaults
2026-10-01 16:08:04 -07:00

43 lines
3.2 KiB
Markdown

# Virtual machine guests
Phoebus detects the installer environment with `systemd-detect-virt --vm` and
DMI vendor/product information. A Mango desktop install selects only the
matching guest tools. The distribution kernel and Mesa remain the graphics
foundation; the hypervisor must expose its accelerated adapter and the host
must provide acceleration. Guest software cannot create 3D acceleration when
the host disables it.
| Host | Phoebus install selection | Host graphics setting | Resize path |
|---|---|---|---|
| QEMU/KVM | `qemu-guest-agent`, `spice-vdagent`, Mesa `virgl`, `wlr-randr` | VirtIO GPU with VirGL and a GL-capable display; the Phoebus `run-vm.sh` chooses `virtio-vga-gl` automatically when the host has a usable render node | GTK scales the visible guest image to the window. For guest resolution changes, provide a SPICE vdagent channel and a client that sends display configuration (for example virt-viewer). |
| VMware | `open-vm-tools` with `resolutionkms`, Mesa `vmware`, `wlr-randr` | Enable the VMware accelerated graphics adapter in VM settings | `vmtoolsd` plus the virtual DRM driver's preferred-mode events; Phoebus applies a newly advertised preferred mode in Mango. |
| VirtualBox | Guest Additions with `gui`, Mesa `vmware` for the VMSVGA adapter, `wlr-randr` | Select VMSVGA and enable 3D acceleration if the host supports it | Guest Additions service and `VBoxClient-all` in the Mango session; Phoebus also applies a newly advertised preferred mode. |
The display watcher acts only when the hypervisor advertises a *new* preferred
mode. A manual choice remains in place if the preferred mode did not change.
If DMS has written an output configuration, Phoebus leaves it alone. The
existing low-VGA boot promotion now checks the `wlr-randr` output correctly.
`run-vm.sh --graphics auto` is the default for the disposable interactive
QEMU launcher. `--graphics gl` requires VirGL; `--graphics 2d` is an explicit
compatibility choice. The launcher uses `virtio-vga` variants so the UEFI and
LUKS prompt remain visible. It also provides a QEMU guest-agent virtio port;
Gentoo's udev rule starts the otherwise static guest-agent unit when that port
appears.
## Verification boundary
The visible QEMU playground booted and reached Mango + DarkMaterialShell with
`virtio-vga-gl`; the guest kernel reported `+virgl`. In this VM, GTK window
resizing scaled the guest image, but did not change the guest's advertised
preferred mode. The QEMU resize watcher therefore cannot claim guest
resolution changes through this GTK setup. The new `wlr-randr` package was
installed and its output inspected in this disposable VM. Portage dependency
previews resolved the QEMU, VMware and VirtualBox package atoms. VMware and
VirtualBox guest sessions, 3D rendering and resize events still require tests
in those hypervisors before they are called VM verified.
The guest setup follows [QEMU's VirtIO GPU documentation](https://www.qemu.org/docs/master/system/devices/virtio/virtio-gpu.html),
[SPICE's guest agent description](https://www.spice-space.org/spice-user-manual.html),
[Oracle's VirtualBox Guest Additions manual](https://download.virtualbox.org/virtualbox/7.2.2/UserManual.pdf),
and the [Gentoo guest package guidance](https://wiki.gentoo.org/wiki/Virtual_machines).