Documentation
¶
Overview ¶
Package load takes a ZarfPackageConfig, composes imports, and validates the con
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DefinedPackage ¶ added in v0.78.0
type DefinedPackage struct {
Pkg v1alpha1.ZarfPackage
ImportedSchemas []string
}
DefinedPackage is the result of loading and resolving a package definition. ImportedSchemas is transient assembly state — child schema paths collected during import resolution that must be passed to AssemblePackage for merging.
func PackageDefinition ¶
func PackageDefinition(ctx context.Context, packagePath string, opts DefinitionOptions) (DefinedPackage, error)
PackageDefinition returns a validated package definition after flavors, imports, variables, and values are applied.
type DefinitionOptions ¶
type DefinitionOptions struct {
Flavor string
SetVariables map[string]string
// SkipRequiredValues ignores values schema validation errors when a "required" field is empty. Used when a package
// value should be supplied at deploy-time and doesn't have a default set in the package values.
SkipRequiredValues bool
// CachePath is used to cache layers from skeleton package pulls
CachePath string
// IsInteractive decides if Zarf can interactively prompt users through the CLI
IsInteractive bool
// SkipVersionCheck skips version requirement validation
SkipVersionCheck bool
types.RemoteOptions
}
DefinitionOptions are the optional parameters to load.PackageDefinition
Click to show internal directories.
Click to hide internal directories.