Skip to content

Extensions-List: document the image-output-iso extension - #949

Merged
igorpecovnik merged 3 commits into
mainfrom
add-uefi-iso-extension-docs
Aug 3, 2026
Merged

Extensions-List: document the image-output-iso extension#949
igorpecovnik merged 3 commits into
mainfrom
add-uefi-iso-extension-docs

Conversation

@igorpecovnik

@igorpecovnik igorpecovnik commented Aug 2, 2026

Copy link
Copy Markdown
Member

Adds a reference entry for the image-output-iso extension (was uefi-iso) to Developer-Guide_Extensions-List.md, placed in the image-output-* family alongside qcow2/vhdx/ovf/etc.

image-output-iso builds a bootable live .iso from a UEFI image for BMC/IPMI virtual CD-ROM boot — boot the live system, then install to disk with armbian-install. Covers supported arches (amd64/arm64; riscv64 experimental), the grub dependency, the UEFI-only / Secure-Boot-off requirements, and the parameters.

Companion to armbian/build#10314.

Create docs preview on PR

Documentation website preview will be available shortly:


 Open WWW preview 

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>
@github-actions github-actions Bot added Needs review Seeking for review size/small PR with less then 50 lines labels Aug 2, 2026
@coderabbitai

coderabbitai Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

Added a Developer Guide entry for the image-output-iso extension. The entry documents live ISO creation, supported architectures, the grub prerequisite, Secure Boot and legacy BIOS limitations, default .img handling, and configuration parameters.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly identifies the documentation update for the image-output-iso extension.
Description check ✅ Passed The description accurately explains the documented extension, its use case, requirements, architectures, and parameters.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add-uefi-iso-extension-docs

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@iav iav left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
github-actions Bot pushed a commit that referenced this pull request Aug 2, 2026
@igorpecovnik igorpecovnik changed the title Extensions-List: document the uefi-iso extension Extensions-List: document the image-output-iso extension Aug 3, 2026
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>
github-actions Bot pushed a commit that referenced this pull request Aug 3, 2026
@igorpecovnik
igorpecovnik merged commit ec62464 into main Aug 3, 2026
5 checks passed
@igorpecovnik
igorpecovnik deleted the add-uefi-iso-extension-docs branch August 3, 2026 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs review Seeking for review size/small PR with less then 50 lines

Development

Successfully merging this pull request may close these issues.

3 participants