Documentation
¶
Overview ¶
Package assemble builds a Zarf package on disk: it resolves each component's charts, manifests, files, repos, images and data injections into the layout that package layout reads back. It owns the build-time dependencies (helm, git, kustomize, image pulls, SBOM generation) so `layout` can focus on reading and naming.
Index ¶
- func AssemblePackage(ctx context.Context, resolvedPackage *load.ResolvedPackage, ...) (_ *layout.PackageLayout, err error)
- func AssembleSkeleton(ctx context.Context, resolvedPackage *load.ResolvedPackage, ...) (*layout.PackageLayout, error)
- func PackageChart(ctx context.Context, chart api.Chart, resources *load.ResourceSet, ...) error
- func PackageManifest(ctx context.Context, manifest api.Manifest, compBuildPath string, ...) error
- type AssembleOptions
- type AssembleSkeletonOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AssemblePackage ¶
func AssemblePackage(ctx context.Context, resolvedPackage *load.ResolvedPackage, opts AssembleOptions) (_ *layout.PackageLayout, err error)
AssemblePackage consumes a resource-ready package and returns a package layout with all the resources collected. It closes the loaded package before returning.
func AssembleSkeleton ¶
func AssembleSkeleton(ctx context.Context, resolvedPackage *load.ResolvedPackage, opts AssembleSkeletonOptions) (*layout.PackageLayout, error)
AssembleSkeleton creates a skeleton package and returns the path to the created package.
func PackageChart ¶
func PackageChart(ctx context.Context, chart api.Chart, resources *load.ResourceSet, paths layout.ChartPaths, cachePath string, remoteOpts types.RemoteOptions) error
PackageChart takes a Zarf Chart definition and packs it into a package layout
func PackageManifest ¶
func PackageManifest(ctx context.Context, manifest api.Manifest, compBuildPath string, resources *load.ResourceSet) error
PackageManifest takes a Zarf manifest definition and packs it into a package layout
Types ¶
type AssembleOptions ¶
type AssembleOptions struct {
// Flavor causes the package to only include components with a matching `.components[x].only.flavor` or no flavor `.components[x].only.flavor` specified.
Flavor string
// RegistryOverrides overrides the basepath of an OCI image with a path to a different registry.
RegistryOverrides []images.RegistryOverride
// A nil value leaves the package unsigned; a non-nil value requests signing.
SignBlobOptions *signing.SignBlobOptions
// Deprecated: populate SignBlobOptions.Key directly.
SigningKeyPath string
// Deprecated: populate SignBlobOptions.Password directly.
SigningKeyPassword string
SkipSBOM bool
// When DifferentialPackage is set the zarf package created only includes images and repos not in the differential package.
DifferentialPackage api.Package
OCIConcurrency int
// CachePath is the path to the Zarf cache, used to cache images and charts.
CachePath string
// WithBuildMachineInfo includes build machine information (hostname and username) in the package metadata.
WithBuildMachineInfo bool
types.RemoteOptions
}
AssembleOptions are the options for creating a package from a package object.
type AssembleSkeletonOptions ¶
type AssembleSkeletonOptions struct {
// Deprecated: use PackageLayout.SignPackage or the sign command.
SigningKeyPath string
// Deprecated: use PackageLayout.SignPackage or the sign command.
SigningKeyPassword string
Flavor string
WithBuildMachineInfo bool
}
AssembleSkeletonOptions are the options for creating a skeleton package.
Source Files