Skip to content

docs(appliance): install-paths guide — which artifact, which hypervisor#534

Merged
aaronsb merged 1 commit into
mainfrom
docs/appliance-install-paths
Jun 16, 2026
Merged

docs(appliance): install-paths guide — which artifact, which hypervisor#534
aaronsb merged 1 commit into
mainfrom
docs/appliance-install-paths

Conversation

@aaronsb

@aaronsb aaronsb commented Jun 16, 2026

Copy link
Copy Markdown
Owner

What

Documents the appliance install paths, straight from the v0.17.0 dogfood. Closes the third of the three threads.

docs/self-host/appliance-libvirt.md — new "Pick your path" section up top:

  • artifact↔hypervisor table: VirtualBox/VMware/Hyper-V → generic OVA (import wizard); libvirt/Proxmox/QEMU → native qcow2 (virt-install --import); OVA-on-libvirt → use the qcow2 or hand-convert (virt-v2v noted as overkill — a heavy guest-conversion tool for an already-KVM-native image).
  • copy-paste qcow2 zero-config quick-start (unxzvirt-install --import), with the --import-still-needs-the-VM-definition gotcha called out (the "unrecognized arguments" trap) + GUI "Import existing disk image" / Debian 12.
  • zero-config first-boot walkthrough (DHCP IP → HTTP :3000, creds on console/kg-credentials.txt) and the bootstrap-seed convergence note (operator.sh upgrade keeps it current — ADR-103/119).
  • Troubleshooting: "virt-manager has no OVA import" and "--import file.qcow2 → unrecognized arguments".

appliance/README.md — first-boot cross-links the path table so a README reader gets steered to the right artifact.

Why

The dogfood proved the qcow2 is the native, easy path on libvirt (the OVA is friction there), that virt-v2v is the wrong tool, and that zero-config first boot Just Works — but none of that was written down. This captures it for the next person.

Test

doclint + link_check: 0/0 (new anchors + ADR links resolve).

…ick-start

From the v0.17.0 dogfood. appliance-libvirt.md gains a 'Pick your path' table
(VirtualBox/VMware → generic OVA wizard; libvirt/Proxmox → native qcow2; OVA-on-
libvirt → use qcow2 or hand-convert, virt-v2v noted as overkill), a copy-paste
qcow2 zero-config quick-start (unxz → virt-install --import) with the --import
gotcha called out, the zero-config first-boot walkthrough, and the bootstrap-seed
convergence note (ADR-103/119). Troubleshooting gains the OVA-won't-import and
bare-positional --import entries. README first-boot cross-links the path table.
@aaronsb aaronsb merged commit 3cdb82d into main Jun 16, 2026
6 checks passed
@aaronsb aaronsb deleted the docs/appliance-install-paths branch June 16, 2026 23:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant