image

Documentation

Index

• func CreateExportCommand(version string, profile string, images []string) (*exec.Cmd, error)
• func GetOpenShiftImageNames(version string) []string
• type Annotations
• type ImageCacheConfig
• type ImageHandler
• type ImageMissStrategy
• type Index
• type Manifest
• type Manifests
• type OciImageHandler
  • func NewLocalOnlyOciImageHandler() (*OciImageHandler, error)
  • func NewOciImageHandler(driver drivers.Driver, dockerEnv map[string]string) (*OciImageHandler, error)
  • func (handler *OciImageHandler) AreImagesCached(config *ImageCacheConfig) bool
  • func (handler *OciImageHandler) ExportImages(config *ImageCacheConfig, overwrite bool) ([]string, error)
  • func (handler *OciImageHandler) GetCachedImages(config *ImageCacheConfig) map[string]bool
  • func (handler *OciImageHandler) GetDockerImages() (map[string]bool, error)
  • func (handler *OciImageHandler) ImportImages(config *ImageCacheConfig) ([]string, error)
  • func (handler *OciImageHandler) IsImageCached(config *ImageCacheConfig, image string) bool
  • func (handler *OciImageHandler) PruneImages(config *ImageCacheConfig) ([]string, error)
• type Platform
• type ProgressStatus
  • func (ps ProgressStatus) String() string
• type SchemaVersion

Functions

func CreateExportCommand

func CreateExportCommand(version string, profile string, images []string) (*exec.Cmd, error)

func GetOpenShiftImageNames

func GetOpenShiftImageNames(version string) []string

GetOpenShiftImageNames returns the full images names for the images requires for a fully functioning OpenShift instance

Types

type Annotations

type Annotations struct {
	Name string `json:"org.opencontainers.image.ref.name"`
}

type ImageCacheConfig

type ImageCacheConfig struct {
	HostCacheDir      string
	CachedImages      []string
	Out               io.Writer
	ImageMissStrategy ImageMissStrategy
}

type ImageHandler

type ImageHandler interface {
	// ImportImages imports cached images from the host into the Docker daemon of the VM.
	// The method returns the list of successfully imported images and an error if one occurred.
	ImportImages(config *ImageCacheConfig) ([]string, error)

	// ExportImages exports the images specified as part of the ImageCacheConfig from the VM to the host.
	// The method returns the list of successfully exported images and an error if one occurred.
	ExportImages(config *ImageCacheConfig, overwrite bool) ([]string, error)

	// IsImageCached returns true if the specified image is cached, false otherwise.
	IsImageCached(config *ImageCacheConfig, image string) bool

	// AreImagesCached returns true if all images specified in the config are cached, false otherwise.
	AreImagesCached(config *ImageCacheConfig) bool

	// GetCachedImages returns a map of cached image names. A map is used to make lookup for a specific image easier.
	GetCachedImages(config *ImageCacheConfig) map[string]bool

	// GetDockerImages returns a map of images available in the Docker daemon. A map is used to make lookup for a specific image easier.
	GetDockerImages() (map[string]bool, error)
}

ImageHandler is responsible for the import and export of images into the Docker daemon of the VM

type ImageMissStrategy

type ImageMissStrategy int

const (
	Skip ImageMissStrategy = iota
	Pull
)

type Index

type Index struct {
	Manifests     Manifests     `json:"manifests"`
	SchemaVersion SchemaVersion `json:"schemaVersion"`
}

type Manifest

type Manifest struct {
	Annotations Annotations `json:"annotations"`
	Digest      string      `json:"digest"`
	MediaType   string      `json:"mediaType"`
	Platform    Platform    `json:"platform"`
	Size        int64       `json:"size"`
}

type Manifests

type Manifests []Manifest

type OciImageHandler

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

OciImageHandler is an ImageHandler implementation using OCI format to maintain the local cache.

func NewLocalOnlyOciImageHandler

func NewLocalOnlyOciImageHandler() (*OciImageHandler, error)

NewLocalOnlyOciImageHandler creates a new ImageHandler which can only interact with the local cache. No connection information to the Docker daemon are provided. Functions interacting with the Docker daemon will fail.

func NewOciImageHandler

func NewOciImageHandler(driver drivers.Driver, dockerEnv map[string]string) (*OciImageHandler, error)

NewOciImageHandler creates a new ImageHandler which stores cached images in OCI format. It takes a reference to a Driver in order to communicate with the VM and Docker and a map containing the environment settings for the Minishift Docker daemon.

func (*OciImageHandler) AreImagesCached

func (handler *OciImageHandler) AreImagesCached(config *ImageCacheConfig) bool

AreImagesCached returns true if all images specified in the config are cached, false otherwise.

func (*OciImageHandler) ExportImages

func (handler *OciImageHandler) ExportImages(config *ImageCacheConfig, overwrite bool) ([]string, error)

ExportImages exports the images specified as part of the ImageCacheConfig from the VM to the host.

func (*OciImageHandler) GetCachedImages

func (handler *OciImageHandler) GetCachedImages(config *ImageCacheConfig) map[string]bool

func (*OciImageHandler) GetDockerImages

func (handler *OciImageHandler) GetDockerImages() (map[string]bool, error)

func (*OciImageHandler) ImportImages

func (handler *OciImageHandler) ImportImages(config *ImageCacheConfig) ([]string, error)

ImportImages imports cached images from the host into the Docker daemon of the VM.

func (*OciImageHandler) IsImageCached

func (handler *OciImageHandler) IsImageCached(config *ImageCacheConfig, image string) bool

IsImageCached returns true if the specified image is cached, false otherwise.

func (*OciImageHandler) PruneImages

func (handler *OciImageHandler) PruneImages(config *ImageCacheConfig) ([]string, error)

PruneImages delete the specified as command line option.

type Platform

type Platform struct {
	Architecture string `json:"architecture"`
	Os           string `json:"os"`
}

type ProgressStatus

type ProgressStatus int

ProgressStatus defines a status code for import/export operations.

const (
	OK ProgressStatus = iota
	FAIL
	CACHE_MISS
)

func (ProgressStatus) String

func (ps ProgressStatus) String() string

type SchemaVersion

type SchemaVersion int