native

package

v4.0.0-rc.1 Latest Latest Go to latest Published: Aug 17, 2023 License: BSD-3-Clause Imports: 17 Imported by: 0

Details

This section is empty.

This section is empty.

func New(opts ...Option) (ocibundle.Bundle, error)

New returns a bundle interface to create/delete an OCI bundle from an OCI image ref.

type Bundle struct {
	ocibundle.Bundle
	// contains filtered or unexported fields
}

Bundle is a native OCI bundle, created from imageRef.

func (b *Bundle) Create(ctx context.Context, ociConfig *specs.Spec) error

Create will created the on-disk structures for the OCI bundle, so that it is ready for execution.

func (b *Bundle) Delete(_ context.Context) error

Delete erases OCI bundle created an OCI image ref

FIXME: use context for cancellation, or remove.

func (b *Bundle) ImageSpec() (imgSpec *imgspecv1.Image)

ImageSpec returns the OCI image spec associated with the bundle.

func (b *Bundle) Path() string

Path returns the bundle's path on disk.

func (b *Bundle) Update(_ context.Context, ociConfig *specs.Spec) error

Update will update the OCI config for the OCI bundle, so that it is ready for execution.

FIXME: use context for cancellation, or remove.

type Option func(b *Bundle) error

func OptBundlePath(bp string) Option

OptBundlePath sets the path that the bundle will be created at.

func OptImageRef(ref string) Option

OptImageRef sets the image source reference, from which the bundle will be created.

func OptImgCache(ic *cache.Handle) Option

OptImgCache sets the Singularity image cache used to pull through OCI blobs.

func OptSysCtx(sc *types.SystemContext) Option

OptSysCtx sets the OCI client SystemContext holding auth information etc.

func OptTmpDir(tmpDir string) Option

OptTempDir sets the parent temporary directory for temporary files generated outside of the assembled bundle.