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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Inspect ¶ added in v0.41.0
func Inspect(ctx context.Context, opt ZarfInspectOptions) (v1alpha1.ZarfPackage, error)
Inspect list the contents of a package.
func InspectList ¶ added in v0.41.0
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.
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 ¶ 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.
type ZarfInspectOptions ¶ added in v0.41.0
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.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.