Documentation
¶
Overview ¶
Package distro is used for creating/deploying distro package
Index ¶
- func Create(ctx context.Context, distroPath string, output string, opts CreateOptions) (string, error)
- func Load(ctx context.Context, source string, opts LoadOptions) (*layout.DistroLayout, error)
- func Publish(ctx context.Context, disLayout *layout.DistroLayout, dst registry.Reference, ...) (registry.Reference, error)
- func Pull(ctx context.Context, source, destination string, opts PullOptions) (string, error)
- type CreateOptions
- type LoadOptions
- type PublishOptions
- type PullOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Create ¶
func Create(ctx context.Context, distroPath string, output string, opts CreateOptions) (string, error)
Create used to create a distro package
func Load ¶ added in v0.10.0
func Load(ctx context.Context, source string, opts LoadOptions) (*layout.DistroLayout, error)
Load fetches, verifies, and loads a Zarf package from the specified source.
Types ¶
type CreateOptions ¶
type CreateOptions struct {
OCIConcurrency int
CachePath string
IsInteractive bool
SkipSBOM bool
types.RemoteOptions
}
CreateOptions are the optional parameters to create
type LoadOptions ¶ added in v0.10.0
type LoadOptions struct {
Shasum string
Architecture string
Output string
// number of layers to pull in parallel
OCIConcurrency int
// CachePath is used to cache layers from OCI package pulls
CachePath string
VerifyBlobOptions *signing.VerifyBlobOptions
// Only applicable to OCI + HTTP
types.RemoteOptions
// VerificationStrategy for explicit definition
layout.VerificationStrategy
}
LoadOptions are the options for LoadDistro.
type PublishOptions ¶ added in v0.9.0
type PublishOptions struct {
// OCIConcurrency configures the amount of layers to push in parallel
OCIConcurrency int
// Retries specifies the number of retries to use
Retries int
// SignBlobOptions holds all signing configuration. Use signing.DefaultSignBlobOptions() as a base.
SignBlobOptions signing.SignBlobOptions
CachePath string
IsInteractive bool
Registry *registry.Reference
types.RemoteOptions
// Tag is an optional tag for the OCI reference separate from the package metadata.version
Tag string
}
PublishOptions are the optional parameters to publish
type PullOptions ¶ added in v0.10.0
type PullOptions struct {
// SHASum uniquely identifies a package based on its contents.
SHASum string
// Architecture is the package architecture.
Architecture string
// Deprecated: Use VerifyBlobOptions instead. PublicKeyPath validates the create-time signage of a package.
PublicKeyPath string
// VerifyBlobOptions configures package signature verification.
VerifyBlobOptions *signing.VerifyBlobOptions
// OCIConcurrency is the number of layers pulled in parallel
OCIConcurrency int
// CachePath is used to cache layers from OCI package pulls
CachePath string
types.RemoteOptions
// VerificationStrategy for explicit definition
layout.VerificationStrategy
}
PullOptions declares optional configuration for a Pull operation.
Click to show internal directories.
Click to hide internal directories.