Skip to content

Initial draft of the image extension ADR#574

Open
magerstam wants to merge 6 commits into
mainfrom
adr-extend-image
Open

Initial draft of the image extension ADR#574
magerstam wants to merge 6 commits into
mainfrom
adr-extend-image

Conversation

@magerstam
Copy link
Copy Markdown
Contributor

Merge Checklist

All boxes should be checked before merging the PR

  • The changes in the PR have been built and tested
  • Documentation has been updated to reflect the changes (or no doc update needed)
  • Ready to merge

Description

This PR adds an ADR defining the support boundary for extending existing image artifacts in ICT.

The ADR clarifies that RAW/VHD-style disk images can be supported as additive composition baselines, while arbitrary ISO installer mutation is intentionally out of scope. Disk image extension is framed around mounting and inspecting the baseline, adding repositories and packages, resolving dependencies, detecting conflicts, resizing where supported, regenerating boot artifacts, and validating the resulting image.

The ADR also distinguishes this from ICT’s existing ISO live installer flow. ICT-owned ISO installer behavior can continue to evolve through known internal contracts, but external ISO remastering should only be added through explicit, versioned adapters.

  • Defines disk image extension as additive-only.
  • Excludes package removal, filesystem conversion, partition table conversion, and arbitrary repartitioning.
  • Clarifies that ISO installers are not generic mutable baselines.
  • Preserves ICT-owned attended/unattended ISO installer support.
  • Leaves room for future external ISO remastering through explicit adapters.
  • Adds risks, mitigations, testing expectations, and schema direction for baseline/extension policy handling.

Any Newly Introduced Dependencies

How Has This Been Tested?

Copilot AI review requested due to automatic review settings May 21, 2026 22:54
@magerstam magerstam requested a review from a team as a code owner May 21, 2026 22:54
@magerstam magerstam added the documentation Improvements or additions to documentation label May 21, 2026
@magerstam magerstam requested a review from a team as a code owner May 21, 2026 22:54
@magerstam magerstam marked this pull request as draft May 21, 2026 22:55
@magerstam magerstam marked this pull request as ready for review May 21, 2026 22:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new Architecture Decision Record (ADR) to define ICT’s support boundaries for extending existing image artifacts—explicitly supporting additive extension of disk images (RAW/VHD-style) while treating generic mutation of arbitrary ISO installer media as out of scope unless implemented via explicit, versioned adapters.

Changes:

  • Introduces an ADR describing supported vs. unsupported baseline extension behaviors (disk images vs. ISO installers).
  • Proposes template/schema directions (baseline, extensionPolicy, validation) for expressing composition mode and extension policy.
  • Documents scope, phased approach, risks/mitigations, and testing expectations for baseline extension.

Comment thread docs/architecture/adr-image-extension.md Outdated
Comment thread docs/architecture/adr-image-extension.md Outdated
Comment on lines +35 to +37
## Context

Image Composer Tool supports image creation across multiple Linux distributions
Comment thread docs/architecture/adr-image-extension.md
Comment thread docs/architecture/adr-image-extension.md Outdated
Comment thread docs/architecture/adr-image-extension.md Outdated
Comment thread docs/architecture/adr-image-extension.md Outdated
Comment thread docs/architecture/adr-image-extension.md Outdated
Comment thread docs/architecture/adr-image-extension.md Outdated
Comment thread docs/architecture/adr-image-extension.md Outdated
Comment thread docs/architecture/adr-image-extension.md Outdated
Comment thread docs/architecture/adr-image-extension.md Outdated
Comment thread docs/architecture/adr-image-extension.md Outdated
Comment thread docs/architecture/adr-image-extension.md
Comment thread docs/architecture/adr-image-extension.md Outdated
Comment thread docs/architecture/adr-image-extension.md Outdated
@arodage
Copy link
Copy Markdown
Contributor

arodage commented May 27, 2026

any changes in CLI?

@magerstam
Copy link
Copy Markdown
Contributor Author

any changes in CLI?

We could consider new options, but not sure if it is immediately required. A few things that comes to mind are:

  • Validation inspection (on / off) (medium prio)
  • CVE inspection useful overall, not just for this against the SBOM (medium prio)
  • Overriding the baseline image provided in the template (low prio)

Comment thread docs/architecture/adr-image-extension.md Outdated
Comment thread docs/architecture/adr-image-extension.md
Comment thread docs/architecture/adr-image-extension.md
Copy link
Copy Markdown
Contributor

@arodage arodage left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
Contributor

@kblaszczak-intel kblaszczak-intel left a comment

Choose a reason for hiding this comment

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

ADR files do not require docs review but if an approval is needed, here it is ;)

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants