common

Documentation

Index

• func RecordDockerCreateDuration(duration time.Duration)
• func RecordDockerError(errorStage string, errorName string, image imageInterface.Image, err error)
• func RecordDockerGetDuration(duration time.Duration)
• func RecordDockerTotalDuration(duration time.Duration)
• func RecordEvent(event string)
• func RecordTarFileSize(fileSizeMBs int)
• type Image
  • func NewImage(directory string, pullSpec string) *Image
  • func (image *Image) DockerPullSpec() string
  • func (image *Image) DockerTarFilePath() string
• type ImageStatus
  • func (is ImageStatus) String() string
• type RegistryAuth
  • func NeedsAuthHeader(image imageInterface.Image, registries []*RegistryAuth) *RegistryAuth

Functions

func RecordDockerCreateDuration

func RecordDockerCreateDuration(duration time.Duration)

RecordDockerCreateDuration will record the Docker create duration in seconds

func RecordDockerError

func RecordDockerError(errorStage string, errorName string, image imageInterface.Image, err error)

RecordDockerError will record the Docker error messages

func RecordDockerGetDuration

func RecordDockerGetDuration(duration time.Duration)

RecordDockerGetDuration will record the Docker get duration in seconds

func RecordDockerTotalDuration

func RecordDockerTotalDuration(duration time.Duration)

RecordDockerTotalDuration will record the Docker total duration in seconds

func RecordEvent

func RecordEvent(event string)

RecordEvent will record the events that are occuring

func RecordTarFileSize

func RecordTarFileSize(fileSizeMBs int)

RecordTarFileSize will record the Tar ball size

Types

type Image

type Image struct {
	Directory string
	PullSpec  string
}

Image ...

func NewImage

func NewImage(directory string, pullSpec string) *Image

NewImage ...

func (*Image) DockerPullSpec

func (image *Image) DockerPullSpec() string

DockerPullSpec ...

func (*Image) DockerTarFilePath

func (image *Image) DockerTarFilePath() string

DockerTarFilePath ...

type ImageStatus

type ImageStatus int

ImageStatus ...

const (
	ImageStatusUnknown    ImageStatus = iota
	ImageStatusInProgress ImageStatus = iota
	ImageStatusDone       ImageStatus = iota
	ImageStatusError      ImageStatus = iota
)

...

func (ImageStatus) String

func (is ImageStatus) String() string

type RegistryAuth

type RegistryAuth struct {
	URL      string
	User     string
	Password string
}

RegistryAuth ...

func NeedsAuthHeader

func NeedsAuthHeader(image imageInterface.Image, registries []*RegistryAuth) *RegistryAuth

NeedsAuthHeader will verify the given image is required authentication credentials for pulling the Docker image. if Yes, it will return the corresponding registration auth