Extensions-List: document the image-output-iso extension - #949
Conversation
Add a reference entry for the uefi-iso extension (live ISO from a UEFI image for BMC/IPMI virtual-CD boot; amd64/arm64, riscv64 experimental), with its UEFI-only / Secure-Boot-off requirements and its parameters. Signed-off-by: Igor Pecovnik <igor@armbian.com>
WalkthroughAdded a Developer Guide entry for the Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
iav
left a comment
There was a problem hiding this comment.
The text is stronger than the PR in one place, and silent about one way to end up without an image.
"Works on amd64 and arm64 UEFI targets" — armbian/build#10314 marks arm64 as "arch-aware code in place, not yet tested on hardware". On top of that, the chroot used for grub-mkstandalone there runs after the static qemu has been removed from ${MOUNT}, so a cross-built arm64 image may not get that far. Worth saying the same thing the PR says: the code is there, untested on hardware.
The extension gates on [[ "${BOARD}" != uefi* ]], i.e. on the board name rather than the family. qemu-uefi-x86 (BOARDFAMILY=uefi-x86, config/boards/qemu-uefi-x86.csc:16) does not match and gets "disabled: only supported on UEFI boards". If the gate stays as is, listing "uefi-x86 / uefi-arm64" is accurate, but it is worth noting that qemu-uefi-x86 is not one of them.
UEFI_ISO_VOLID's default is given; UEFI_ISO_COMP (zstd) and UEFI_ISO_TIMEOUT (1) have none.
Also: since the .img is dropped by default, worth warning that CARD_DEVICE then silently writes nothing (details in my review on #10314). If that gets fixed there, the line is unnecessary.
Signed-off-by: Igor Pecovnik <igor@armbian.com>
Move the entry into the image-output-* family (alongside qcow2/vhdx/...) and update the parameter names (SKIP_ISO, ISO_VOLID, ISO_COMP, ISO_TIMEOUT, ISO_KEEP_IMG). Signed-off-by: Igor Pecovnik <igor@armbian.com>
Adds a reference entry for the image-output-iso extension (was
uefi-iso) toDeveloper-Guide_Extensions-List.md, placed in theimage-output-*family alongside qcow2/vhdx/ovf/etc.image-output-iso builds a bootable live
.isofrom a UEFI image for BMC/IPMI virtual CD-ROM boot — boot the live system, then install to disk witharmbian-install. Covers supported arches (amd64/arm64; riscv64 experimental), thegrubdependency, the UEFI-only / Secure-Boot-off requirements, and the parameters.Companion to armbian/build#10314.
Documentation website preview will be available shortly:
Open WWW preview