feat(find-images): 4509 include archives in find image by chaospuppy · Pull Request #4551 · zarf-dev/zarf

chaospuppy · 2026-01-23T20:31:09Z

Description

This MR resolves #4509 by doing the following:

Allow schema validation to succeed by removing findings related to an empty image list under imageArchives keys. Currently this finding is only removed when calling PackageDefinition from FindImages
Add FindImagesInArchive to identify and return all images in imageArchives.path
Update unit tests

Related Issue

Fixes #4509

Checklist before merging

Test, docs, adr added or updated as needed
Contributor Guide Steps followed

netlify · 2026-01-23T20:31:16Z

✅ Deploy Preview for zarf-docs ready!

Name	Link
🔨 Latest commit	`41a5d70`
🔍 Latest deploy log	https://app.netlify.com/projects/zarf-docs/deploys/6997a848d59e280008424972
😎 Deploy Preview	https://deploy-preview-4551--zarf-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

chaospuppy · 2026-01-23T20:33:26Z

@AustinAbro321 when you have a moment, please take a look. I am still going to update a few unit tests.

codecov · 2026-01-27T21:04:01Z

Codecov Report

❌ Patch coverage is 45.83333% with 39 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/pkg/images/unpack.go	39.53%	17 Missing and 9 partials ⚠️
src/pkg/packager/find_images.go	63.63%	5 Missing and 3 partials ⚠️
src/pkg/packager/load/load.go	28.57%	4 Missing and 1 partial ⚠️

Files with missing lines	Coverage Δ
src/pkg/packager/load/load.go	`42.19% <28.57%> (-1.26%)`	⬇️
src/pkg/packager/find_images.go	`56.63% <63.63%> (+0.15%)`	⬆️
src/pkg/images/unpack.go	`50.30% <39.53%> (-3.80%)`	⬇️

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

AustinAbro321

Good start! Thanks for taking this on

AustinAbro321 · 2026-01-27T21:30:26Z

src/pkg/images/unpack.go

+// It returns a list of images found in the extracted OCI layout.
+func FindImagesInArchive(ctx context.Context, imageArchive, destDir string) ([]string, error) {
+	// Create a temporary directory for extraction
+	tmpdir, err := utils.MakeTempDir("")


The extraction logic in this block is mostly duplicated. Lets make a common function to de-duplicate it

Made a few changes with this in mind

AustinAbro321 · 2026-01-27T21:35:15Z

src/pkg/packager/load/load.go

 	// SkipVersionCheck skips version requirement validation
 	SkipVersionCheck bool
+	// SkipImageArchivesImages ignores schema validation errors when imageArchives does not include an images list
+	SkipEmptyImageArchivesImages bool


I'd prefer a strategy where we create a function load.PackageDefinitionNoValidate() then also make a public function load.Validate(). Keep the load.PackageDefinition function this way validation happens by default.

I believe a public validate function could be generally useful for SDK users who might be creating packages without zarf.yaml files, additionally it'll leave more room in the future for more generic solutions if we need to skip validation for a similar reason

I'm happy to make that split still, but our failure was while validating the file itself here, rather than during the validation of v1alpha1.ZarfPackage. Therefore, it wasn't useful for us to delay validation after adding a placeholder image as we previously discussed to the v1alpha1.ZarfPackage.

I could split them and then add some work to change the zarf.ymal on disk to add an empty array there, but that didn't seem like desirable behavior.

Alternatively, I could also split out a Validate and ValidateWithoutSchemaValidation (not literally that name, but something like that) and use the later

AustinAbro321 · 2026-01-27T21:42:08Z

src/pkg/packager/find_images.go

+				return nil, fmt.Errorf("failed to unpack image archive %s: %w", archive.Path, err)
+			}
+			for _, image := range archiveImages {
+				matchedImages[image] = true


I think matched images isn't the right construct. Maybe a new field should be added such as archiveImages. One of the goals of find-images is to be able to copy and paste the output into your zarf.yaml. Currently you'd see this output, which would result in trying to pull the image from the internet if you copied and pasted it

2026-01-27 16:38:42 INF looking up cosign artifacts for discovered images count=3 components: - name: kiwix-serve images: - docker.io/library/kiwix-data:local - ghcr.io/kiwix/kiwix-serve:3.5.0-2 - kiwix-data:local

I see, good point, I missed the desire to pull images from the image archive on disk after zarf.yaml has been updated with the output of zarf dev find-images. I'll fix that up!

@AustinAbro321 to clarify, are you hoping to see images elements expressed in a such as way as to direct Zarf to pull them from the archive, rather than from the internet?

Ah I missed your comment before asking, I think I see the answer in #4577

Just went back and clarified #4577 a bit, but just to write here as well, we should no longer include images because they're in an image archive. If they're in both a manifest we should check if the image archive contains that image, then in the output to the user structure it so it's in the image archive, and the user can simply copy and paste.

AustinAbro321 · 2026-01-27T21:42:54Z

src/pkg/packager/find_images.go

Image archives functionality should also work with packager.UpdateImages

AustinAbro321 · 2026-02-02T15:20:47Z

Hello @chaospuppy, I reazlied that the behavior I proposed in #4509, didn't really fit the zarf dev find-images command. However, there is still work to be done to get image archives to behave properly for zarf dev find-images. I've created #4577 to track this work. If you're interested, I believe this PR could be adjusted for that issue. LMK if you have any questions.

If you do adjust this PR for #4577, don't worry about validation, assume the given zarf.yaml file is valid

chaospuppy · 2026-02-06T19:11:51Z

@AustinAbro321 Are you thinking about handling validation differently in the near future? Trying to get an understanding for which changes I should back out. I am also happy to keep the validation changes in, including making Validation public and creating PackageDefinitionWithoutValidation.

AustinAbro321 · 2026-02-09T13:02:38Z

@chaospuppy Very possibly handling validation in the near future yes. I suggest backing out of the validation changes in this PR

…eholder images list, add skipimagearchivesimages definition option Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

…efinitionOption for skipping imagearchives images schema findings Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

…es output Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

…dev#4554) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

…-organization group (zarf-dev#4553) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

…ev#4552) Signed-off-by: Jason Washburn <jason.washburn@gmail.com> Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

Signed-off-by: Austin Abro <austinabro321@gmail.com> Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

…images --update Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

…ind-image

AustinAbro321 · 2026-02-12T16:11:07Z

src/pkg/packager/find_images.go

 	// PotentialMatches contains potential container images found by a regex
 	PotentialMatches []string
+	// ArchiveImages contains images that are included in Matches, but are provided with an imageArchive
+	ArchiveImages []string


Not yet doing a full review, as this is in draft, but thinking about the architecture here. I believe we shouldn't change anything in the packager.FindImages function in this PR. This function should be focused on finding images from manifests and charts. The logic for determining which of those images are in an image archive so we can customize the print out should be outside of this function.

Okay that makes sense, I'll move imageArchives logic into a separate function that can be used for post-processing the images located in FindImages for find-images.

…ind-image

…ndinarchives

github-project-automation bot added this to Zarf Jan 23, 2026

chaospuppy force-pushed the 4509-include-archives-in-find-image branch from aad61df to 6d872f4 Compare January 24, 2026 00:49

chaospuppy marked this pull request as ready for review January 24, 2026 00:50

chaospuppy requested review from a team as code owners January 24, 2026 00:50

chaospuppy force-pushed the 4509-include-archives-in-find-image branch 2 times, most recently from b03b517 to f35514c Compare January 27, 2026 20:43

chaospuppy changed the title ~~4509 include archives in find image~~ feat(find-images): 4509 include archives in find image Jan 27, 2026

AustinAbro321 requested changes Jan 27, 2026

View reviewed changes

github-project-automation bot moved this to In progress in Zarf Jan 27, 2026

chaospuppy force-pushed the 4509-include-archives-in-find-image branch from 08c339e to 9534ea6 Compare January 31, 2026 01:53

chaospuppy and others added 13 commits February 9, 2026 14:22

update help text, create PackageDefinitionWithoutValidation, add plac…

2720683

…eholder images list, add skipimagearchivesimages definition option Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

remove PackageDefinitionWithoutValidation, unexport validate(), add D…

703577b

…efinitionOption for skipping imagearchives images schema findings Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

add findimagesinarchive, unit tests, and add found images to FindImag…

2573306

…es output Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

update find_images unit tests, add test for image archive

6f07f16

Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

fix linting issues

b1fdd01

Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

update docs

f8b3257

Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

update unit test

779c821

Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

docs: fix grammatical error in OnlyHasImageLayers doc comment (zarf-d…

495dc86

…ev#4552) Signed-off-by: Jason Washburn <jason.washburn@gmail.com> Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

chore: update dos games package 1.3.0 (zarf-dev#4555)

5b9cba5

Signed-off-by: Austin Abro <austinabro321@gmail.com> Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

docs: clarify data injections deprecation timeline (zarf-dev#4556)

e06baea

Signed-off-by: Austin Abro <austinabro321@gmail.com> Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

chore: update dos-games references to 1.3 (zarf-dev#4557)

30ceccb

Signed-off-by: Austin Abro <austinabro321@gmail.com> Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

chaospuppy added 2 commits February 9, 2026 14:22

reduce redundancy, add unit tests for split out functions

94dbd29

Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

finish updates to find-images, update unit tests, begin work on find-…

7bceaee

…images --update Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>

chaospuppy force-pushed the 4509-include-archives-in-find-image branch from cc9dbd7 to 7bceaee Compare February 9, 2026 22:22

Merge remote-tracking branch 'origin' into 4509-include-archives-in-f…

52abee0

…ind-image

chaospuppy marked this pull request as draft February 10, 2026 19:39

AustinAbro321 reviewed Feb 12, 2026

View reviewed changes

chaospuppy added 2 commits February 19, 2026 11:10

Merge remote-tracking branch 'origin' into 4509-include-archives-in-f…

a80f8bf

…ind-image

remove imagearchives logic from findimages, move into filterimagesfou…

41a5d70

…ndinarchives

Conversation

chaospuppy commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

Checklist before merging

Uh oh!

netlify bot commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for zarf-docs ready!

Uh oh!

chaospuppy commented Jan 23, 2026

Uh oh!

codecov bot commented Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

AustinAbro321 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chaospuppy Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AustinAbro321 commented Feb 2, 2026

Uh oh!

chaospuppy commented Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AustinAbro321 commented Feb 9, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

chaospuppy commented Jan 23, 2026 •

edited

Loading

netlify bot commented Jan 23, 2026 •

edited

Loading

codecov bot commented Jan 27, 2026 •

edited

Loading

chaospuppy Jan 27, 2026 •

edited

Loading

chaospuppy commented Feb 6, 2026 •

edited

Loading