bundle

Documentation

Index

• func Pack(directory string) (io.ReadCloser, error)
• func PackAndPush(ref name.Reference, directory string, options ...remote.Option) (name.Digest, error)
• func PullAndUnpack(ref name.Reference, targetPath string, options ...remote.Option) (containerreg.Image, error)
• type UnpackDetails
  • func Unpack(in io.Reader, targetPath string) (*UnpackDetails, error)

Functions

func Pack

func Pack(directory string) (io.ReadCloser, error)

Pack reads a directory and creates a tar stream with its content by: - storing all directories and regular files as-is, - dereferencing all symlinks and storing the respective target, - ignoring all files configured in .shpignore

func PackAndPush

func PackAndPush(ref name.Reference, directory string, options ...remote.Option) (name.Digest, error)

PackAndPush a local directory as-is into a container image. See remote.Option for optional options to the image push to the registry, for example to provide the appropriate access credentials.

func PullAndUnpack

func PullAndUnpack(ref name.Reference, targetPath string, options ...remote.Option) (containerreg.Image, error)

PullAndUnpack a container image layer content into a local directory. Analog to the bundle.PackAndPush function, optional remote.Option can be used to configure settings for the image pull, i.e. access credentials.

Types

type UnpackDetails

type UnpackDetails struct {
	MostRecentFileTimestamp *time.Time
}

UnpackDetails contains details about the files that were unpacked

func Unpack

func Unpack(in io.Reader, targetPath string) (*UnpackDetails, error)

Unpack reads a tar stream and writes the content into the local file system with all files and directories.