Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor package loading process w provider pattern (the real MZAL) #1977

Merged

Conversation

Noxsios
Copy link
Contributor

@Noxsios Noxsios commented Aug 18, 2023

Description

Big refactor in how packages are retrieved and loaded under the hood. This shift to an interface pattern allows for the same behavior to be exhibited by packages from a variety of sources. Feature parity is assured, and packages can be deployed, inspected, published, and removed via a reference to any source type.

The core + internally supported source types:

  • OCI
  • HTTP/HTTPS
  • SGET (deprecated)
  • Tarball (.tar.zst, .tar)
  • Split Tarball

However, with the addition of WithSource(source sources.PackageSource) any library user of packager.New can create and set their own source. With this, any possible source can be supported: SSH sources, distributed packages, S3 buckets...

Additionally, there is current behavior that allows for the removeal of packages deployed, i.e. zarf package remove dos-games. This ability to specify a package via its name is now available on inspect: zarf package inspect dos-games. Inspecting / extracting SBOMs is currently a no-op as SBOMs are not persisted to the cluster.

Related Issue

Fixes #1832
Fixes #1943
Fixes #1757
Fixes #2029

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

@Noxsios Noxsios linked an issue Aug 18, 2023 that may be closed by this pull request
@netlify
Copy link

netlify bot commented Aug 18, 2023

Deploy Preview for zarf-docs canceled.

Name Link
🔨 Latest commit b1f49ad
🔍 Latest deploy log https://app.netlify.com/sites/zarf-docs/deploys/651b361a617a2a00082fa802

Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Noxsios and others added 12 commits September 28, 2023 01:05
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
Signed-off-by: razzle <[email protected]>
@Noxsios Noxsios added jackal and removed needs-adr needs-docs PR Label - Docs required to merge labels Sep 28, 2023
Copy link
Contributor

@Racer159 Racer159 left a comment

Choose a reason for hiding this comment

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

Small changes - overall very close

adr/0020-package-sources.md Outdated Show resolved Hide resolved
adr/0020-package-sources.md Outdated Show resolved Hide resolved
adr/0020-package-sources.md Outdated Show resolved Hide resolved
docs/4-deploy-a-zarf-package/2-package-sources.md Outdated Show resolved Hide resolved
docs/4-deploy-a-zarf-package/2-package-sources.md Outdated Show resolved Hide resolved
docs/4-deploy-a-zarf-package/2-package-sources.md Outdated Show resolved Hide resolved
@Noxsios Noxsios requested a review from Racer159 October 2, 2023 20:21
Copy link
Contributor

@Racer159 Racer159 left a comment

Choose a reason for hiding this comment

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

lgtm

@Racer159 Racer159 merged commit f37c68f into main Oct 2, 2023
28 checks passed
@Racer159 Racer159 deleted the 1943-refactor-package-loading-process-w-provider-pattern branch October 2, 2023 22:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants