imgutil

README

imgutil

Helpful utilities for working with images

Development

To format:

$ make format

To run tests:

$ make test

Documentation

Index

• type Identifier
• type Image
• type SaveDiagnostic
• type SaveError
  • func (e SaveError) Error() string

Types

type Identifier

type Identifier fmt.Stringer

type Image

type Image interface {
	Name() string
	Rename(name string)
	Label(string) (string, error)
	SetLabel(string, string) error
	Env(key string) (string, error)
	SetEnv(string, string) error
	SetEntrypoint(...string) error
	SetWorkingDir(string) error
	SetCmd(...string) error
	Rebase(string, Image) error
	AddLayer(path string) error
	ReuseLayer(diffID string) error
	// TopLayer returns the diff id for the top layer
	TopLayer() (string, error)
	// Save saves the image as `Name()` and any additional names provided to this method.
	Save(additionalNames ...string) error
	// Found tells whether the image exists in the repository by `Name()`.
	Found() bool
	// GetLayer retrieves layer by diff id. Returns a reader of the uncompressed contents of the layer.
	GetLayer(diffID string) (io.ReadCloser, error)
	Delete() error
	CreatedAt() (time.Time, error)
	Identifier() (Identifier, error)
}

type SaveDiagnostic

type SaveDiagnostic struct {
	ImageName string
	Cause     error
}

type SaveError

type SaveError struct {
	Errors []SaveDiagnostic
}

func (SaveError) Error

func (e SaveError) Error() string