docker

Documentation

Index

• Constants
• func FilePathToImageName(fileName string) (imageName string, err error)
• func GetAuth(image string) string
• func GetAuthString(image, username, password string) (string, error)
• func GetClientRepoDigests(imageID string) ([]string, error)
• func GetClientRepoDigestsByRegistry(imageID string, registry string) ([]string, error)
• func GetImageTag(image string) string
• func GetNewImageName(image string, registry string) string
• func GetRepoDigest(image string) string
• func ImageToFilePath(imageName string, dir string) (fileName string, err error)
• func IsClientErrNotFound(err error) bool
• func Load(image *Image) error
• func Push(image string, creds *util.Creds) error
• func ReTag(image *Image) error
• func Save(c *hashcache.CheckSumCache, image string, dir string, creds *util.Creds) error
• func StripImageTag(image string) string
• func StripRepoDigest(image string) string
• func ValidatePublishedRepoDigestMatchesHashcache(image Image) (bool, error)
• type Image
  • func GetImages(files []string, registry string) ([]Image, error)
  • func NewImageFromFilePath(file string, registry string) (Image, error)
• type PushEvent
• type SaveEvent

Constants

const (
	ShaIdent string = "@sha256:"
	Ext      string = ".docker.tar"
)

Functions

func FilePathToImageName

func FilePathToImageName(fileName string) (imageName string, err error)

FileNameToImageName converts an archived file name back to the origonal docker image name

func GetAuth

func GetAuth(image string) string

GetAuth loads config for a given registry from the Docker config file

func GetAuthString

func GetAuthString(image, username, password string) (string, error)

GetAuthString will return a valid auth string from credentials

func GetClientRepoDigests

func GetClientRepoDigests(imageID string) ([]string, error)

func GetClientRepoDigestsByRegistry

func GetClientRepoDigestsByRegistry(imageID string, registry string) ([]string, error)

func GetImageTag

func GetImageTag(image string) string

func GetNewImageName

func GetNewImageName(image string, registry string) string

func GetRepoDigest

func GetRepoDigest(image string) string

func ImageToFilePath

func ImageToFilePath(imageName string, dir string) (fileName string, err error)

ImageToFileName provides an archived name from a docker image name

func IsClientErrNotFound

func IsClientErrNotFound(err error) bool

func Load

func Load(image *Image) error

Load a container from archive and return the image name

func Push

func Push(image string, creds *util.Creds) error

Push will push a docker image

func ReTag

func ReTag(image *Image) error

func Save

func Save(c *hashcache.CheckSumCache, image string, dir string, creds *util.Creds) error

Save will save a docker image

func StripImageTag

func StripImageTag(image string) string

func StripRepoDigest

func StripRepoDigest(image string) string

func ValidatePublishedRepoDigestMatchesHashcache

func ValidatePublishedRepoDigestMatchesHashcache(image Image) (bool, error)

Check if the docker recorded RepoDigest matches Image struct RepoDigest

Types

type Image

type Image struct {
	FileName     string
	ImageID      string
	ImageName    string
	ImageTag     string
	NewImageName string
	RepoDigest   string
}

func GetImages

func GetImages(files []string, registry string) ([]Image, error)

GetImages retrieves an image struct array

func NewImageFromFilePath

func NewImageFromFilePath(file string, registry string) (Image, error)

type PushEvent

type PushEvent struct {
	Status         string `json:"status"`
	Error          string `json:"error"`
	Progress       string `json:"progress"`
	ProgressDetail struct {
		Current int `json:"current"`
		Total   int `json:"total"`
	} `json:"progressDetail"`
	Id string `json:"id"`
}

type SaveEvent

type SaveEvent struct {
	Status         string `json:"status"`
	Error          string `json:"error"`
	Progress       string `json:"progress"`
	ProgressDetail struct {
		Current int `json:"current"`
		Total   int `json:"total"`
	} `json:"progressDetail"`
	Id string `json:"id"`
}