docker

Documentation

Index

• Variables
• type DaemonImageProvider
  • func NewProviderFromDaemon(imgStr string, tmpDirGen *file.TempDirGenerator, c client.APIClient, ...) (*DaemonImageProvider, error)
  • func (p *DaemonImageProvider) Provide(ctx context.Context, userMetadata ...image.AdditionalMetadata) (*image.Image, error)
• type LayerID
• type LayerState
• type PullPhase
• type PullStatus
  • func (p *PullStatus) Complete() bool
  • func (p *PullStatus) Current(layer LayerID) LayerState
  • func (p *PullStatus) Layers() []LayerID
• type TarballImageProvider
  • func NewProviderFromTarball(path string, tmpDirGen *file.TempDirGenerator) *TarballImageProvider
  • func (p *TarballImageProvider) Provide(_ context.Context, userMetadata ...image.AdditionalMetadata) (*image.Image, error)

Variables

var ErrMultipleManifests = fmt.Errorf("cannot process multiple docker manifests")

Types

type DaemonImageProvider

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

DaemonImageProvider is a image.Provider capable of fetching and representing a docker image from the docker daemon API.

func NewProviderFromDaemon

func NewProviderFromDaemon(imgStr string, tmpDirGen *file.TempDirGenerator, c client.APIClient, platform *image.Platform) (*DaemonImageProvider, error)

NewProviderFromDaemon creates a new provider instance for a specific image that will later be cached to the given directory.

func (*DaemonImageProvider) Provide

func (p *DaemonImageProvider) Provide(ctx context.Context, userMetadata ...image.AdditionalMetadata) (*image.Image, error)

Provide an image object that represents the cached docker image tar fetched from a docker daemon.

type LayerID

type LayerID string

type LayerState

type LayerState struct {
	Phase            PullPhase
	PhaseProgress    progress.Progressable
	DownloadProgress progress.Progressable
}

type PullPhase

type PullPhase int

const (
	UnknownPhase PullPhase = iota
	WaitingPhase
	PullingFsPhase
	DownloadingPhase
	DownloadCompletePhase
	ExtractingPhase
	VerifyingChecksumPhase
	AlreadyExistsPhase
	PullCompletePhase
)

type PullStatus

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

func (*PullStatus) Complete

func (p *PullStatus) Complete() bool

func (*PullStatus) Current

func (p *PullStatus) Current(layer LayerID) LayerState

func (*PullStatus) Layers

func (p *PullStatus) Layers() []LayerID

type TarballImageProvider

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

TarballImageProvider is a image.Provider for a docker image (V2) for an existing tar on disk (the output from a "docker image save ..." command).

func NewProviderFromTarball

func NewProviderFromTarball(path string, tmpDirGen *file.TempDirGenerator) *TarballImageProvider

NewProviderFromTarball creates a new provider instance for the specific image already at the given path.

func (*TarballImageProvider) Provide

func (p *TarballImageProvider) Provide(_ context.Context, userMetadata ...image.AdditionalMetadata) (*image.Image, error)

Provide an image object that represents the docker image tar at the configured location on disk.