Documentation
¶
Index ¶
Constants ¶
const ( // DefaultTag defines the default tag used when performing images related actions and no tag or digest is specified DefaultTag = "latest" // DefaultHostname is the default built-in hostname DefaultHostname = "docker.io" // LegacyDefaultHostname is automatically converted to DefaultHostname LegacyDefaultHostname = "index.docker.io" // DefaultRepoPrefix is the prefix used for default repositories in default host DefaultRepoPrefix = "library/" )
Variables ¶
var ( // ErrDoesNotExist is returned if a reference is not found in the // store. ErrDoesNotExist = errors.New("reference does not exist") )
Functions ¶
func IsNameOnly ¶
IsNameOnly returns true if reference only contains a repo name.
Types ¶
type Association ¶
An Association is a tuple associating a reference with an image ID.
type Canonical ¶
Canonical reference is an object with a fully unique name including a name with hostname and 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 ParseIDOrReference ¶ added in v1.11.0
ParseIDOrReference parses string for an image ID or a reference. ID can be without a default prefix.
func ParseNamed ¶
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 ¶
WithDefaultTag adds a default tag to a reference if it only has a repo name.
type NamedTagged ¶
NamedTagged is an object including a name and tag.
type Store ¶
type Store interface {
References(id digest.Digest) []Named
ReferencesByName(ref Named) []Association
AddTag(ref Named, id digest.Digest, force bool) error
AddDigest(ref Canonical, id digest.Digest, force bool) error
Delete(ref Named) (bool, error)
Get(ref Named) (digest.Digest, error)
}
Store provides the set of methods which can operate on a tag store.
func NewReferenceStore ¶
NewReferenceStore creates a new reference store, tied to a file path where the set of references are serialized in JSON format.
Source Files