utils

Documentation

Index

• Constants
• Variables
• func CompareDockerName(a, b string) bool
• func DetectRequirement() error
• func DockerBuild(name, tag, buildRoot string) error
• func DockerCheckTagExists(shortName, tag string, credential *DockerCredential) (bool, error)
• func DockerFindLatestTag(imageInfo *DockerImageInfo, credential *DockerCredential) (string, error)
• func DockerImageExistsOnLocal(fullname string) (bool, error)
• func DockerLogin(host, username, password string) error
• func DockerPull(fullname string) error
• func DockerPush(name, tag, buildRoot string, platforms []string) error
• func DockerRMI(name, tag string) error
• func DockerTryRMI(name, tag string) error
• func Error(err error)
• func Fatal(err error)
• func FormatDockerName(name string) string
• func FullVersion() string
• func Info(msg string, args ...interface{})
• func Info2(msg string, args ...interface{})
• func ResolveDir(rootDir, path string) string
• func RetryWithFixedDelay(delay time.Duration, retries int, f func() error) error
• func RunShellCommand(command string) error
• func Success(msg string, args ...interface{})
• func Warn(msg string, args ...interface{})
• type DockerCredential
• type DockerImageInfo
  • func ExtractDockerImageInfo(fullnameWithTag string) (*DockerImageInfo, error)
  • func ExtractParentImageFromDockerfile(filename string) (*DockerImageInfo, error)
• type StringSet
  • func (s StringSet) Add(value string)
  • func (s StringSet) Exists(value string) bool
  • func (s StringSet) Remove(value string)

Constants

const (
	DefaultRegistryName = "dockerhub"
	DefaultRegistry     = "https://registry.hub.docker.com"
)

Default values

Variables

var (
	// Version returns doriath version
	Version = "dev"
	// Commit returns doriath build commit
	Commit = "unknown"
)

Functions

func CompareDockerName

func CompareDockerName(a, b string) bool

CompareDockerName compares 2 docker image names

func DetectRequirement

func DetectRequirement() error

DetectRequirement detects requirement for doriath

func DockerBuild

func DockerBuild(name, tag, buildRoot string) error

DockerBuild builds a docker image

func DockerCheckTagExists

func DockerCheckTagExists(shortName, tag string, credential *DockerCredential) (bool, error)

DockerCheckTagExists checks if a tag exists on registry or not

func DockerFindLatestTag

func DockerFindLatestTag(imageInfo *DockerImageInfo, credential *DockerCredential) (string, error)

DockerFindLatestTag .

func DockerImageExistsOnLocal

func DockerImageExistsOnLocal(fullname string) (bool, error)

DockerImageExistsOnLocal .

func DockerLogin

func DockerLogin(host, username, password string) error

DockerLogin logins to docker registry

func DockerPull

func DockerPull(fullname string) error

DockerPull .

func DockerPush

func DockerPush(name, tag, buildRoot string, platforms []string) error

DockerPush pushes a docker image

func DockerRMI

func DockerRMI(name, tag string) error

DockerRMI removes a docker image

func DockerTryRMI

func DockerTryRMI(name, tag string) error

DockerTryRMI removes a docker image if exists, and will retry if necessary

func Error

func Error(err error)

Error .

func Fatal

func Fatal(err error)

Fatal .

func FormatDockerName

func FormatDockerName(name string) string

FormatDockerName adds library/ if possible

func FullVersion

func FullVersion() string

func Info

func Info(msg string, args ...interface{})

Info .

func Info2

func Info2(msg string, args ...interface{})

Info2 .

func ResolveDir

func ResolveDir(rootDir, path string) string

ResolveDir appends a path to a rootDir

func RetryWithFixedDelay

func RetryWithFixedDelay(delay time.Duration, retries int, f func() error) error

RetryWithFixedDelay .

func RunShellCommand

func RunShellCommand(command string) error

RunShellCommand runs a command under bash shell

func Success

func Success(msg string, args ...interface{})

Success .

func Warn

func Warn(msg string, args ...interface{})

Warn .

Types

type DockerCredential

type DockerCredential struct {
	Registry      string
	Username      string
	Password      string
	HTTPToken     string
	ChallengeType string
}

DockerCredential holds credential information for a docker registry request

type DockerImageInfo

type DockerImageInfo struct {
	FullName     string
	ShortName    string
	RegistryName string
	Tag          string
}

DockerImageInfo stores common information for dockerfile

func ExtractDockerImageInfo

func ExtractDockerImageInfo(fullnameWithTag string) (*DockerImageInfo, error)

ExtractDockerImageInfo extracts docker image info

func ExtractParentImageFromDockerfile

func ExtractParentImageFromDockerfile(filename string) (*DockerImageInfo, error)

ExtractParentImageFromDockerfile extracs image information from dockerfile

type StringSet

type StringSet map[string]struct{}

StringSet is a set of string

func (StringSet) Add

func (s StringSet) Add(value string)

Add adds a value to the string set

func (StringSet) Exists

func (s StringSet) Exists(value string) bool

Exists checks if the string set contains a value or not

func (StringSet) Remove

func (s StringSet) Remove(value string)

Remove removes a value from the string set