referenceutil

Documentation

Index

• func ParseDockerRef(rawRef string) (distributionref.Named, error)
• func ParseIPFSRefWithScheme(name string) (scheme, ref string, err error)
• func SuggestContainerName(rawRef, containerID string) string
• type Reference
  • func ParseAny(rawRef string) (Reference, error)
  • func ParseAnyReference(rawRef string) (Reference, error)

Functions

func ParseDockerRef

func ParseDockerRef(rawRef string) (distributionref.Named, error)

ParseDockerRef parses the passed reference with assuming it's a docker reference.

func ParseIPFSRefWithScheme

func ParseIPFSRefWithScheme(name string) (scheme, ref string, err error)

ParseIPFSRefWithScheme parses the passed reference with assuming it's an IPFS reference with scheme prefix.

func SuggestContainerName

func SuggestContainerName(rawRef, containerID string) string

SuggestContainerName generates a container name from name. The result MUST NOT be parsed.

Types

type Reference

type Reference interface {

	// String returns the full reference which can be understood by containerd.
	String() string
}

Reference is a reference to an image.

func ParseAny

func ParseAny(rawRef string) (Reference, error)

ParseAny parses the passed reference with allowing it to be non-docker reference. If the ref has IPFS scheme or can be parsed as CID, it's parsed as an IPFS reference. Otherwise it's parsed as a docker reference.

func ParseAnyReference

func ParseAnyReference(rawRef string) (Reference, error)

ParseAnyReference parses the passed reference as IPFS, CID, or a classic reference. Unlike ParseAny, it is not limited to the DockerRef limitations (being either tagged or digested) and should be used instead.