packager2

package

v0.48.0 Latest Latest Go to latest Published: Jan 30, 2025 License: Apache-2.0 Imports: 39 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/zarf-dev/zarf

Links

Open Source Insights

Documentation ¶

Overview ¶

Package packager2 is the new implementation for packager.

Index ¶

func Create(ctx context.Context, packagePath string, opt CreateOptions) error
func GetPackageFromSourceOrCluster(ctx context.Context, cluster *cluster.Cluster, src string, ...) (v1alpha1.ZarfPackage, error)
func LoadPackage(ctx context.Context, opt LoadOptions) (*layout.PackageLayout, error)
func Mirror(ctx context.Context, opt MirrorOptions) error
func Pull(ctx context.Context, src, dir, shasum string, ...) error
func Remove(ctx context.Context, opt RemoveOptions) error
type CreateOptions
type LoadOptions
type MirrorOptions
type RemoveOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Create ¶ added in v0.47.0

func Create(ctx context.Context, packagePath string, opt CreateOptions) error

func GetPackageFromSourceOrCluster ¶ added in v0.48.0

func GetPackageFromSourceOrCluster(ctx context.Context, cluster *cluster.Cluster, src string, skipSignatureValidation bool, publicKeyPath string) (v1alpha1.ZarfPackage, error)

func LoadPackage ¶

func LoadPackage(ctx context.Context, opt LoadOptions) (*layout.PackageLayout, error)

LoadPackage optionally fetches and loads the package from the given source.

func Mirror ¶

func Mirror(ctx context.Context, opt MirrorOptions) error

Mirror mirrors the package contents to the given registry and git server.

func Pull ¶

func Pull(ctx context.Context, src, dir, shasum string, filter filters.ComponentFilterStrategy, publicKeyPath string, skipSignatureValidation bool) error

Pull fetches the Zarf package from the given sources.

func Remove ¶ added in v0.41.0

func Remove(ctx context.Context, opt RemoveOptions) error

Remove removes a package that was already deployed onto a cluster, uninstalling all installed helm charts.

Types ¶

type CreateOptions ¶ added in v0.47.0

type CreateOptions struct {
	Flavor                  string
	RegistryOverrides       map[string]string
	SigningKeyPath          string
	SigningKeyPassword      string
	SetVariables            map[string]string
	MaxPackageSizeMB        int
	SBOMOut                 string
	SkipSBOM                bool
	Output                  string
	DifferentialPackagePath string
}

type LoadOptions ¶

type LoadOptions struct {
	Source                  string
	Shasum                  string
	PublicKeyPath           string
	SkipSignatureValidation bool
	Filter                  filters.ComponentFilterStrategy
}

LoadOptions are the options for LoadPackage.

type MirrorOptions ¶

type MirrorOptions struct {
	Cluster         *cluster.Cluster
	PkgLayout       *layout.PackageLayout
	Filter          filters.ComponentFilterStrategy
	RegistryInfo    types.RegistryInfo
	GitInfo         types.GitServerInfo
	NoImageChecksum bool
	Retries         int
}

MirrorOptions are the options for Mirror.

type RemoveOptions ¶ added in v0.41.0

type RemoveOptions struct {
	Source                  string
	Cluster                 *cluster.Cluster
	Filter                  filters.ComponentFilterStrategy
	SkipSignatureValidation bool
	PublicKeyPath           string
}

RemoveOptions are the options for Remove.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
actions Package actions contains functions for running component actions within Zarf packages.	Package actions contains functions for running component actions within Zarf packages.
filters Package filters contains core implementations of the ComponentFilterStrategy interface.	Package filters contains core implementations of the ComponentFilterStrategy interface.
layout Package layout contains functions for inteacting the Zarf packages.	Package layout contains functions for inteacting the Zarf packages.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL