util

Documentation

Index

• func CheckSameFile(f1name, f2name string) (bool, error)
• func CheckTar(image string) bool
• func CleanupImage(image Image)
• func GetFileContents(path string) (*string, error)
• func GetImageLayers(pathToImage string) []string
• func GetSize(path string) int64
• func IsTar(path string) bool
• func NewClient() (*client.Client, error)
• func UnTar(r io.Reader, target string) error
• type CloudPrepper
  • func (p CloudPrepper) GetConfig() (ConfigSchema, error)
  • func (p CloudPrepper) GetFileSystem() (string, error)
  • func (p CloudPrepper) GetImage() (Image, error)
  • func (p CloudPrepper) GetSource() string
  • func (p CloudPrepper) Name() string
• type ConfigObject
• type ConfigSchema
• type DaemonPrepper
  • func (p DaemonPrepper) GetConfig() (ConfigSchema, error)
  • func (p DaemonPrepper) GetFileSystem() (string, error)
  • func (p DaemonPrepper) GetHistory() []ImageHistoryItem
  • func (p DaemonPrepper) GetImage() (Image, error)
  • func (p DaemonPrepper) GetSource() string
  • func (p DaemonPrepper) Name() string
• type Directory
  • func GetDirectory(path string, deep bool) (Directory, error)
• type DirectoryEntry
  • func CreateDirectoryEntries(root string, entryNames []string) (entries []DirectoryEntry)
  • func GetDirectoryEntries(d Directory) []DirectoryEntry
• type Event
• type Image
• type ImageHistoryItem
• type Prepper
• type TarPrepper
  • func (p TarPrepper) GetConfig() (ConfigSchema, error)
  • func (p TarPrepper) GetFileSystem() (string, error)
  • func (p TarPrepper) GetImage() (Image, error)
  • func (p TarPrepper) GetSource() string
  • func (p TarPrepper) Name() string

Functions

func CheckSameFile

func CheckSameFile(f1name, f2name string) (bool, error)

func CheckTar

func CheckTar(image string) bool

func CleanupImage

func CleanupImage(image Image)

func GetFileContents

func GetFileContents(path string) (*string, error)

GetFileContents returns the contents of a file at the specified path

func GetImageLayers

func GetImageLayers(pathToImage string) []string

func GetSize

func GetSize(path string) int64

func IsTar

func IsTar(path string) bool

func NewClient

func NewClient() (*client.Client, error)

func UnTar

func UnTar(r io.Reader, target string) error

UnTar takes in a path to a tar file and writes the untarred version to the provided target. Only untars one level, does not untar nested tars.

Types

type CloudPrepper

type CloudPrepper struct {
	Source string
	Client *client.Client
	Cache  cache.Cache
}

CloudPrepper prepares images sourced from a Cloud registry

func (CloudPrepper) GetConfig

func (p CloudPrepper) GetConfig() (ConfigSchema, error)

func (CloudPrepper) GetFileSystem

func (p CloudPrepper) GetFileSystem() (string, error)

func (CloudPrepper) GetImage

func (p CloudPrepper) GetImage() (Image, error)

func (CloudPrepper) GetSource

func (p CloudPrepper) GetSource() string

func (CloudPrepper) Name

func (p CloudPrepper) Name() string

type ConfigObject

type ConfigObject struct {
	Env          []string            `json:"Env"`
	Entrypoint   []string            `json:"Entrypoint"`
	ExposedPorts map[string]struct{} `json:"ExposedPorts"`
	Cmd          []string            `json:"Cmd"`
	Volumes      map[string]struct{} `json:"Volumes"`
	Workdir      string              `json:"WorkingDir"`
}

type ConfigSchema

type ConfigSchema struct {
	Config  ConfigObject       `json:"config"`
	History []ImageHistoryItem `json:"history"`
}

type DaemonPrepper

type DaemonPrepper struct {
	Source string
	Client *client.Client
	Cache  cache.Cache
}

func (DaemonPrepper) GetConfig

func (p DaemonPrepper) GetConfig() (ConfigSchema, error)

func (DaemonPrepper) GetFileSystem

func (p DaemonPrepper) GetFileSystem() (string, error)

func (DaemonPrepper) GetHistory

func (p DaemonPrepper) GetHistory() []ImageHistoryItem

func (DaemonPrepper) GetImage

func (p DaemonPrepper) GetImage() (Image, error)

func (DaemonPrepper) GetSource

func (p DaemonPrepper) GetSource() string

func (DaemonPrepper) Name

func (p DaemonPrepper) Name() string

type Directory

type Directory struct {
	Root    string
	Content []string
}

Directory stores a representation of a file directory.

func GetDirectory

func GetDirectory(path string, deep bool) (Directory, error)

GetDirectoryContents converts the directory starting at the provided path into a Directory struct.

type DirectoryEntry

type DirectoryEntry struct {
	Name string
	Size int64
}

func CreateDirectoryEntries

func CreateDirectoryEntries(root string, entryNames []string) (entries []DirectoryEntry)

func GetDirectoryEntries

func GetDirectoryEntries(d Directory) []DirectoryEntry

type Event

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

type Image

type Image struct {
	Source string
	FSPath string
	Config ConfigSchema
}

type ImageHistoryItem

type ImageHistoryItem struct {
	CreatedBy string `json:"created_by"`
}

type Prepper

type Prepper interface {
	Name() string
	GetConfig() (ConfigSchema, error)
	GetFileSystem() (string, error)
	GetImage() (Image, error)
	GetSource() string
}

type TarPrepper

type TarPrepper struct {
	Source string
	Client *client.Client
	Cache  cache.Cache
}

func (TarPrepper) GetConfig

func (p TarPrepper) GetConfig() (ConfigSchema, error)

func (TarPrepper) GetFileSystem

func (p TarPrepper) GetFileSystem() (string, error)

func (TarPrepper) GetImage

func (p TarPrepper) GetImage() (Image, error)

func (TarPrepper) GetSource

func (p TarPrepper) GetSource() string

func (TarPrepper) Name

func (p TarPrepper) Name() string