Documentation
¶
Overview ¶
Package layout contains functions for inteacting the Zarf packages.
Index ¶
Constants ¶
const ( ZarfYAML = "zarf.yaml" Signature = "zarf.yaml.sig" Checksums = "checksums.txt" ImagesDir = "images" ComponentsDir = "components" SBOMDir = "zarf-sbom" SBOMTar = "sboms.tar" IndexJSON = "index.json" OCILayout = "oci-layout" )
Constants used in the default package layout.
Variables ¶
This section is empty.
Functions ¶
func CreateSkeleton ¶ added in v0.42.0
CreateSkeleton creates a skeleton package and returns the path to the created package.
func ParseZarfPackage ¶ added in v0.42.0
func ParseZarfPackage(b []byte) (v1alpha1.ZarfPackage, error)
ParseZarfPackage parses the yaml passed as a byte slice and applies potential schema migrations.
Types ¶
type ComponentDir ¶
type ComponentDir string
ComponentDir is the type for the different directories in a component.
const ( RepoComponentDir ComponentDir = "repos" FilesComponentDir ComponentDir = "files" ChartsComponentDir ComponentDir = "charts" ManifestsComponentDir ComponentDir = "manifests" DataComponentDir ComponentDir = "data" ValuesComponentDir ComponentDir = "values" )
Different component directory types.
type CreateOptions ¶ added in v0.42.0
type CreateOptions struct {
Flavor string
RegistryOverrides map[string]string
SigningKeyPath string
SigningKeyPassword string
SetVariables map[string]string
}
CreateOptions are the options for creating a skeleton package.
type PackageLayout ¶
type PackageLayout struct {
Pkg v1alpha1.ZarfPackage
// contains filtered or unexported fields
}
PackageLayout manages the layout for a package.
func LoadFromDir ¶
func LoadFromDir(ctx context.Context, dirPath string, opt PackageLayoutOptions) (*PackageLayout, error)
LoadFromDir loads and validates a package from the given directory path.
func LoadFromTar ¶
func LoadFromTar(ctx context.Context, tarPath string, opt PackageLayoutOptions) (*PackageLayout, error)
LoadFromTar unpacks the give compressed package and loads it.
func (*PackageLayout) Cleanup ¶
func (p *PackageLayout) Cleanup() error
Cleanup removes any temporary directories created.
func (*PackageLayout) GetComponentDir ¶
func (p *PackageLayout) GetComponentDir(destPath, componentName string, ct ComponentDir) (string, error)
GetComponentDir returns a path to the directory in the given component.
func (*PackageLayout) GetImage ¶
func (p *PackageLayout) GetImage(ref transform.Image) (registryv1.Image, error)
GetImage returns the image with the given reference in the package layout.
type PackageLayoutOptions ¶
type PackageLayoutOptions struct {
PublicKeyPath string
SkipSignatureValidation bool
IsPartial bool
}
PackageLayoutOptions are the options used when loading a package.
Source Files