utils

Documentation

Index

• func CheckLocalDns() bool
• func CompareKernelVersion(a, b *KernelVersionInfo) int
• func CopyDirectory(source, dest string) error
• func CopyEscapable(dst io.Writer, src io.ReadCloser) (written int64, err error)
• func Debugf(format string, a ...interface{})
• func Download(url string, stderr io.Writer) (*http.Response, error)
• func FindCgroupMountpoint(cgroupType string) (string, error)
• func GetReleaseVersion() string
• func GetTotalUsedFds() int
• func Go(f func() error) chan error
• func HashData(src io.Reader) (string, error)
• func HumanDuration(d time.Duration) string
• func HumanSize(size int64) string
• func IsGIT(str string) bool
• func IsURL(str string) bool
• func NewBufReader(r io.Reader) *bufReader
• func NewHTTPRequestError(msg string, res *http.Response) error
• func NopWriteCloser(w io.Writer) io.WriteCloser
• func ParseHost(host string, port int, addr string) string
• func ParseRepositoryTag(repos string) (string, string)
• func ProgressReader(r io.ReadCloser, size int, output io.Writer, template []byte, ...) *progressReader
• func SelfPath() string
• func Trunc(s string, maxlen int) string
• func TruncateID(id string) string
• func UserLookup(uid string) (*user.User, error)
• type JSONError
  • func (e *JSONError) Error() string
• type JSONLog
• type JSONMessage
  • func (jm *JSONMessage) Display(out io.Writer) error
• type KernelVersionInfo
  • func GetKernelVersion() (*KernelVersionInfo, error)
  • func (k *KernelVersionInfo) String() string
• type NopFlusher
  • func (f *NopFlusher) Flush()
• type NopWriter
  • func (*NopWriter) Write(buf []byte) (int, error)
• type StreamFormatter
  • func NewStreamFormatter(json bool) *StreamFormatter
  • func (sf *StreamFormatter) FormatError(err error) []byte
  • func (sf *StreamFormatter) FormatProgress(action, str string) []byte
  • func (sf *StreamFormatter) FormatStatus(format string, a ...interface{}) []byte
  • func (sf *StreamFormatter) Used() bool
• type StreamWriter
• type TarSum
  • func (ts *TarSum) Read(buf []byte) (int, error)
  • func (ts *TarSum) Sum(extra []byte) string
• type TruncIndex
  • func NewTruncIndex() *TruncIndex
  • func (idx *TruncIndex) Add(id string) error
  • func (idx *TruncIndex) Delete(id string) error
  • func (idx *TruncIndex) Get(s string) (string, error)
• type Utsname
• type WriteBroadcaster
  • func NewWriteBroadcaster() *WriteBroadcaster
  • func (w *WriteBroadcaster) AddWriter(writer io.WriteCloser, stream string)
  • func (w *WriteBroadcaster) CloseWriters() error
  • func (w *WriteBroadcaster) Write(p []byte) (n int, err error)
• type WriteFlusher
  • func NewWriteFlusher(w io.Writer) *WriteFlusher
  • func (wf *WriteFlusher) Write(b []byte) (n int, err error)

Functions

func CheckLocalDns

func CheckLocalDns() bool

func CompareKernelVersion

func CompareKernelVersion(a, b *KernelVersionInfo) int

Compare two KernelVersionInfo struct. Returns -1 if a < b, = if a == b, 1 it a > b

func CopyDirectory

func CopyDirectory(source, dest string) error

FIXME: this is deprecated by CopyWithTar in archive.go

func CopyEscapable

func CopyEscapable(dst io.Writer, src io.ReadCloser) (written int64, err error)

Code c/c from io.Copy() modified to handle escape sequence

func Debugf

func Debugf(format string, a ...interface{})

Debug function, if the debug flag is set, then display. Do nothing otherwise If Docker is in damon mode, also send the debug info on the socket

func Download

func Download(url string, stderr io.Writer) (*http.Response, error)

Request a given URL and return an io.Reader

func FindCgroupMountpoint

func FindCgroupMountpoint(cgroupType string) (string, error)

func GetReleaseVersion

func GetReleaseVersion() string

func GetTotalUsedFds

func GetTotalUsedFds() int

func Go

func Go(f func() error) chan error

Go is a basic promise implementation: it wraps calls a function in a goroutine, and returns a channel which will later return the function's return value.

func HashData

func HashData(src io.Reader) (string, error)

func HumanDuration

func HumanDuration(d time.Duration) string

HumanDuration returns a human-readable approximation of a duration (eg. "About a minute", "4 hours ago", etc.)

func HumanSize

func HumanSize(size int64) string

HumanSize returns a human-readable approximation of a size using SI standard (eg. "44kB", "17MB")

func IsGIT

func IsGIT(str string) bool

func IsURL

func IsURL(str string) bool

func NewBufReader

func NewBufReader(r io.Reader) *bufReader

func NewHTTPRequestError

func NewHTTPRequestError(msg string, res *http.Response) error

func NopWriteCloser

func NopWriteCloser(w io.Writer) io.WriteCloser

func ParseHost

func ParseHost(host string, port int, addr string) string

func ParseRepositoryTag

func ParseRepositoryTag(repos string) (string, string)

Get a repos name and returns the right reposName + tag The tag can be confusing because of a port in a repository name.

Ex: localhost.localdomain:5000/samalba/hipache:latest

func ProgressReader

func ProgressReader(r io.ReadCloser, size int, output io.Writer, template []byte, sf *StreamFormatter) *progressReader

func SelfPath

func SelfPath() string

Figure out the absolute path of our own binary

func Trunc

func Trunc(s string, maxlen int) string

func TruncateID

func TruncateID(id string) string

TruncateID returns a shorthand version of a string identifier for convenience. A collision with other shorthands is very unlikely, but possible. In case of a collision a lookup with TruncIndex.Get() will fail, and the caller will need to use a langer prefix, or the full-length Id.

func UserLookup

func UserLookup(uid string) (*user.User, error)

UserLookup check if the given username or uid is present in /etc/passwd and returns the user struct. If the username is not found, an error is returned.

Types

type JSONError

type JSONError struct {
	Code    int    `json:"code,omitempty"`
	Message string `json:"message,omitempty"`
}

func (*JSONError) Error

func (e *JSONError) Error() string

type JSONLog

type JSONLog struct {
	Log     string    `json:"log,omitempty"`
	Stream  string    `json:"stream,omitempty"`
	Created time.Time `json:"time"`
}

type JSONMessage

type JSONMessage struct {
	Status       string     `json:"status,omitempty"`
	Progress     string     `json:"progress,omitempty"`
	ErrorMessage string     `json:"error,omitempty"` //deprecated
	ID           string     `json:"id,omitempty"`
	Time         int64      `json:"time,omitempty"`
	Error        *JSONError `json:"errorDetail,omitempty"`
}

func (*JSONMessage) Display

func (jm *JSONMessage) Display(out io.Writer) error

type KernelVersionInfo

type KernelVersionInfo struct {
	Kernel int
	Major  int
	Minor  int
	Flavor string
}

func GetKernelVersion

func GetKernelVersion() (*KernelVersionInfo, error)

func (*KernelVersionInfo) String

func (k *KernelVersionInfo) String() string

type NopFlusher

type NopFlusher struct{}

func (*NopFlusher) Flush

func (f *NopFlusher) Flush()

type NopWriter

type NopWriter struct{}

func (*NopWriter) Write

func (*NopWriter) Write(buf []byte) (int, error)

type StreamFormatter

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

func NewStreamFormatter

func NewStreamFormatter(json bool) *StreamFormatter

func (*StreamFormatter) FormatError

func (sf *StreamFormatter) FormatError(err error) []byte

func (*StreamFormatter) FormatProgress

func (sf *StreamFormatter) FormatProgress(action, str string) []byte

func (*StreamFormatter) FormatStatus

func (sf *StreamFormatter) FormatStatus(format string, a ...interface{}) []byte

func (*StreamFormatter) Used

func (sf *StreamFormatter) Used() bool

type StreamWriter

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

type TarSum

type TarSum struct {
	io.Reader
	// contains filtered or unexported fields
}

func (*TarSum) Read

func (ts *TarSum) Read(buf []byte) (int, error)

func (*TarSum) Sum

func (ts *TarSum) Sum(extra []byte) string

type TruncIndex

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

TruncIndex allows the retrieval of string identifiers by any of their unique prefixes. This is used to retrieve image and container IDs by more convenient shorthand prefixes.

func NewTruncIndex

func NewTruncIndex() *TruncIndex

func (*TruncIndex) Add

func (idx *TruncIndex) Add(id string) error

func (*TruncIndex) Delete

func (idx *TruncIndex) Delete(id string) error

func (*TruncIndex) Get

func (idx *TruncIndex) Get(s string) (string, error)

type Utsname

type Utsname syscall.Utsname

type WriteBroadcaster

type WriteBroadcaster struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewWriteBroadcaster

func NewWriteBroadcaster() *WriteBroadcaster

func (*WriteBroadcaster) AddWriter

func (w *WriteBroadcaster) AddWriter(writer io.WriteCloser, stream string)

func (*WriteBroadcaster) CloseWriters

func (w *WriteBroadcaster) CloseWriters() error

func (*WriteBroadcaster) Write

func (w *WriteBroadcaster) Write(p []byte) (n int, err error)

type WriteFlusher

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

func NewWriteFlusher

func NewWriteFlusher(w io.Writer) *WriteFlusher

func (*WriteFlusher) Write

func (wf *WriteFlusher) Write(b []byte) (n int, err error)