dockerv1client

Documentation

Index

• func IsBlobNotFound(err error) bool
• func IsImageNotFound(err error) bool
• func IsNotFound(err error) bool
• func IsRegistryNotFound(err error) bool
• func IsRepositoryNotFound(err error) bool
• func IsTagNotFound(err error) bool
• func NewImageNotFoundError(repository, image, tag string) error
• type Client
  • func NewClient(dialTimeout time.Duration, allowV2 bool) Client
• type Connection
• type Image

Functions

func IsBlobNotFound

func IsBlobNotFound(err error) bool

func IsImageNotFound

func IsImageNotFound(err error) bool

func IsNotFound

func IsNotFound(err error) bool

func IsRegistryNotFound

func IsRegistryNotFound(err error) bool

func IsRepositoryNotFound

func IsRepositoryNotFound(err error) bool

func IsTagNotFound

func IsTagNotFound(err error) bool

func NewImageNotFoundError

func NewImageNotFoundError(repository, image, tag string) error

Types

type Client

type Client interface {
	// Connect to a Docker registry by name. Pass "" for the Docker Hub
	Connect(registry string, allowInsecure bool) (Connection, error)
}

Client includes methods for accessing a Docker registry by name.

func NewClient

func NewClient(dialTimeout time.Duration, allowV2 bool) Client

NewClient returns a client object which allows public access to a Docker registry. enableV2 allows a client to prefer V1 registry API connections. TODO: accept a docker auth config

type Connection

type Connection interface {
	// ImageTags will return a map of the tags for the image by namespace and name.
	// If namespace is not specified, will default to "library" for Docker hub.
	ImageTags(namespace, name string) (map[string]string, error)
	// ImageByID will return the requested image by namespace, name, and ID.
	// If namespace is not specified, will default to "library" for Docker hub.
	ImageByID(namespace, name, id string) (*Image, error)
	// ImageByTag will return the requested image by namespace, name, and tag
	// (if not specified, "latest").
	// If namespace is not specified, will default to "library" for Docker hub.
	ImageByTag(namespace, name, tag string) (*Image, error)
	// ImageManifest will return the raw image manifest and digest by namespace,
	// name, and tag.
	ImageManifest(namespace, name, tag string) (string, []byte, error)
}

Connection allows you to retrieve data from a Docker V1/V2 registry.

type Image

type Image struct {
	Image docker.Image

	// Does this registry support pull by ID
	PullByID bool
}