Skip to content

Removed validation policy from template#700

Open
magerstam wants to merge 4 commits into
mainfrom
overlay-adr-update
Open

Removed validation policy from template#700
magerstam wants to merge 4 commits into
mainfrom
overlay-adr-update

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 updates the ADR for image extension workflows to simplify post-composition validation and better separate composition intent from operational verification behavior. The previous ADR draft introduced several validation-related CLI parameters, which increased complexity and blurred ownership between template-defined configuration and runtime validation execution. This update keeps template/schema responsibilities focused on image composition, while moving comparison behavior into a single, explicit post-composition CLI option.

  • Reworked the validation section in to remove template-level validation policy.
  • Replaced the multi-flag proposal with one high-level flag: --compare-report <sbom | full>
  • Clarified implicit comparison inputs:
    • Baseline image is inferred from baseline.source.path in the template (overlay mode).
    • Output image is inferred from the primary produced artifact in the build working/output path.
  • Updated examples and narrative to reflect:
    • SBOM-only comparison mode
    • Full semantic comparison mode
  • Clarified that automated CVE checks and automated boot testing are out of scope for the composition command and remain manual or separate workflow steps.

Any Newly Introduced Dependencies

How Has This Been Tested?

Copilot AI review requested due to automatic review settings June 18, 2026 15:46
@magerstam magerstam requested review from a team as code owners June 18, 2026 15:46
@magerstam magerstam added the design Architecture and API design label Jun 18, 2026

Copilot AI 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.

Pull request overview

Updates the image extension workflow ADR to remove template/schema-level validation policy and instead describe post-composition validation/comparison as explicit CLI behavior, keeping templates focused on composition intent and shifting operational verification to execution workflows.

Changes:

  • Removes the previously proposed template-embedded validation policy section from the ADR’s schema recommendation.
  • Introduces a simplified post-compose comparison interface proposal via --compare-report <sbom|full>.
  • Clarifies that automated CVE checks and automated boot testing are out of scope for the composition command.

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
magerstam and others added 4 commits June 18, 2026 08:49
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@arodage

arodage commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

LGTM. While we are at it can we rename file to adr-image-overlay.md‎?

templates focused on image intent and keeps operational checks in execution
workflows.

### 1. Fresh Image Composition

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 following may be considered to simplify template creation overall.

  1. Image Creation Modes inferred implicitly
    Create Mode: No baseline source path specified → Build image from scratch with minimal packages
    Overlay Mode: Baseline source path provided → Apply modifications to existing image
  2. Output Format Configuration
    Use the existing template's output format field (raw, ISO, VMDK, etc.) to specify the final image format for overlay operations.
  3. ISO Remastering
    ISO remastering should be treated as a standalone feature with its own dedicated section, separate from the baseline section of the overlay mode.
  4. Conflict Resolution Policy
    Add a dedicated "Conflict Resolution Policy" section to define how conflicts are handled during overlay operations.
  5. Partitioning Scheme Limitations
    Current Issue: The template doesn't clearly specify whether repartitioning is supported in overlay mode.
    Recommendation: If repartitioning is allowed with overlay images, the ICT should only support:
    Extension of existing partitioning schemes, not complete overwriting or creation of entirely new partitioning scheme.This approach maintains compatibility with the base image while allowing controlled modifications.

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

Labels

design Architecture and API design

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants