Skip to content

feat!: add multi arch support#4843

Closed
AustinAbro321 wants to merge 69 commits into
mainfrom
multi-arch
Closed

feat!: add multi arch support#4843
AustinAbro321 wants to merge 69 commits into
mainfrom
multi-arch

Conversation

@AustinAbro321
Copy link
Copy Markdown
Member

@AustinAbro321 AustinAbro321 commented Apr 21, 2026 •
edited
Loading

Breaking changes

Breaking changes are only in the SDK. ImagesWithManifests->PulledImage. This removes manifests from the struct. Instead of having to collect the manifest in several places (indexes, image archives, daemon) we check the manifest before we create the SBOM, this was our only use case for it The name PulledImage should be more resistant to future breaking changes. Unpack and Pull return PulledImage now.

Description

This adds multi arch support thorough a special package architecture "multi"

We may want to change zarf package pull so that if a multi platform exists for a Zarf OCI package, when running zarf package pull <package-oci-ref> we fallback to pull multi. This PR is already large so I didn't change anything atm.

This adds a minimum version check for v0.76.0. Also worth noting that if a multi arch package is pulled from an earlier version of Zarf then Zarf will panic, since it assumed the index.json in an OCI layout will only have manifests.

Related Issue

Relates to #2425 (arguably fixes though we may want to keep it open or break it out into other issues such as packaging only x and y architecture).

Checklist before merging

@AustinAbro321
WIP
0d6d349 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
add minimum version requirement
15c683f 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
get size of index
3c3df5d 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
get size of manifest
ebbbdab 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
multi architecture docs
542af63 
Signed-off-by: Austin Abro <[email protected]>
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 21, 2026 •
edited
Loading

✅ Deploy Preview for zarf-docs canceled.

Name Link
🔨 Latest commit b023297
🔍 Latest deploy log https://app.netlify.com/projects/zarf-docs/deploys/69f8fca32e19c900087db296

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 21, 2026 •
edited
Loading

Codecov Report

❌ Patch coverage is 61.58445% with 257 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/pkg/images/pull.go 66.84% 48 Missing and 15 partials ⚠️
src/pkg/packager/layout/sbom.go 46.84% 42 Missing and 17 partials ⚠️
src/pkg/images/common.go 44.15% 35 Missing and 8 partials ⚠️
src/pkg/images/unpack.go 63.01% 18 Missing and 9 partials ⚠️
src/pkg/zoci/pull.go 65.45% 14 Missing and 5 partials ⚠️
src/cmd/package.go 25.00% 12 Missing ⚠️
src/pkg/packager/deploy.go 0.00% 10 Missing ⚠️
src/pkg/images/push.go 63.15% 6 Missing and 1 partial ⚠️
src/pkg/packager/layout/assemble.go 77.41% 6 Missing and 1 partial ⚠️
src/pkg/packager/load/load.go 40.00% 1 Missing and 2 partials ⚠️
... and 4 more
Files with missing lines Coverage Δ
src/cmd/utils.go 100.00% <100.00%> (ø)
src/config/config.go 60.86% <100.00%> (+60.86%) ⬆️
src/internal/api/v1alpha1/validate.go 91.21% <100.00%> (+0.49%) ⬆️
src/pkg/packager/create.go 54.54% <100.00%> (+0.46%) ⬆️
src/pkg/packager/filters/arch.go 100.00% <100.00%> (ø)
src/pkg/packager/layout/package.go 66.34% <100.00%> (+0.92%) ⬆️
src/pkg/packager/load.go 62.89% <100.00%> (ø)
src/pkg/packager/load/import.go 50.60% <100.00%> (+1.56%) ⬆️
src/pkg/packager/mirror.go 0.00% <ø> (ø)
src/pkg/packager/packager.go 84.46% <100.00%> (+1.13%) ⬆️
... and 16 more

... and 2 files with indirect coverage changes

🚀 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
change wordpress to use multi
7799b9a 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
add unit tests
061228f 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
add unit tests
ded527f 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
update e2e test
7ea1bfc 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
WIP multi arch sbom implementation
3edffbe 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
comment
9d1a542 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
change imageWithManifests struct
02f3221 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
improving testing
4cca85e 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
wording
4bca968 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321 AustinAbro321 changed the title feat: add multi arch support feat!: add multi arch support Apr 22, 2026
@AustinAbro321
eliminate unnecessary test
210cd60 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
move sbom image logic
8303145 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
disallow multi arch
93ba395 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
make unpack work with multi arch
0c4e28d 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
move logic for determining sbomable image to sbom layer
4083f2b 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
more specific validation function
d03405e 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
add image archive validation
a90dee9 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
simplify deploy test
81b7130 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
simpler test
7711668 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
sensible ordering
f4fbde2 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
use wordpress digests
8a1ae30 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
add test helpers
e2c3303 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
Copy link
Copy Markdown
Member Author

AustinAbro321 commented Apr 27, 2026 •
edited
Loading

Good question @Femure. Index sha's will be supported for pulling and pushing index sha's when multiple architectures are selected. We definitely want to keep this case around, as it is the most secure route.

When a tag is used, then Zarf will pull only the architectures for that tag. When an index sha is used then Zarf will pull every platform to keep the index in sync

@Femure
Copy link
Copy Markdown

Femure commented May 1, 2026

Thanks for the clarification, that makes things much clearer.

Glad to hear that OCI index SHAs will be preserved when using them, that fully addresses my use case.

I’m looking forward to seeing this PR progress and hopefully get merged soon 🙂

AustinAbro321 added 23 commits May 1, 2026 12:45
@AustinAbro321
WIP, moving to multi architecture
d100ec8 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
filters
391a2f8 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
WIP
24974e1 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
pulling multiple architectures correctly
5279073 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
accept platforms
845ee4d 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
update filter index manifest rules
d9d71a5 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
always push the entire image, whether it's an index or not
4ba8796 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
multi platform unpack
2d05992 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
change init test
1518346 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
fix unpack to handle indexes
42ab428 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
fix nested arch
22bfd38 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
include variants by default
ffbf3f6 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
build architecture
211198b 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
sort architecture
507476c 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
add and replace test
57407bb 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
multiple architectures in public API
565b2f1 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
fixmes
e7addd9 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
config test
8df0336 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
fixes
f640549 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
more sensible package architectures
26e5737 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
return error properly
4c2f5e1 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
fix test
645e462 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
change architecture functions
b023297 
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
Copy link
Copy Markdown
Member Author

AustinAbro321 commented May 5, 2026

This PR has ballooned in size, and I feel it is hard to review. Going to break in into three parts:

  • introduce the test util and migrating unit tests over so they no longer call a registry on the internet
  • Introduce pulling and pushing indexes behind a feature flag
  • Introduce defining multiple architectures and pulling those architectures by tag

@AustinAbro321 AustinAbro321 mentioned this pull request May 5, 2026
Merged
2 tasks
@AustinAbro321
Copy link
Copy Markdown
Member Author

AustinAbro321 commented May 27, 2026

Image sha support was introduced in #4879. I'm going to stop working on this for the time being to focus on getting Zarf to v1.0.

Adding in proper multi arch support raises a lot of questions, and probably needs a ZEP to design it. For instance:

  • Would likely need to pass architecture through the system ?
  • Assuming a package has multiple architectures how should .only.cluster.architecture be handled ?
  • How do we deal with variants? Do we go as far as to deal with OS features as well?
    • Should each image get it's own list of platforms to pull?
  • what should the platform be of the package in OCI?

@github-project-automation github-project-automation Bot moved this from In progress to Done in Zarf May 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@a1994sc a1994sc a1994sc left review comments

@brandtkeller brandtkeller brandtkeller requested changes

Assignees

No one assigned

Labels

None yet

Projects

Zarf
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@AustinAbro321 @Femure @a1994sc @brandtkeller