image

Documentation

Overview

Package image implements functions for manipulating images

Index

• Constants
• func DecodeLabel(image imgutil.Image, label string, v interface{}) error
• func FromLayoutPath(parentPath string) (v1.Image, string, error)
• func GetInsecureOptions(insecureRegistries []string) []imgutil.ImageOption
• func SyncLabels(sourceImg imgutil.Image, destImage imgutil.Image, test func(string) bool) error
• type DefaultRegistryHandler
  • func NewRegistryHandler(keychain authn.Keychain, insecureRegistries []string) *DefaultRegistryHandler
  • func (rv *DefaultRegistryHandler) EnsureReadAccess(imageRefs ...string) error
  • func (rv *DefaultRegistryHandler) EnsureWriteAccess(imageRefs ...string) error
• type Handler
  • func NewHandler(docker client.CommonAPIClient, keychain authn.Keychain, layoutDir string, ...) Handler
• type LayoutHandler
  • func (h *LayoutHandler) InitImage(imageRef string) (imgutil.Image, error)
  • func (h *LayoutHandler) Kind() string
• type LocalHandler
  • func (h *LocalHandler) InitImage(imageRef string) (imgutil.Image, error)
  • func (h *LocalHandler) Kind() string
• type RegistryHandler
• type RemoteHandler
  • func (h *RemoteHandler) InitImage(imageRef string) (imgutil.Image, error)
  • func (h *RemoteHandler) Kind() string

Constants

const LayoutKind = "layout"

const LocalKind = "docker"

const RemoteKind = "remote"

Functions

func DecodeLabel

func DecodeLabel(image imgutil.Image, label string, v interface{}) error

func FromLayoutPath

func FromLayoutPath(parentPath string) (v1.Image, string, error)

FromLayoutPath takes a path to a directory (such as <layers>/extended/run) containing a single image in "sparse" OCI layout format, and returns a v1.Image along with the path of the image (such as <layers>/extended/run/sha256:<sha256>) or an error if the image cannot be loaded. The path is helpful for locating the image when we only know the digest of the config, such as for local images.

func GetInsecureOptions

func GetInsecureOptions(insecureRegistries []string) []imgutil.ImageOption

GetInsecureOptions returns a list of WithRegistrySetting imageOptions matching the specified imageRef prefix

TODO: This is a temporary solution in order to get insecure registries in other components too TODO: Ideally we should fix the `imgutil.options` struct visibility in order to mock and test the `remote.WithRegistrySetting` TODO: function correctly and use the RegistryHandler everywhere it is needed.

func SyncLabels

func SyncLabels(sourceImg imgutil.Image, destImage imgutil.Image, test func(string) bool) error

Types

type DefaultRegistryHandler

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

DefaultRegistryHandler is the struct that implements the RegistryHandler methods

func NewRegistryHandler

func NewRegistryHandler(keychain authn.Keychain, insecureRegistries []string) *DefaultRegistryHandler

NewRegistryHandler creates a new DefaultRegistryHandler

func (*DefaultRegistryHandler) EnsureReadAccess

func (rv *DefaultRegistryHandler) EnsureReadAccess(imageRefs ...string) error

EnsureReadAccess ensures that we can read from the registry

func (*DefaultRegistryHandler) EnsureWriteAccess

func (rv *DefaultRegistryHandler) EnsureWriteAccess(imageRefs ...string) error

EnsureWriteAccess ensures that we can write to the registry

type Handler

type Handler interface {
	InitImage(imageRef string) (imgutil.Image, error)
	Kind() string
}

Handler wraps initialization of an imgutil image.

imgutil: github.com/buildpacks/imgutil

func NewHandler

func NewHandler(docker client.CommonAPIClient, keychain authn.Keychain, layoutDir string, useLayout bool, insecureRegistries []string) Handler

NewHandler creates a new Handler according to the arguments provided, following these rules: - WHEN layoutDir is defined and useLayout is true then it returns a LayoutHandler - WHEN a docker client is provided then it returns a LocalHandler - WHEN an auth.Keychain is provided then it returns a RemoteHandler - Otherwise nil is returned

type LayoutHandler

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

func (*LayoutHandler) InitImage

func (h *LayoutHandler) InitImage(imageRef string) (imgutil.Image, error)

func (*LayoutHandler) Kind

func (h *LayoutHandler) Kind() string

type LocalHandler

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

func (*LocalHandler) InitImage

func (h *LocalHandler) InitImage(imageRef string) (imgutil.Image, error)

func (*LocalHandler) Kind

func (h *LocalHandler) Kind() string

type RegistryHandler

type RegistryHandler interface {
	EnsureReadAccess(imageRefs ...string) error
	EnsureWriteAccess(imageRefs ...string) error
}

RegistryHandler takes care of the registry settings and checks

type RemoteHandler

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

func (*RemoteHandler) InitImage

func (h *RemoteHandler) InitImage(imageRef string) (imgutil.Image, error)

func (*RemoteHandler) Kind

func (h *RemoteHandler) Kind() string