bundle

package

Go to main page

Versions in this module

v0

v0.39.0

Oct 5, 2026

Changes in this version

+ var ErrResumeSourceNotPrepared = errors.New("resume requires a prepared deployment source")

type DeployOptions

+ Resume bool

v0.38.0

Sep 18, 2026

v0.37.0

Sep 8, 2026

Changes in this version

type InspectResult

+ Bundle *spec.UDSBundle

type RemoveOptions

+ SkipSignatureVerification bool

+ Verification VerificationPolicy

v0.36.0

Aug 25, 2026

Changes in this version

+ const BundleSignatureStatusNotChecked

+ const BundleSignatureStatusSkipped

+ const BundleSignatureStatusUnverified

+ const BundleSignatureStatusVerified

+ const PackageSigningStatusSigned

+ const PackageSigningStatusUnknown

+ const PackageSigningStatusUnsigned

+ const PackageVerificationStatusSkipped

+ const PackageVerificationStatusUnknown

+ const PackageVerificationStatusVerified

+ var ErrBundleDirRequired = errors.New("bundle directory is required")

+ var ErrBundleFileRequired = errors.New("bundle file is required")

+ var ErrBundleInputRequired = errors.New("bundle path or bundle is required")

+ var ErrBundleNotSigned = errors.New("bundle is not signed")

+ var ErrCreateBundle = errors.New("creating bundle")

+ var ErrDefaultsFileRequired = errors.New("defaults file is required")

+ var ErrDeployBundle = errors.New("deploying bundle")

+ var ErrInspectBundle = errors.New("inspecting bundle")

+ var ErrInvalidConfig = errors.New("invalid bundle configuration")

+ var ErrInvalidOCIReference = errors.New("invalid OCI reference")

+ var ErrInvalidSigningOptions = errors.New("invalid bundle signing options")

+ var ErrInvalidSuffix = errors.New("invalid reconfiguration suffix")

+ var ErrInvalidVerificationPolicy = errors.New("invalid bundle verification policy")

+ var ErrPrepareDeploySource = errors.New("preparing deploy source")

+ var ErrPullBundle = errors.New("pulling bundle")

+ var ErrPushBundle = errors.New("pushing bundle")

+ var ErrReconfigureBundle = errors.New("reconfiguring bundle")

+ var ErrRemoveBundle = errors.New("removing bundle")

+ var ErrSignBundle = errors.New("signing bundle")

+ var ErrSourceRequired = errors.New("bundle source is required")

+ var ErrTargetDirRequired = errors.New("target directory is required")

+ var ErrValidateDependencies = errors.New("validating bundle dependencies")

+ var ErrVerifyBundle = errors.New("verifying bundle")

+ func Sign(ctx context.Context, opts SignOptions) error

+ func Verify(ctx context.Context, opts VerifyOptions) error

+ type BundleDeployHooks struct

+ PostDeploy func(ctx context.Context, b *spec.UDSBundle) error

+ PreDeploy func(ctx context.Context, b *spec.UDSBundle, opts *DeployOptions) error

+ type BundleSignatureSummary struct

+ Status string

+ type ConfigOptions struct

+ Architecture string

+ Concurrency int

+ LogLevel string

+ PlainHTTP bool

+ SkipTLSVerify bool

+ TmpDir string

+ type CreateOptions struct

+ Config *UDSBundleConfig

+ Signing SigningOptions

+ Streams iostreams.IOStreams

+ func (o CreateOptions) Validate() error

+ type CreateResult struct

+ BundleName string

+ OutputPath string

+ func Create(ctx context.Context, bundleFile string, opts CreateOptions) (*CreateResult, error)

+ type DependencyViolationError struct

+ Violations map[string][]string

+ func (e *DependencyViolationError) Error() string

+ type DeployOptions struct

+ BundleDeployHooks BundleDeployHooks

+ Config *UDSBundleConfig

+ Force bool

+ PackageDeployHooks PackageDeployHooks

+ Packages []string

+ Streams iostreams.IOStreams

+ func (o DeployOptions) Validate() error

+ type DeployPackageOptions struct

+ BundleDir string

+ Config *UDSBundleConfig

+ IsPartial bool

+ PackageDeployHooks PackageDeployHooks

+ Streams iostreams.IOStreams

+ func (o DeployPackageOptions) Validate() error

+ type DeployPackageResult struct

+ Name string

+ type DeployResult struct

+ BundleName string

+ Packages []DeployPackageResult

+ func Deploy(ctx context.Context, source *DeploySource, opts DeployOptions) (*DeployResult, error)

+ type DeploySource struct

+ Bundle *spec.UDSBundle

+ BundlePath string

+ DefaultsPath string

+ Loader ZarfPackageLayoutLoader

+ func PrepareDeploySource(ctx context.Context, streams iostreams.IOStreams, ...) (*DeploySource, error)

+ func (s *DeploySource) Close() error

+ type GlobalOptions struct

+ LogLevel string

+ Prompt bool

+ type InspectOptions struct

+ Config *UDSBundleConfig

+ SkipSignatureVerification bool

+ Source string

+ Streams iostreams.IOStreams

+ Verification VerificationPolicy

+ func (o InspectOptions) Validate() error

+ type InspectResult struct

+ ArtifactDigest string

+ BundleSignature *BundleSignatureSummary

+ Description string

+ Name string

+ Packages []PackageSummary

+ ReconfiguredFrom string

+ Version string

+ func Inspect(ctx context.Context, opts InspectOptions) (*InspectResult, error)

+ type KeylessVerification struct

+ CertificateIdentity string

+ CertificateIdentityRegexp string

+ CertificateOIDCIssuer string

+ CertificateOIDCIssuerRegexp string

+ TrustedRoot string

+ type PackageDeployHooks struct

+ PostDeploy func(ctx context.Context, pkg *spec.Package) error

+ PreDeploy func(ctx context.Context, pkg *spec.Package, pkgLayout *ZarfPackageLayout, ...) error

+ type PackageSignatureSummary struct

+ Signed string

+ Verification string

+ type PackageStagingRootProvider interface

+ PackageStagingRoot func(context.Context) string

+ type PackageSummary struct

+ DependsOn []string

+ Name string

+ Namespace string

+ Signature *PackageSignatureSummary

+ Source string

+ ValuesFiles []string

+ type PullOptions struct

+ Config *UDSBundleConfig

+ SkipSignatureVerification bool

+ Streams iostreams.IOStreams

+ Verification VerificationPolicy

+ func (o PullOptions) Validate() error

+ type PullResult struct

+ OCIReference string

+ OutputPath string

+ func Pull(ctx context.Context, ref, targetDir string, opts PullOptions) (*PullResult, error)

+ type PushOptions struct

+ Config *UDSBundleConfig

+ Streams iostreams.IOStreams

+ func (o PushOptions) Validate() error

+ type PushResult struct

+ OCIReference string

+ func Push(ctx context.Context, bundleTarball, ref string, opts PushOptions) (*PushResult, error)

+ type ReconfigureOptions struct

+ Config *UDSBundleConfig

+ OutputDir string

+ Signing SigningOptions

+ SkipSignatureVerification bool

+ Streams iostreams.IOStreams

+ Suffix string

+ Verification VerificationPolicy

+ func (o ReconfigureOptions) Validate() error

+ type ReconfigureResult struct

+ OCIReference string

+ OutputPath string

+ func Reconfigure(ctx context.Context, source, defaultsFile string, opts ReconfigureOptions) (*ReconfigureResult, error)

+ type RemoveOptions struct

+ Config *UDSBundleConfig

+ Force bool

+ Packages []string

+ Streams iostreams.IOStreams

+ func (o RemoveOptions) Validate() error

+ type RemovePackageResult struct

+ Name string

+ Status RemovePackageStatus

+ type RemovePackageStatus string

+ const RemovePackageStatusRemoved

+ const RemovePackageStatusSkipped

+ type RemoveResult struct

+ BundleName string

+ Packages []RemovePackageResult

+ func Remove(ctx context.Context, source *DeploySource, opts RemoveOptions) (*RemoveResult, error)

+ type SignOptions struct

+ Config *UDSBundleConfig

+ Signing SigningOptions

+ Source string

+ Streams iostreams.IOStreams

+ TmpDir string

+ func (o SignOptions) Validate() error

+ type SigningMode string

+ const SigningModeKey

+ const SigningModeKeyless

+ const SigningModeUnsigned

+ type SigningOptions struct

+ FulcioAuthFlow string

+ FulcioURL string

+ IdentityToken string

+ Key string

+ KeyPassword string

+ Mode SigningMode

+ OIDCClientID string

+ OIDCIssuer string

+ Overwrite bool

+ RekorURL string

+ TSAServerURL string

+ func (o SigningOptions) Validate() error

+ type UDSBundleConfig struct

+ Global *GlobalOptions

+ Options *ConfigOptions

+ SignatureVerification *VerificationPolicy

+ Variables Variables

+ type Variables map[string]any

+ type VerificationPolicy struct

+ Keyless *KeylessVerification

+ PublicKey string

+ func (p VerificationPolicy) Validate() error

+ type VerifyOptions struct

+ Config *UDSBundleConfig

+ Policy VerificationPolicy

+ Source string

+ Streams iostreams.IOStreams

+ TmpDir string

+ func (o VerifyOptions) Validate() error

+ type ZarfPackageLayout struct

+ PackageDefinition api.PackageDefinition

+ func (p *ZarfPackageLayout) Digest() string

+ func (p *ZarfPackageLayout) DirPath() string

+ func (p *ZarfPackageLayout) SetDeployedDigest(digest string)

+ type ZarfPackageLayoutLoadOptions struct

+ IsPartial bool

+ Streams iostreams.IOStreams

+ type ZarfPackageLayoutLoadResult struct

+ IsPartial bool

+ Layout ZarfPackageLayout

+ type ZarfPackageLayoutLoader interface

+ LoadPackageLayout func(ctx context.Context, pkg *spec.Package, dstDir string, ...) (*ZarfPackageLayoutLoadResult, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL