feat(schema): update v1beta1 types by AustinAbro321 · Pull Request #4704 · zarf-dev/zarf

AustinAbro321 · 2026-03-11T19:28:31Z

Description

This brings the v1beta1 schema in line with what is proposed in zarf-dev/proposals#52

Relates to #3433

Checklist before merging

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

Signed-off-by: Austin Abro <austinabro321@gmail.com>

netlify · 2026-03-11T19:28:39Z

✅ Deploy Preview for zarf-docs canceled.

Name	Link
🔨 Latest commit	`ce2f4a4`
🔍 Latest deploy log	https://app.netlify.com/projects/zarf-docs/deploys/6a21b2db2bac620008a00d76

codecov · 2026-03-11T19:32:13Z

Codecov Report

❌ Patch coverage is 44.68085% with 26 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/api/v1beta1/component.go	42.85%	12 Missing ⚠️
src/api/v1beta1/package.go	54.54%	10 Missing ⚠️
src/api/v1alpha1/package.go	0.00%	4 Missing ⚠️

Files with missing lines	Coverage Δ
src/api/v1alpha1/package.go	`85.00% <0.00%> (-9.45%)`	⬇️
src/api/v1beta1/package.go	`54.54% <54.54%> (ø)`
src/api/v1beta1/component.go	`42.85% <42.85%> (ø)`

... and 9 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.

Signed-off-by: Austin Abro <austinabro321@gmail.com>

soltysh

Some high-level comments, but I'll do another pass regarding the API as a whole.

soltysh · 2026-06-02T12:18:10Z

+		fmt.Println(err.Error())
+		os.Exit(1)
+	}
+}


Any particular reason for generating two files for v1beta1? I think from a user perspective, it's easier to import a single file containing all the elements of the schema, rather than multiple.

There are two files for the two different kinds. One is for the component config kind, while the other is for the package kind. To your point, perhaps we should call one of the package schema and one the component schema

soltysh · 2026-06-02T12:24:20Z

