image

Documentation

Index

• Constants
• func IsNameOnly(ref Named) bool
• func ValidateID(id string) error
• type Canonical
  • func WithDigest(name Named, digest digest.Digest) (Canonical, error)
• type Named
  • func ParseNamed(s string) (Named, error)
  • func WithDefaultTag(ref Named) Named
  • func WithName(name string) (Named, error)
• type NamedTagged
  • func WithTag(name Named, tag string) (NamedTagged, error)
• type Reference
  • func Parse(remote string) (*Reference, error)
  • func (r Reference) Name() string
  • func (r Reference) Registry() string
  • func (r Reference) Remote() string
  • func (r Reference) Repository() string
  • func (r Reference) Scheme() string
  • func (r Reference) ShortName() string
  • func (r Reference) String() string
  • func (r Reference) Tag() string
• type Repository
  • func ParseRepo(remote string) (*Repository, error)

Constants

const (
	// DefaultTag defines the default tag used when performing images related actions and no tag or digest is specified
	DefaultTag = "latest"
	// DefaultRegistryHostname is the default built-in hostname
	// DefaultRegistryHostname = "index.docker.io"
	WrongRegistryHostname   = "docker.io"
	DefaultRegistryHostname = "index.docker.io"

	// DefaultScheme is default scheme for registries
	DefaultScheme = "https"

	// DefaultRepoPrefix is the prefix used for default repositories in default host
	DefaultRepoPrefix = "library/"
)

Functions

func IsNameOnly

func IsNameOnly(ref Named) bool

IsNameOnly returns true if reference only contains a repo name.

func ValidateID

func ValidateID(id string) error

ValidateID checks whether an ID string is a valid image ID.

Types

type Canonical

type Canonical interface {
	Named
	Digest() digest.Digest
}

Canonical reference is an object with a fully unique name including a name with hostname and digest

func WithDigest

func WithDigest(name Named, digest digest.Digest) (Canonical, error)

WithDigest combines the name from "name" and the digest from "digest" to form a reference incorporating both the name and the digest.

type Named

type Named interface {
	// Name returns normalized repository name, like "ubuntu".
	Name() string
	// String returns full reference, like "ubuntu@sha256:abcdef..."
	String() string
	// FullName returns full repository name with hostname, like "docker.io/library/ubuntu"
	FullName() string
	// Hostname returns hostname for the reference, like "docker.io"
	Hostname() string
	// RemoteName returns the repository component of the full name, like "library/ubuntu"
	RemoteName() string
}

Named is an object with a full name

func ParseNamed

func ParseNamed(s string) (Named, error)

ParseNamed parses s and returns a syntactically valid reference implementing the Named interface. The reference must have a name, otherwise an error is returned. If an error was encountered it is returned, along with a nil Reference.

func WithDefaultTag

func WithDefaultTag(ref Named) Named

WithDefaultTag adds a default tag to a reference if it only has a repo name.

func WithName

func WithName(name string) (Named, error)

WithName returns a named object representing the given string. If the input is invalid ErrReferenceInvalidFormat will be returned.

type NamedTagged

type NamedTagged interface {
	Named
	Tag() string
}

NamedTagged is an object including a name and tag.

func WithTag

func WithTag(name Named, tag string) (NamedTagged, error)

WithTag combines the name from "name" and the tag from "tag" to form a reference incorporating both the name and the tag.

type Reference

type Reference struct {
	// contains filtered or unexported fields
}

Reference is an opaque object that include identifier such as a name, tag, repository, registry, etc...

func Parse

func Parse(remote string) (*Reference, error)

Parse returns a Reference from analyzing the given remote identifier.

func (Reference) Name

func (r Reference) Name() string

Name returns the image's name. (ie: debian[:8.2])

func (Reference) Registry

func (r Reference) Registry() string

Registry returns the image's registry. (ie: host[:port])

func (Reference) Remote

func (r Reference) Remote() string

Remote returns the image's remote identifier. (ie: registry/name[:tag])

func (Reference) Repository

func (r Reference) Repository() string

Repository returns the image's repository. (ie: registry/name)

func (Reference) Scheme

func (r Reference) Scheme() string

Scheme returns registry's scheme. (ie: https)

func (Reference) ShortName

func (r Reference) ShortName() string

ShortName returns the image's name (ie: debian)

func (Reference) String

func (r Reference) String() string

func (Reference) Tag

func (r Reference) Tag() string

Tag returns the image's tag (or digest).

type Repository

type Repository struct {
	Name       string // Name returns the image's name. (ie: debian[:8.2])
	Repository string // Repository returns the image's repository. (ie: registry/name)
	Registry   string // Registry returns the image's registry. (ie: host[:port])
	Scheme     string // Registry scheme. (ie: http)
	ShortName  string // ShortName returns the image's name (ie: debian)
	Remote     string // Remote returns the image's remote identifier. (ie: registry/name[:tag])
	Tag        string // Tag returns the image's tag (or digest).
}

Repository is an object created from Named interface

func ParseRepo

func ParseRepo(remote string) (*Repository, error)

ParseRepo - parses remote pretty much the same as Parse but better for testing