Skip to content

Document network boot (PXE) for virtual machines - #1145

Open
abonillabeeche wants to merge 8 commits into
harvester:mainfrom
abonillabeeche:docs-pxe-network-boot
Open

Document network boot (PXE) for virtual machines#1145
abonillabeeche wants to merge 8 commits into
harvester:mainfrom
abonillabeeche:docs-pxe-network-boot

Conversation

@abonillabeeche

@abonillabeeche abonillabeeche commented Oct 1, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Documents network boot (PXE) for virtual machines, added in harvester/harvester-ui-extension#1176 (harvester/harvester#3325).

Adds a Network Boot (PXE) section to docs/vm/create-vm.md, plus a pointer from the Secondary Network section. It covers:

  • prerequisites: an external DHCP/TFTP/HTTP boot server; BIOS and UEFI; Secure Boot
  • why the management network can't be used
  • how to enable it: the Enable network boot (PXE) checkbox on the Networks tab, and Before volumes / After volumes placement with when to use each
  • templates (VMs created from a template inherit the setting), and the Boot Order on the VM details page
  • the resulting bootOrder in the VM spec
  • caveats: changes need a restart; a VM waiting at the boot screen ignores ACPI shutdown, so Stop waits the grace period; NIC selection in installers on multi-NIC VMs

Screenshots go in the new static/img/v1.10/vm/ directory.

@abonillabeeche @claude
Document network boot (PXE) for virtual machines
443fa6e 
Add a Network Boot (PXE) section to the VM creation guide covering the
new Enable network boot (PXE) interface option and the Before/After
volumes boot order, along with prerequisites, templates, and caveats.

Related: harvester/harvester#3325
UI: harvester/harvester-ui-extension#1176

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Alejandro Bonilla <abonilla@suse.com>
@abonillabeeche
abonillabeeche requested review from a team and jillian-maroket as code owners October 1, 2026 03:58
@abonillabeeche

abonillabeeche commented Oct 1, 2026

Copy link
Copy Markdown
Contributor Author

@Yu-Jack could you please review this? It documents the PXE network boot option from harvester/harvester-ui-extension#1176. Thanks!

@asettle
asettle self-requested a review October 1, 2026 03:59
asettle
asettle requested changes Oct 1, 2026
View reviewed changes
Comment thread docs/vm/create-vm.md Outdated
Comment thread docs/vm/create-vm.md Outdated
Comment thread docs/vm/create-vm.md Outdated
Comment thread docs/vm/create-vm.md Outdated
Comment thread docs/vm/create-vm.md Outdated
Comment thread docs/vm/create-vm.md Outdated
Comment thread docs/vm/create-vm.md Outdated
abonillabeeche and others added 5 commits October 1, 2026 01:31
@abonillabeeche @asettle
Update create-vm.md
ac0fdac 
Co-authored-by: Alexandra Settle <asettle@suse.com>
Signed-off-by: Alejandro Bonilla <abonilla@suse.com>
@abonillabeeche @asettle
Update create-vm.md
b20a3c9 
Co-authored-by: Alexandra Settle <asettle@suse.com>
Signed-off-by: Alejandro Bonilla <abonilla@suse.com>
@abonillabeeche @asettle
Update create-vm.md
7381c8a 
Co-authored-by: Alexandra Settle <asettle@suse.com>
Signed-off-by: Alejandro Bonilla <abonilla@suse.com>
@abonillabeeche @asettle
Update create-vm.md
123f028 
Co-authored-by: Alexandra Settle <asettle@suse.com>
Signed-off-by: Alejandro Bonilla <abonilla@suse.com>
@abonillabeeche @asettle
Update create-vm.md
85c39ad 
Co-authored-by: Alexandra Settle <asettle@suse.com>
Signed-off-by: Alejandro Bonilla <abonilla@suse.com>
@Yu-Jack
Yu-Jack self-requested a review October 1, 2026 05:58
@abonillabeeche @asettle @claude
Apply review suggestion for network boot in templates
f872d3c 
Co-authored-by: Alexandra Settle <asettle@suse.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Alejandro Bonilla <abonilla@suse.com>
@abonillabeeche

abonillabeeche commented Oct 1, 2026

Copy link
Copy Markdown
Contributor Author

@asettle thanks for the review! All suggestions are applied (the last one in f872d3c with "enable network boot"). Could you take another look?

@abonillabeeche @asettle
Apply review suggestion for the PXE prerequisites
1a9d9df 
Co-authored-by: Alexandra Settle <asettle@suse.com>
Signed-off-by: Alejandro Bonilla <abonilla@suse.com>
@abonillabeeche

abonillabeeche commented Oct 2, 2026

Copy link
Copy Markdown
Contributor Author

@asettle I've also applied your prerequisites suggestion in 1a9d9df. I'd kept some extra wording on that line before, so it wasn't applied as written. Everything you suggested is in now. Ready for another look when you have time.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@asettle asettle asettle requested changes
@jillian-maroket jillian-maroket Awaiting requested review from jillian-maroket jillian-maroket is a code owner
@m-ildefons m-ildefons Awaiting requested review from m-ildefons m-ildefons is a code owner automatically assigned from harvester/dev
@Yu-Jack Yu-Jack Awaiting requested review from Yu-Jack

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@abonillabeeche @asettle