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.
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 ¶
- Constants
- func GetInitPackageName(arch string) string
- func GetInitPackageRemote(arch string) string
- type Packager
- func (p *Packager) ClearTempPaths()
- func (p *Packager) Create(baseDir string) error
- func (p *Packager) Deploy() error
- func (p *Packager) FindImages(baseDir, repoHelmChartPath string, kubeVersionOverride string) error
- func (p *Packager) GetPackageName() string
- func (p *Packager) Inspect(includeSBOM bool, outputSBOM string, inspectPublicKey string) error
- func (p *Packager) Publish() error
- func (p *Packager) Pull() error
- func (p *Packager) Remove(packageName string) (err error)
Constants ¶
const (
ZarfLayerMediaTypeBlob = "application/vnd.zarf.layer.v1.blob"
)
ZarfLayerMediaTypeBlob is the media type for all Zarf layers due to the range of possible content
Variables ¶
This section is empty.
Functions ¶
func GetInitPackageName ¶
GetInitPackageName returns the formatted name of the init package.
func GetInitPackageRemote ¶ added in v0.26.4
GetInitPackageRemote returns the URL for a remote init package for the given architecture
Types ¶
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) (*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) *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) GetPackageName ¶
GetPackageName returns the formatted name of the package.
func (*Packager) Publish ¶ added in v0.25.0
Publish publishes the package to a registry
This is a wrapper around the oras library and much of the code was adapted from the oras CLI - https://github.com/oras-project/oras/blob/main/cmd/oras/push.go
Authentication is handled via the Docker config file created w/ `zarf tools registry login`
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package deprecated handles package deprecations and migrations
|
Package deprecated handles package deprecations and migrations |