docker

Documentation

Index

• type ErrorType
  • func (et ErrorType) String() string
• type ImagePullError
  • func (ipe ImagePullError) Error() string
  • func (ipe *ImagePullError) String() string
• type ImagePuller
  • func NewImagePuller(registries []*common.RegistryAuth) *ImagePuller
  • func (ip *ImagePuller) CreateImageInLocalDocker(image imageInterface.Image) error
  • func (ip *ImagePuller) PullImage(image imageInterface.Image) error
  • func (ip *ImagePuller) SaveImageToTar(image imageInterface.Image) error

Types

type ErrorType

type ErrorType int

ErrorType ...

const (
	ErrorTypeUnableToCreateImage       ErrorType = iota
	ErrorTypeUnableToGetImage          ErrorType = iota
	ErrorTypeBadStatusCodeFromGetImage ErrorType = iota
	ErrorTypeUnableToCreateTarFile     ErrorType = iota
	ErrorTypeUnableToCopyTarFile       ErrorType = iota
	ErrorTypeUnableToGetFileStats      ErrorType = iota
)

...

func (ErrorType) String

func (et ErrorType) String() string

type ImagePullError

type ImagePullError struct {
	Code      ErrorType
	RootCause error
}

ImagePullError ...

func (ImagePullError) Error

func (ipe ImagePullError) Error() string

func (*ImagePullError) String

func (ipe *ImagePullError) String() string

type ImagePuller

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

ImagePuller contains the http Docker client and the secured Docker registry credentials

func NewImagePuller

func NewImagePuller(registries []*common.RegistryAuth) *ImagePuller

NewImagePuller returns the Image puller type

func (*ImagePuller) CreateImageInLocalDocker

func (ip *ImagePuller) CreateImageInLocalDocker(image imageInterface.Image) error

CreateImageInLocalDocker could also be implemented using curl: this example hits ... ? the default registry? docker hub?

curl --unix-socket /var/run/docker.sock -X POST http://localhost/images/create?fromImage=alpine

this example hits the kipp registry:

curl --unix-socket /var/run/docker.sock -X POST http://localhost/images/create\?fromImage\=registry.kipp.blackducksoftware.com%2Fblackducksoftware%2Fhub-jobrunner%3A4.5.0

func (*ImagePuller) PullImage

func (ip *ImagePuller) PullImage(image imageInterface.Image) error

PullImage gives us access to a docker image by:

1. hitting a docker create endpoint (?)
2. pulling down the newly created image and saving as a tarball

It does this by accessing the host's docker daemon, locally, over the docker socket. This gives us a window into any images that are local.

func (*ImagePuller) SaveImageToTar

func (ip *ImagePuller) SaveImageToTar(image imageInterface.Image) error

SaveImageToTar -- part of what it does is to issue an http request similar to the following:

curl --unix-socket /var/run/docker.sock -X GET http://localhost/images/openshift%2Forigin-docker-registry%3Av3.6.1/get