Documentation
¶
Overview ¶
Package layout is used to defining the distro package files
Index ¶
- type AssembleOptions
- type ClusterPath
- type Distro
- type DistroLayout
- func AssembleDistro(ctx context.Context, d distro.ZarfDistro, distroPath string, ...) (*DistroLayout, error)
- func LoadFromDir(ctx context.Context, dirPath string, _ DistroLayoutOptions) (*DistroLayout, error)
- func LoadFromTar(ctx context.Context, tarPath string, opts DistroLayoutOptions) (*DistroLayout, error)
- func NewDistroLayout(dir string, distro v1alpha1.ZarfDistro) *DistroLayout
- type DistroLayoutOptions
- type DistroPath
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AssembleOptions ¶
type AssembleOptions struct {
RegistryOverrides []images.RegistryOverride
OCIConcurrency int
CachePath string
SkipSBOM bool
types.RemoteOptions
}
AssembleOptions options
type ClusterPath ¶
ClusterPath object that contains the manifest file and base directory
func ResolveClusterPath ¶
func ResolveClusterPath(path string) (ClusterPath, error)
ResolveClusterPath returns an object of ClusterPath from a given path
type DistroLayout ¶
type DistroLayout struct {
Distro distro.ZarfDistro
// contains filtered or unexported fields
}
DistroLayout struct
func AssembleDistro ¶
func AssembleDistro(ctx context.Context, d distro.ZarfDistro, distroPath string, opts AssembleOptions) (*DistroLayout, error)
AssembleDistro creates the actual tarballs
func LoadFromDir ¶
func LoadFromDir(ctx context.Context, dirPath string, _ DistroLayoutOptions) (*DistroLayout, error)
LoadFromDir loads and validates a package from the given directory path.
func LoadFromTar ¶
func LoadFromTar(ctx context.Context, tarPath string, opts DistroLayoutOptions) (*DistroLayout, error)
LoadFromTar unpacks the given archive (any compress/format) and loads it.
func NewDistroLayout ¶
func NewDistroLayout(dir string, distro v1alpha1.ZarfDistro) *DistroLayout
NewDistroLayout returns an DistroLayout object
func (*DistroLayout) Archive ¶
Archive creates a tarball from the package layout and returns the path to that tarball
func (*DistroLayout) Cleanup ¶
func (d *DistroLayout) Cleanup() error
Cleanup removes any temporary directories created.
func (*DistroLayout) FileName ¶
func (d *DistroLayout) FileName() (string, error)
FileName returns the name of the Zarf package should have when exported to the file system
func (*DistroLayout) GetImageDirPath ¶
func (d *DistroLayout) GetImageDirPath() string
GetImageDirPath returns the path to where the image tar balls should be stored in
type DistroPath ¶
DistroPath object that contains the manifest file and base directory
func ResolveDistroPath ¶
func ResolveDistroPath(path string) (DistroPath, error)
ResolveDistroPath returns an object of DistroPath from a given path
Source Files