ARM64 Image Composition User Guide#536
Open
srmungar wants to merge 5 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds ARM64-focused documentation to help users compose ARM64/aarch64 images with ICT (including boot mode guidance for GRUB vs UKI), and links the new guide from existing docs entry points.
Changes:
- Introduces a new ARM64 image creation tutorial with build/validate/inspect workflows.
- Links the new ARM64 guide from the Usage Guide, docs index, and README.
- Updates the architecture docs to reference an ARM64 GRUB/UKI architecture document.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tutorial/usage-guide.md | Adds the ARM64 guide to the “Related Documentation” list. |
| docs/tutorial/arm64-image-creation-guide.md | New end-to-end ARM64 image composition guide (templates, boot modes, commands, checks, troubleshooting). |
| docs/index.md | Adds ARM64 guide entries to docs landing page navigation/tables. |
| docs/architecture.md | Adds an ARM64 GRUB/UKI architecture doc entry to the toctree. |
| README.md | Adds ARM64 guide to the top-level Guides table. |
Comment on lines
36
to
40
| | [Installation Guide](./tutorial/installation.md) | Build methods, Debian packaging, prerequisites | | ||
| | [Usage Guide](./tutorial/usage-guide.md) | CLI commands, configuration, build output, shell completion | | ||
| | [ARM64 Image Creation Guide](./tutorial/arm64-image-creation-guide.md) | Build Ubuntu, eLxr, and Azure Linux ARM64 images with GRUB or UKI | | ||
| | [CLI Reference](./architecture/image-composer-tool-cli-specification.md) | Complete command-line specification | | ||
| | [Image Templates](./architecture/image-composer-tool-templates.md) | Template structure, variables, best practices | |
Contributor
Author
There was a problem hiding this comment.
@copilot apply changes based on this feedback
Contributor
There was a problem hiding this comment.
Removed the duplicate ARM64 entry from the Tutorials table, keeping it only in the Guides table where it was already listed. Commit ff5c826.
| | [Configure Users](./tutorial/configure-image-user.md) | Adding users to images | | ||
| | [Custom Build Actions](./tutorial/configure-additional-actions-for-build.md) | Pre/post-build scripts | | ||
| | [Multiple Repos](./tutorial/configure-multiple-package-repositories.md) | Using multiple package repositories | | ||
| | [ARM64 Image Creation](./tutorial/arm64-image-creation-guide.md) | End-to-end ARM64 image build workflows and checks | |
Comment on lines
+42
to
+45
| 2. Install core host dependencies (Ubuntu host recommended): | ||
| The following software packages are the prerequisite packages on the Host Platform. However, currently the ICT tool itself will automatically install these dependencies at runtime. | ||
|
|
||
| systemd-ukify mmdebstrap qemu-user-static arch-test binfmt-support grub-common sbsigntool dosfstools mtools xorriso qemu-utils |
Contributor
Author
There was a problem hiding this comment.
@copilot apply changes based on this feedback
Contributor
There was a problem hiding this comment.
This was already addressed in commit ff5c826. Step 2 now provides a concrete sudo apt install ... command and clarifies that ICT auto-installs these packages at runtime — pre-installing them is optional and speeds up subsequent builds.
| Security Objectives <./architecture/image-composition-tool-security-objectives.md> | ||
| Build Process <./architecture/image-composer-tool-build-process.md> | ||
| ./architecture/image-manifest-specification.md | ||
| ./architecture/image-composer-tool-arm64-grub-uki-architecture.md |
…rify deps, flag Ubuntu UKI, remove broken toctree Agent-Logs-Url: https://github.com/open-edge-platform/image-composer-tool/sessions/c6962c15-85bf-4d5c-99d0-e3ba433545d7 Co-authored-by: srmungar <28767344+srmungar@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains user guide to compose images using ICT targeting ARM64 platforms