Documentation
¶
Overview ¶
Package packager contains functions for interacting with, managing and deploying Zarf packages.
Package packager contains functions for interacting with, managing and deploying Zarf packages.
Package packager contains functions for interacting with, managing and deploying Zarf packages.
Package packager contains functions for interacting with, managing and deploying Zarf packages.
Package packager contains functions for interacting with, managing and deploying Zarf packages.
Package packager contains functions for interacting with, managing and deploying Zarf packages.
Package packager contains functions for interacting with, managing and deploying Zarf packages.
Package packager contains functions for interacting with, managing and deploying Zarf packages.
Package packager contains functions for interacting with, managing and deploying Zarf packages.
Package packager contains functions for interacting with, managing and deploying Zarf packages.
Package packager contains functions for interacting with, managing and deploying Zarf packages.
Package packager contains functions for interacting with, managing and deploying Zarf packages.
Index ¶
- Variables
- func Pull(ctx context.Context, source, destination string, opts PullOptions) error
- type Modifier
- type Packager
- func (p *Packager) ClearTempPaths()
- func (p *Packager) Create(ctx context.Context) error
- func (p *Packager) Deploy(ctx context.Context) error
- func (p *Packager) DevDeploy(ctx context.Context) error
- func (p *Packager) FindImages(ctx context.Context) (map[string][]string, error)
- func (p *Packager) Generate(ctx context.Context) error
- func (p *Packager) GetVariableConfig() *variables.VariableConfig
- func (p *Packager) Inspect(ctx context.Context) error
- func (p *Packager) Mirror(ctx context.Context) error
- func (p *Packager) Publish(ctx context.Context) (err error)
- func (p *Packager) Remove(ctx context.Context) error
- type PullOptions
Constants ¶
This section is empty.
Variables ¶
var (
ReferenceRegexp = re(referencePat)
)
Functions ¶
Types ¶
type Modifier ¶
type Modifier func(*Packager)
Modifier is a function that modifies the packager.
func WithCluster ¶
WithCluster sets the cluster client for the packager.
func WithContext ¶ added in v0.42.1
WithContext sets the packager's context
func WithSource ¶
func WithSource(source sources.PackageSource) Modifier
WithSource sets the source for the packager.
type Packager ¶
type Packager struct {
// contains filtered or unexported fields
}
Packager is the main struct for managing packages.
func New ¶
func New(cfg *types.PackagerConfig, mods ...Modifier) (*Packager, error)
New creates a new package instance with the provided config.
Note: This function creates a tmp directory that should be cleaned up with p.ClearTempPaths().
func (*Packager) ClearTempPaths ¶
func (p *Packager) ClearTempPaths()
ClearTempPaths removes the temp directory and any files within it.
func (*Packager) Create ¶
Create generates a Zarf package tarball for a given PackageConfig and optional base directory.
func (*Packager) FindImages ¶
FindImages iterates over a Zarf.yaml and attempts to parse any images.
func (*Packager) GetVariableConfig ¶
func (p *Packager) GetVariableConfig() *variables.VariableConfig
GetVariableConfig returns the variable configuration for the packager.
func (*Packager) Mirror ¶
Mirror pulls resources from a package (images, git repositories, etc) and pushes them to remotes in the airgap without deploying them
type PullOptions ¶ added in v0.55.0
type PullOptions struct {
// SHASum uniquely identifies a package based on its contents.
SHASum string
// SkipSignatureValidation flags whether Pull should skip validating the signature.
SkipSignatureValidation bool
// Architecture is the package architecture.
Architecture string
// Filters describes a Filter strategy to include or exclude certain components from the package.
Filters filters.ComponentFilterStrategy
// PublicKeyPath validates the create-time signage of a package.
PublicKeyPath string
}
PullOptions declares optional configuration for a Pull operation.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package actions contains functions for running component actions within Zarf packages.
|
Package actions contains functions for running component actions within Zarf packages. |
|
Package composer contains functions for composing components within Zarf packages.
|
Package composer contains functions for composing components within Zarf packages. |
|
Package creator contains functions for creating Zarf packages.
|
Package creator contains functions for creating Zarf packages. |
|
Package deprecated handles package deprecations and migrations
|
Package deprecated handles package deprecations and migrations |
|
Package filters contains core implementations of the ComponentFilterStrategy interface.
|
Package filters contains core implementations of the ComponentFilterStrategy interface. |
|
Package sources contains core implementations of the PackageSource interface.
|
Package sources contains core implementations of the PackageSource interface. |