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 ¶
- type Modifier
- type Packager
- func (p *Packager) ClearTempPaths()
- func (p *Packager) Create() (err error)
- func (p *Packager) Deploy() (err error)
- func (p *Packager) DevDeploy() error
- func (p *Packager) FindImages() (imgMap map[string][]string, err error)
- func (p *Packager) Generate() (err error)
- func (p *Packager) Inspect() (err error)
- func (p *Packager) Mirror() (err error)
- func (p *Packager) Publish() (err error)
- func (p *Packager) Pull() (err error)
- func (p *Packager) Remove() (err error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Modifier ¶ added in v0.30.0
type Modifier func(*Packager)
Modifier is a function that modifies the packager.
func WithCluster ¶ added in v0.30.0
WithCluster sets the cluster client for the packager.
func WithSource ¶ added in v0.30.0
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 NewOrDie ¶
func NewOrDie(config *types.PackagerConfig, mods ...Modifier) *Packager
NewOrDie creates a new package instance with the provided config or throws a fatal error.
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) Mirror ¶ added in v0.29.2
Mirror pulls resources from a package (images, git repositories, etc) and pushes them to remotes in the air gap without deploying them
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 lint contains functions for verifying zarf yaml files are valid
|
Package lint contains functions for verifying zarf yaml files are valid |
|
Package sources contains core implementations of the PackageSource interface.
|
Package sources contains core implementations of the PackageSource interface. |