api

package
v0.84.0-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 20, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package api supplies helpers for working generically with the different API versions

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BuildData 

type BuildData struct {
	Hostname            string
	User                string
	Architecture        string
	Timestamp           string
	Version             string
	RegistryOverrides   map[string]string
	Flavor              string
	Signed              *bool
	VersionRequirements []VersionRequirement
	ProvenanceFiles     []string
	AggregateChecksum   string
}

BuildData contains version-neutral build metadata recorded during package assembly.

type PackageAccessor 

type PackageAccessor interface {
	AsV1alpha1() v1alpha1.ZarfPackage
	AsV1beta1() v1beta1.Package
}

PackageAccessor is the read contract for a package source, exposing a per-version definition.

type PackageDefinition 

type PackageDefinition struct {
	// contains filtered or unexported fields
}

PackageDefinition is a concrete package source backed by the generic package representation.

func NewPackageDefinitionFromV1alpha1 

func NewPackageDefinitionFromV1alpha1(pkg v1alpha1.ZarfPackage) PackageDefinition

NewPackageDefinitionFromV1alpha1 creates a PackageDefinition from a v1alpha1 package definition.

func NewPackageDefinitionFromV1beta1 

func NewPackageDefinitionFromV1beta1(pkg v1beta1.Package) PackageDefinition

NewPackageDefinitionFromV1beta1 creates a PackageDefinition from a v1beta1 package definition.

func (*PackageDefinition) AddProvenanceFile 

func (p *PackageDefinition) AddProvenanceFile(file string)

AddProvenanceFile records a package build provenance file once.

func (*PackageDefinition) AddVersionRequirement 

func (p *PackageDefinition) AddVersionRequirement(requirement VersionRequirement)

AddVersionRequirement records a package build version requirement once.

func (PackageDefinition) AsV1alpha1 

func (p PackageDefinition) AsV1alpha1() v1alpha1.ZarfPackage

AsV1alpha1 returns the package definition as a v1alpha1 ZarfPackage.

func (PackageDefinition) AsV1beta1 

func (p PackageDefinition) AsV1beta1() v1beta1.Package

AsV1beta1 returns the package definition as a v1beta1 Package.

func (PackageDefinition) OriginalAPIVersion 

func (p PackageDefinition) OriginalAPIVersion() string

OriginalAPIVersion returns the apiVersion the package was authored in before any conversion.

func (*PackageDefinition) OverrideNamespace 

func (p *PackageDefinition) OverrideNamespace(namespace string) error

OverrideNamespace overrides component namespaces when the definition permits it.

func (*PackageDefinition) RemoveImages 

func (p *PackageDefinition) RemoveImages()

RemoveImages removes images and image archives from every component.

func (*PackageDefinition) RemoveRepositories 

func (p *PackageDefinition) RemoveRepositories()

RemoveRepositories removes git repositories from every component.

func (*PackageDefinition) RetainComponents 

func (p *PackageDefinition) RetainComponents(indices []int) error

RetainComponents retains the components at the given indices, in order.

func (*PackageDefinition) SetAnnotations 

func (p *PackageDefinition) SetAnnotations(annotations map[string]string)

SetAnnotations sets the package metadata annotations.

func (*PackageDefinition) SetBuildData 

func (p *PackageDefinition) SetBuildData(buildData BuildData)

SetBuildData records the version-neutral build metadata generated during package assembly.

func (*PackageDefinition) SetBuildSigned 

func (p *PackageDefinition) SetBuildSigned(signed bool)

SetBuildSigned sets whether the package build is signed.

func (*PackageDefinition) SetChartNamespace 

func (p *PackageDefinition) SetChartNamespace(componentName, chartName, namespace string)

SetChartNamespace sets the namespace for charts matching the given component and chart name.

func (*PackageDefinition) SetDifferentialBuild 

func (p *PackageDefinition) SetDifferentialBuild(packageVersion string)

SetDifferentialBuild records the base package version for a differential build.

func (*PackageDefinition) SetMetadataArchitecture 

func (p *PackageDefinition) SetMetadataArchitecture(architecture string)

SetMetadataArchitecture sets the package metadata architecture.

func (*PackageDefinition) SetMetadataVersion 

func (p *PackageDefinition) SetMetadataVersion(version string)

SetMetadataVersion sets the package metadata version.

func (*PackageDefinition) SetName 

func (p *PackageDefinition) SetName(name string)

SetName sets the package metadata name.

type VersionRequirement 

type VersionRequirement struct {
	Version string
	Reason  string
}

VersionRequirement specifies a minimum Zarf version needed and the reason for the requirement.

Source Files

View all Source files

Directories

Path Synopsis
Package convert provides functions for converting between Zarf package API versions.
 Package convert provides functions for converting between Zarf package API versions.
Package v1alpha1 holds the definition of the v1alpha1 Zarf Package
 Package v1alpha1 holds the definition of the v1alpha1 Zarf Package
Package v1beta1 holds the definition of the v1beta1 Zarf Package.
 Package v1beta1 holds the definition of the v1beta1 Zarf Package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.