+}
+
+// GetDeprecatedDataInjections returns the v1alpha1 data injections carried as a backwards-compatibility shim.
+func (c Component) GetDeprecatedDataInjections() []v1alpha1.ZarfDataInjection {


I know what you're trying to achieve, but I don't think this is the right way to do it. Currently, you're hiding the field as private, but you're providing public method for setting/getting it. This might mean, external consumers will be able to change it, and that's not what we want. This field should only be settable by our conversion logic, right?

This comment applies to all private fields here and in other files below.

Removed the setter, I believe we'll be able to use a different strategy in #4823 that we discussed

#4823 is in draft, but I'm happy with the strategy there. It exposes a function SetDeprecatedFromGeneric(g types.Package, pkg Package) Package but it's only callable from Zarf since types.Package is internal

soltysh · 2026-06-02T12:25:46Z

+}
+
+// GetImages returns all image names specified in the component, including those from ImageArchives.
+func (c Component) GetImages() []string {


I wonder about these struct methods vs just regular helpers, I don't have any strong preferences, but I like having clean API types only 😅

I like the ergonomics of pulling data directly from the type, but I see where you're coming from

soltysh · 2026-06-02T13:53:11Z

+	// ServerSideApplyDisabled always uses client-side apply.
+	ServerSideApplyDisabled ServerSideApplyMode = "false"
+	// ServerSideApplyAuto uses server-side apply for fresh installs and matches the prior strategy on upgrade.
+	ServerSideApplyAuto ServerSideApplyMode = "auto"


Suggestion, the above values, especially true and false might cause problems during yaml conversions. Should we consider turning all constants into upper cases values? Here, I'd specifically use Enabled, Disabled and Auto (alternatively Always, Never and Auto).

Similarly, above we'd use Registry, SeedRegistry, Injector, etc.

Since they will be in quotes it should be fine, we haven't run into any issues yet, and this is an existing field in the v1alpha1 schema. I want to keep it as "true", "false", "auto" since this is essentially a pass through of the options on the "helm install --server-side` flag.

soltysh · 2026-06-02T13:59:35Z

+	// Default timeout in seconds for commands (default 0, no timeout).
+	MaxTotalSeconds int32 `json:"maxTotalSeconds,omitempty"`
+	// Retry commands a given number of times if they fail (default 0).
+	Retries int32 `json:"retries,omitempty"`


I think, for both of these fields, I'm inclined to drop the omitempty, such that those will always show up in the yaml after zarf will process these. This will ensure users have those values explicit, especially when we default them to 0.

I would disagree there, since removing omitempty will make it so the fields are required by our jsonschema when .actions.defaults is defined

soltysh · 2026-06-02T14:03:10Z

+	// The timestamp when this package was created.
+	Timestamp string `json:"timestamp"`
+	// The version of Zarf used to build this package.
+	Version string `json:"version"`


Since BuildData field is omitempty inside Package, so there are some edge-cases when these values might show up as "", when at least one of the other fields is set.

I believe this is okay. Zarf populates these fields, and we treat omitEmpty as a way to say these fields are "required" and Zarf will always populate them out when creating a package.

Signed-off-by: Austin Abro <austinabro321@gmail.com>

AustinAbro321 added 5 commits March 4, 2026 12:59

update for v1beta1

bc2a001

Signed-off-by: Austin Abro <austinabro321@gmail.com>

update for v1beta1

529e381

Signed-off-by: Austin Abro <austinabro321@gmail.com>

include data injections

f244966

Signed-off-by: Austin Abro <austinabro321@gmail.com>

add in missing fields

429411c

Signed-off-by: Austin Abro <austinabro321@gmail.com>

Merge branch 'main' into update-v1beta1-schema

58fdf69

github-project-automation Bot added this to Zarf Mar 11, 2026

AustinAbro321 and others added 18 commits March 11, 2026 15:41

generate schema and move out of internal

73a519e

Signed-off-by: Austin Abro <austinabro321@gmail.com>

generate v1beta1

3b390c3

Signed-off-by: Austin Abro <austinabro321@gmail.com>

Merge branch 'main' into update-v1beta1-schema

05aed51

add server side apply

3a424b0

Signed-off-by: Austin Abro <austinabro321@gmail.com>

Merge branch 'main' into update-v1beta1-schema

8656244

make allow namespace overrides a boolptr field

3318a5d

Signed-off-by: Austin Abro <austinabro321@gmail.com>

update v1beta1 with default

c2098ef

Signed-off-by: Austin Abro <austinabro321@gmail.com>

add get images

0bbd048

Signed-off-by: Austin Abro <austinabro321@gmail.com>

build api version

288c31a

Signed-off-by: Austin Abro <austinabro321@gmail.com>

Merge branch 'main' into update-v1beta1-schema

6f04230

v1beta1 changes

a2848a2

Signed-off-by: Austin Abro <austinabro321@gmail.com>

Merge branch 'main' into update-v1beta1-schema

e23b294

add deprecated fields

2894b0b

Signed-off-by: Austin Abro <austinabro321@gmail.com>

add in missing fields

b2eb1d2

Signed-off-by: Austin Abro <austinabro321@gmail.com>

docs and schema

081a9f2

Signed-off-by: Austin Abro <austinabro321@gmail.com>

component spec

6cd42e3

Signed-off-by: Austin Abro <austinabro321@gmail.com>

original API version

9bcc98a

Signed-off-by: Austin Abro <austinabro321@gmail.com>

yolo and group

7498a0d

Signed-off-by: Austin Abro <austinabro321@gmail.com>

AustinAbro321 marked this pull request as ready for review June 1, 2026 13:28

AustinAbro321 requested review from a team as code owners June 1, 2026 13:28

AustinAbro321 changed the title ~~feat(schema): update v1beta1 schema~~ feat(schema): update v1beta1 types Jun 1, 2026

soltysh reviewed Jun 2, 2026

View reviewed changes

AustinAbro321 and others added 7 commits June 2, 2026 12:07

stop importing v1alpha1

d50c81e

Signed-off-by: Austin Abro <austinabro321@gmail.com>

package schema

43f70c2

Signed-off-by: Austin Abro <austinabro321@gmail.com>

snake case

5c0be33

Signed-off-by: Austin Abro <austinabro321@gmail.com>

value was unused

d5ba3bc

Signed-off-by: Austin Abro <austinabro321@gmail.com>

omit empty

c24f772

Signed-off-by: Austin Abro <austinabro321@gmail.com>

Merge branch 'main' into update-v1beta1-schema

52b0406

inline

ce2f4a4

Signed-off-by: Austin Abro <austinabro321@gmail.com>

Conversation

AustinAbro321 commented Mar 11, 2026

Description

Checklist before merging

Uh oh!

netlify Bot commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for zarf-docs canceled.

Uh oh!

codecov Bot commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

soltysh 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!

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!

Uh oh!

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

netlify Bot commented Mar 11, 2026 •

edited

Loading

codecov Bot commented Mar 11, 2026 •

edited

Loading