image

Documentation

Index

• func GenerateImageID(image v1.Image) (string, error)
• func GetImageDetails(idOrName string, platforms []*v1.Platform) (string, error)
• func GetImageLayerDirs(image *v1.Image) (res []string, err error)
• func Merge(imageName string, images []string, platform *v1.Platform) error
• type Cache
• type CacheBuilder
• type DefaultImageFileService
  • func (d DefaultImageFileService) Load(imageSrc string) error
  • func (d DefaultImageFileService) Merge(image *v1.Image) error
  • func (d DefaultImageFileService) Save(imageName, imageTar string, platforms []*v1.Platform) error
• type DefaultImageMetadataService
  • func (d DefaultImageMetadataService) DeleteImage(imageName string, platform *v1.Platform) error
  • func (d DefaultImageMetadataService) GetImage(imageName string, platform *v1.Platform) (*v1.Image, error)
  • func (d DefaultImageMetadataService) GetRemoteImage(imageName string, platform *v1.Platform) (v1.Image, error)
  • func (d DefaultImageMetadataService) List() (store.ImageMetadataMap, error)
  • func (d DefaultImageMetadataService) Tag(imageName, tarImageName string) error
• type DefaultImageService
  • func (d DefaultImageService) BuildImageCache() (Cache, error)
  • func (d DefaultImageService) Delete(imageNameOrID string, platforms []*v1.Platform) error
  • func (d DefaultImageService) GetImageByName(imageName string, platform *v1.Platform) (*v1.Image, error)
  • func (d DefaultImageService) Login(RegistryURL, RegistryUsername, RegistryPasswd string) error
  • func (d DefaultImageService) Pull(imageName string, platforms []*v1.Platform) error
  • func (d DefaultImageService) PullIfNotExist(imageName string, platforms []*v1.Platform) error
  • func (d DefaultImageService) Push(imageName string) error
• type FileService
  • func NewImageFileService() (FileService, error)
• type LayerService
• type MetadataService
  • func NewImageMetadataService() (MetadataService, error)
• type Prober
  • func NewImageProber(cacheBuilder CacheBuilder, noCache bool) Prober
• type Service
  • func NewImageService() (Service, error)

Functions

func GenerateImageID

func GenerateImageID(image v1.Image) (string, error)

func GetImageDetails

func GetImageDetails(idOrName string, platforms []*v1.Platform) (string, error)

func GetImageLayerDirs

func GetImageLayerDirs(image *v1.Image) (res []string, err error)

GetImageLayerDirs return image hash list current image is different with the image in build stage current image has no from layer

func Merge

func Merge(imageName string, images []string, platform *v1.Platform) error

Types

type Cache

type Cache interface {
	GetCache(parentID string, layer *cache.Layer) (LayerID digest.Digest, err error)
}

type CacheBuilder

type CacheBuilder interface {
	BuildImageCache() (Cache, error)
}

type DefaultImageFileService

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

func (DefaultImageFileService) Load

func (d DefaultImageFileService) Load(imageSrc string) error

func (DefaultImageFileService) Merge

func (d DefaultImageFileService) Merge(image *v1.Image) error

func (DefaultImageFileService) Save

func (d DefaultImageFileService) Save(imageName, imageTar string, platforms []*v1.Platform) error

type DefaultImageMetadataService

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

DefaultImageMetadataService provide service for image metadata operations

func (DefaultImageMetadataService) DeleteImage

func (d DefaultImageMetadataService) DeleteImage(imageName string, platform *v1.Platform) error

func (DefaultImageMetadataService) GetImage

func (d DefaultImageMetadataService) GetImage(imageName string, platform *v1.Platform) (*v1.Image, error)

GetImage will return the v1.Image locally

func (DefaultImageMetadataService) GetRemoteImage

func (d DefaultImageMetadataService) GetRemoteImage(imageName string, platform *v1.Platform) (v1.Image, error)

GetRemoteImage will return the v1.Image from remote registry

func (DefaultImageMetadataService) List

func (d DefaultImageMetadataService) List() (store.ImageMetadataMap, error)

List will list all cloud image locally

func (DefaultImageMetadataService) Tag

func (d DefaultImageMetadataService) Tag(imageName, tarImageName string) error

Tag is used to give a name for imageName

type DefaultImageService

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

DefaultImageService is the default service, which is used for image pull/push

func (DefaultImageService) BuildImageCache

func (d DefaultImageService) BuildImageCache() (Cache, error)

func (DefaultImageService) Delete

func (d DefaultImageService) Delete(imageNameOrID string, platforms []*v1.Platform) error

Delete image layer, image meta, and local registry by id or name. if only image id,will delete related image data. if image name,and not specify platform,will delete all image data. if image name and platforms is not nil will delete all the related platform images.

func (DefaultImageService) GetImageByName

func (d DefaultImageService) GetImageByName(imageName string, platform *v1.Platform) (*v1.Image, error)

func (DefaultImageService) Login

func (d DefaultImageService) Login(RegistryURL, RegistryUsername, RegistryPasswd string) error

Login into a registry, for saving auth info in ~/.docker/config.json

func (DefaultImageService) Pull

func (d DefaultImageService) Pull(imageName string, platforms []*v1.Platform) error

Pull always do pull action

func (DefaultImageService) PullIfNotExist

func (d DefaultImageService) PullIfNotExist(imageName string, platforms []*v1.Platform) error

PullIfNotExist is used to pull image if not exists locally

func (DefaultImageService) Push

func (d DefaultImageService) Push(imageName string) error

Push local image to remote registry

type FileService

type FileService interface {
	Load(imageSrc string) error
	Save(imageName, imageTar string, platforms []*v1.Platform) error
	Merge(image *v1.Image) error
}

FileService is the interface for file operations

func NewImageFileService

func NewImageFileService() (FileService, error)

type LayerService

type LayerService interface {
	LayerStore() store.LayerStore
}

type MetadataService

type MetadataService interface {
	Tag(imageName, tarImageName string) error
	List() (store.ImageMetadataMap, error)
	GetImage(imageName string, platform *v1.Platform) (*v1.Image, error)
	GetRemoteImage(imageName string, platform *v1.Platform) (v1.Image, error)
	DeleteImage(imageName string, platform *v1.Platform) error
}

MetadataService is the interface for providing image metadata service

func NewImageMetadataService

func NewImageMetadataService() (MetadataService, error)

type Prober

type Prober interface {
	Reset()
	Probe(parentID string, layer *cache.Layer) (cacheID digest.Digest, err error)
}

func NewImageProber

func NewImageProber(cacheBuilder CacheBuilder, noCache bool) Prober

type Service

type Service interface {
	Pull(imageName string, platform []*v1.Platform) error
	PullIfNotExist(imageName string, platform []*v1.Platform) error
	Push(imageName string) error
	Delete(imageName string, platforms []*v1.Platform) error
	Login(RegistryURL, RegistryUsername, RegistryPasswd string) error
	CacheBuilder
}

Service is image service

func NewImageService

func NewImageService() (Service, error)