image

Documentation

Index

• type Reference
• type Registry
• type SimpleReference
  • func (s SimpleReference) String() string

Types

type Reference

type Reference interface {
	fmt.Stringer
}

Reference describes a reference to a container image.

type Registry

type Registry interface {
	// Pull fetches and stores an image by reference.
	Pull(ctx context.Context, ref Reference) error

	// Unpack writes the unpackaged content of an image to a directory.
	// If the referenced image does not exist in the registry, an error is returned.
	Unpack(ctx context.Context, ref Reference, dir string) error

	// Labels gets the labels for an image that is already stored.
	Labels(ctx context.Context, ref Reference) (map[string]string, error)

	// Destroy cleans up any on-disk resources used to track images
	Destroy() error
}

Registry knows how to Pull and Unpack Operator Bundle images to the filesystem. Note: In the future, Registry will know how to Build and Push Operator Bundle images as well.

type SimpleReference

type SimpleReference string

SimpleReference is a reference backed by a string with no additional validation.

func (SimpleReference) String

func (s SimpleReference) String() string