reference

Documentation

Index

• Constants
• Variables
• type Association
• type ImageRef
  • func ParseImage(val string) (ImageRef, error)
  • func ParseImageWithDefaultTag(val, optionalTag string) (ImageRef, error)
• type Store
  • func NewReferenceStore(jsonPath string) (Store, error)

Constants

const (
	// DefaultDomain The default domain, if none was specified.
	DefaultDomain = "docker.io"
)

Variables

var (
	// ErrDoesNotExist is returned if a reference is not found in the
	// store.
	ErrDoesNotExist notFoundError = "reference does not exist"
)

Types

type Association

type Association struct {
	ID  string
	Ref ImageRef
}

Association An association between an id and an image.

type ImageRef

type ImageRef interface {
	Tag() string
	Name() string
	Domain() string
	FullName() string
	WithTag(tag string) (ImageRef, error)
	WithName(name string) (ImageRef, error)
	WithDomain(domain string) (ImageRef, error)
}

ImageRef An image reference.

func ParseImage

func ParseImage(val string) (ImageRef, error)

ParseImage Parses a string for image:tag.

func ParseImageWithDefaultTag

func ParseImageWithDefaultTag(val, optionalTag string) (ImageRef, error)

ParseImageWithDefaultTag Parse an image name. If not tag is given in the image name, use the optionalTag as the tag.

type Store

type Store interface {
	References(id string) ([]ImageRef, error)
	AddTag(ref ImageRef, id string, force bool) error
	Delete(ref ImageRef) (bool, error)
	Get(ref ImageRef) (Association, error)
	AllImages() ([]Association, error)
}

Store The store holding info about the live images.

func NewReferenceStore

func NewReferenceStore(jsonPath string) (Store, error)

NewReferenceStore Create a new store.