docker

Documentation

Index

• Variables
• func CheckAuth(ctx context.Context, sCtx *types.SystemContext, ...) error
• func NewReference(ref reference.Named) (types.ImageReference, error)
• func ParseReference(refString string) (types.ImageReference, error)
• type Image
  • func (i *Image) GetRepositoryTags() ([]string, error)
  • func (i *Image) SourceRefFullName() string

Variables

var (
	// ErrV1NotSupported is returned when we're trying to talk to a
	// docker V1 registry.
	ErrV1NotSupported = errors.New("can't talk to a V1 docker registry")
	// ErrUnauthorizedForCredentials is returned when the status code returned is 401
	ErrUnauthorizedForCredentials = errors.New("unable to retrieve auth token: invalid username/password")
)

var Transport = dockerTransport{}

Transport is an ImageTransport for Docker registry-hosted images.

Functions

func CheckAuth

func CheckAuth(ctx context.Context, sCtx *types.SystemContext, username, password, registry string) error

CheckAuth validates the credentials by attempting to log into the registry returns an error if an error occcured while making the http request or the status code received was 401

func NewReference

func NewReference(ref reference.Named) (types.ImageReference, error)

NewReference returns a Docker reference for a named reference. The reference must satisfy !reference.IsNameOnly().

func ParseReference

func ParseReference(refString string) (types.ImageReference, error)

ParseReference converts a string, which should not start with the ImageTransport.Name prefix, into an Docker ImageReference.

Types

type Image

type Image struct {
	types.ImageCloser
	// contains filtered or unexported fields
}

Image is a Docker-specific implementation of types.ImageCloser with a few extra methods which are specific to Docker.

func (*Image) GetRepositoryTags

func (i *Image) GetRepositoryTags() ([]string, error)

GetRepositoryTags list all tags available in the repository. Note that this has no connection with the tag(s) used for this specific image, if any.

func (*Image) SourceRefFullName

func (i *Image) SourceRefFullName() string

SourceRefFullName returns a fully expanded name for the repository this image is in.