acl/docs: add guide for customizing ACL and A/B update behavior - #65
Draft
Paco Huelsz (frhuelsz) wants to merge 1 commit into
Draft
Conversation
Adds acl/docs/customizing.md, describing how ACL is structured, what an A/B update replaces, and the four customization options available today (image as shipped, system extensions, the writable filesystem, and rebuilding the image), together with what an update does to each. Targets the ABUpdate branch because the guide describes the A/B layout introduced there: the per-slot verity hash partitions, the 256 MiB ESP, Trident as the on-node update agent, and slot selection via a signed UKI addon rather than a slot-specific kernel command line. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Paco <frhuelsz@microsoft.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
1 participant
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.
Adds
acl/docs/customizing.md, a guide to the customization options available on ACL nodes and what an A/B update does to each.There is currently no documentation on using or extending ACL —
acl/docs/covers the build system and internals. This fills that gap.Contents
/usr, no package manager,/etcas an overlay./var, the writable layer of/etc,/oem).Why this targets the ABUpdate branch
The guide describes the A/B layout introduced in #28 rather than what is on
aclmaintoday:aclmainBasing this on
aclmainwould mean publishing a description of a layout that does not exist yet, so it targetsuser/bfjelds/ab-verity-partuuid-uki-addons-20260708and should merge with or after #28.Notes
acl/docs/README.mdindex, under Operational Guides.architecture.md(partition layout, dm-verity,/etcoverlay) andsysexts.md(extension mechanics) is intentional: this guide covers them from an update-behavior angle for a reader deciding how to customize. Happy to trim toward cross-references if reviewers prefer.