docker

package

v1.0.5 Latest Latest Go to latest Published: Sep 6, 2019 License: MIT Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/appvia/artefactor

Links

Open Source Insights

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 ¶

View Source

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

Variables ¶

This section is empty.

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 ¶ added in v0.3.8

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

GetAuthString will return a valid auth string from credentials

func GetClientRepoDigests ¶ added in v1.0.2

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

func GetClientRepoDigestsByRegistry ¶ added in v1.0.2

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

func GetImageTag ¶ added in v1.0.1

func GetImageTag(image string) string

func GetNewImageName ¶ added in v0.3.3

func GetNewImageName(image string, registry string) string

func GetRepoDigest ¶ added in v1.0.1

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 ¶ added in v1.0.2

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 ¶ added in v1.0.1

func StripImageTag(image string) string

func StripRepoDigest ¶ added in v1.0.1

func StripRepoDigest(image string) string

func ValidatePublishedRepoDigestMatchesHashcache ¶ added in v1.0.2

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 ¶ added in v1.0.1

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"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL