Skip to content

docs: add a QEMU/KVM guide for evaluating TunaOS in a VM (closes #216) - #234

Merged
hanthor-hive-agent[bot] merged 1 commit into
tuna-os:mainfrom
dchaudhari7177:docs/evaluating-in-a-vm
Aug 14, 2026
Merged

docs: add a QEMU/KVM guide for evaluating TunaOS in a VM (closes #216)#234
hanthor-hive-agent[bot] merged 1 commit into
tuna-os:mainfrom
dchaudhari7177:docs/evaluating-in-a-vm

Conversation

@dchaudhari7177

Copy link
Copy Markdown
Contributor

Closes #216.

system-requirements.md listed hypervisors and VM specs, but there was no guide for actually doing it — so the safest first step for an evaluator had no page.

What's here

  • docs/tunaos/evaluating-in-a-vm.md — the guide
  • sidebars.ts — registered under Documentation, next to tunaos/introduction
  • docs/system-requirements.md — a link from the Virtualization section, which is where someone already lands when asking "can I run this in a VM"

Every fact comes from the repo

I deliberately didn't invent any numbers or ISO names:

Content Source
ISO table (Albacore / Yellowfin, GNOME + HWE) installation.md
4 GB / 25 GB min, 8 GB / 50 GB recommended system-requirements.md
"~15–20 GB base, 25–30 GB with apps" (why 25 GB is tight) system-requirements.md
Layering / upgrade / rollback next steps linked to bootc-usage.md, not restated
"not sure which variant" defers to choosing-a-variant.md

The parts that actually stop a first attempt

The guide covers both virt-manager and raw qemu-system-x86_64, and leads with the two things that waste an evening:

  • UEFI firmware must be selected. TunaOS images are built for UEFI; a VM left on the legacy BIOS default won't boot the installer. Called out in both the virt-manager steps and the QEMU flags.
  • The OVMF path differs by host distro/usr/share/OVMF/OVMF_CODE.fd on Debian-family, /usr/share/edk2/ovmf/OVMF_CODE.fd on Fedora-family. A copy-pasted command fails on half of hosts otherwise.

It also recommends snapshotting immediately after first boot, because rollback is the most interesting thing to try and a snapshot makes trying it free — which is really the argument for evaluating a bootc system in a VM at all.

Two smaller notes: plain GNOME is the right ISO for a VM (HWE targets newer physical hardware and buys nothing against virtual devices), and other flavors are reachable via bootc switch rather than an ISO.

Verification

  • npm run build succeeds; the page renders at build/docs/tunaos/evaluating-in-a-vm.html
  • its references to choosing-a-variant, bootc-usage, installation, system-requirements and download.tunaos.org are all present in the built output
  • the sidebar entry appears on sibling pages
  • Docusaurus fails the build on broken links by default, so a green build is the internal-link check the issue asks for

The one [WARNING] Docusaurus found broken anchors (/docs/iso-builder/native/user-guide/docs/iso-builder#quick-start) is pre-existing — I re-ran the build on a stashed working tree and it appears identically there.

What I could not verify

An actual install run inside a VM. The commands are standard QEMU/virt-manager usage and the figures are all sourced above, but the issue's "15–20 min for a first-time user" claim deserves a real run by someone on a Linux host before you take it as tested.


While checking for overlap I noticed #214 appears already donedocs/choosing-a-variant.md exists and is registered in sidebars.ts, added by 59e611c ("docs: add Choosing your TunaOS variant decision guide (#214) (#225)"). Might be worth closing.

🤖 Generated with Claude Code

system-requirements.md listed hypervisors and VM specs but there was no
guide for actually doing it, so the safest first step for an evaluator
had no page.

Adds docs/tunaos/evaluating-in-a-vm.md, registered in sidebars.ts under
Documentation next to tunaos/introduction, and linked from the
Virtualization section of system-requirements.md - the place someone
already lands when asking "can I run this in a VM".

Every fact is taken from the repo rather than invented:

- the ISO table is copied from installation.md (Albacore and Yellowfin,
  GNOME and GNOME-HWE)
- VM specs are the ones already in system-requirements.md (4 GB/25 GB
  minimum, 8 GB/50 GB recommended), with the disk-usage figures from the
  same page explaining why 25 GB is tight
- next steps point at the existing bootc-usage.md rather than restating
  layering/upgrade/rollback
- the "not sure which variant" path defers to choosing-a-variant.md

Covers both virt-manager and raw qemu-system-x86_64, and calls out the
two things that actually stop a first attempt: UEFI firmware must be
selected (the images will not boot under legacy BIOS) and the OVMF path
differs between Fedora- and Debian-family hosts. It also recommends
snapshotting straight after first boot, since rollback is the thing most
worth trying and a snapshot makes it free.

Notes that plain GNOME is the right ISO for a VM - HWE targets newer
physical hardware and buys nothing against virtual devices - and that
other flavors are reachable via bootc switch rather than an ISO.

Verified: npm run build succeeds, the page renders at
build/docs/tunaos/evaluating-in-a-vm.html, its references to
choosing-a-variant, bootc-usage, installation, system-requirements and
download.tunaos.org are all present in the output, and the sidebar entry
appears on sibling pages. Docusaurus fails the build on broken links, so
a green build is the link check.

The one broken-anchor warning (/docs/iso-builder/native/user-guide ->
/docs/iso-builder#quick-start) is pre-existing; it appears identically on
a pristine build of this commit.

Not verified: an actual install run inside a VM. The commands are
standard QEMU/virt-manager usage, but someone with a Linux host should
confirm the 15-20 minute claim end to end.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant