packager2

Documentation

Overview

Package packager2 contains functions for inspecting packages.

Package packager2 is the new implementation for packager.

Index

• func Inspect(ctx context.Context, opt ZarfInspectOptions) (v1alpha1.ZarfPackage, error)
• func InspectList(ctx context.Context, opt ZarfInspectOptions) ([]string, 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 LoadOptions
• type MirrorOptions
• type RemoveOptions
• type ZarfInspectOptions

Functions

func Inspect

func Inspect(ctx context.Context, opt ZarfInspectOptions) (v1alpha1.ZarfPackage, error)

Inspect list the contents of a package.

func InspectList

func InspectList(ctx context.Context, opt ZarfInspectOptions) ([]string, error)

InspectList lists the images in a component action

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) error

Pull fetches the Zarf package from the given sources.

func Remove

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

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

RemoveOptions are the options for Remove.

type ZarfInspectOptions

type ZarfInspectOptions struct {
	Source                  string
	Cluster                 *cluster.Cluster
	ViewSBOM                bool
	SBOMOutputDir           string
	ListImages              bool
	SkipSignatureValidation bool
	PublicKeyPath           string
}

ZarfInspectOptions tracks the user-defined preferences during a package inspection.