docker – github.com/docker/docker Index | Files | Directories

package docker

import "github.com/docker/docker"

Index

Constants 

const (
	ChangeModify = iota
	ChangeAdd
	ChangeDelete
)
const DEFAULT_TAG = "latest"
const LxcTemplate = "" /* 2660 byte string literal not displayed */

const REGISTRY_ENDPOINT = auth.REGISTRY_SERVER + "/v1"

FIXME: Set the endpoint in a conf file or via commandline const REGISTRY_ENDPOINT = "http://registry-creack.dotcloud.com/v1" 

const VERSION = "0.1.0"

Variables 

var LxcTemplateCompiled *template.Template

Functions

func CmdStream 

func CmdStream(cmd *exec.Cmd) (io.Reader, error)

func ComputeId 

func ComputeId(content io.Reader) (string, error)

ComputeId reads from `content` until EOF, then returns a SHA of what it read, as a string.

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 GenerateId 

func GenerateId() string

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 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 MountAUFS 

func MountAUFS(ro []string, rw string, target string) error

func Mounted 

func Mounted(mountpoint string) (bool, error)

func NopWriteCloser 

func NopWriteCloser(w io.Writer) io.WriteCloser

func ProgressReader 

func ProgressReader(r io.ReadCloser, size int, output io.Writer) *progressReader

func SelfPath 

func SelfPath() string

Figure out the absolute path of our own binary

func StoreImage 

func StoreImage(img *Image, layerData Archive, root string) error

func SysInit 

func SysInit()

Sys Init code This code is run INSIDE the container and is responsible for setting up the environment before running the actual process

func Tar 

func Tar(path string, compression Compression) (io.Reader, error)

func Trunc 

func Trunc(s string, maxlen int) string

func Unmount 

func Unmount(target string) error

func Untar 

func Untar(archive io.Reader, path string) error

func ValidateId 

func ValidateId(id string) error

Types

type Archive 

type Archive io.Reader

type Change 

type Change struct {
	Path string
	Kind ChangeType
}

func Changes 

func Changes(layers []string, rw string) ([]Change, error)

func (*Change) String 

func (change *Change) String() string

type ChangeType 

type ChangeType int

type Compression 

type Compression uint32
const (
	Uncompressed Compression = iota
	Bzip2
	Gzip
)

func (*Compression) Flag 

func (compression *Compression) Flag() string

type Config 

type Config struct {
	Hostname   string
	User       string
	Memory     int64 // Memory limit (in bytes)
	MemorySwap int64 // Total memory usage (memory + swap); set `-1' to disable swap
	Detach     bool
	Ports      []int
	Tty        bool // Attach standard streams to a tty, including stdin if it is not closed.
	OpenStdin  bool // Open stdin
	Env        []string
	Cmd        []string
	Image      string // Name of the image as it was passed by the operator (eg. could be symbolic)
}

func ParseRun 

func ParseRun(args []string) (*Config, error)

type Container 

type Container struct {
	Id string

	Created time.Time

	Path string
	Args []string

	Config *Config
	State  State
	Image  string

	NetworkSettings *NetworkSettings

	SysInitPath string
	// contains filtered or unexported fields
}

func (*Container) Changes 

func (container *Container) Changes() ([]Change, error)

func (*Container) Cmd 

func (container *Container) Cmd() *exec.Cmd

func (*Container) EnsureMounted 

func (container *Container) EnsureMounted() error

func (*Container) Export 

func (container *Container) Export() (Archive, error)

func (*Container) ExportRw 

func (container *Container) ExportRw() (Archive, error)

func (*Container) FromDisk 

func (container *Container) FromDisk() error

func (*Container) GetImage 

func (container *Container) GetImage() (*Image, error)

func (*Container) Kill 

func (container *Container) Kill() error

func (*Container) Mount 

func (container *Container) Mount() error

func (*Container) Mounted 

func (container *Container) Mounted() (bool, error)

func (*Container) Output 

func (container *Container) Output() (output []byte, err error)

func (*Container) ReadLog 

func (container *Container) ReadLog(name string) (io.Reader, error)

func (*Container) Restart 

func (container *Container) Restart() error

func (*Container) RootfsPath 

func (container *Container) RootfsPath() string

This method must be exported to be used from the lxc template

func (*Container) Run 

func (container *Container) Run() error

func (*Container) Start 

func (container *Container) Start() error

func (*Container) StderrPipe 

func (container *Container) StderrPipe() (io.ReadCloser, error)

func (*Container) StdinPipe 

func (container *Container) StdinPipe() (io.WriteCloser, error)

StdinPipe() returns a pipe connected to the standard input of the container's active process.

func (*Container) StdoutPipe 

func (container *Container) StdoutPipe() (io.ReadCloser, error)

func (*Container) Stop 

func (container *Container) Stop() error

func (*Container) ToDisk 

func (container *Container) ToDisk() (err error)

func (*Container) Unmount 

func (container *Container) Unmount() error

func (*Container) Wait 

func (container *Container) Wait() int

Wait blocks until the container stops running, then returns its exit code.

func (*Container) WaitTimeout 

func (container *Container) WaitTimeout(timeout time.Duration) error

func (*Container) When 

func (container *Container) When() time.Time

type Graph 

type Graph struct {
	Root string
}

func NewGraph 

func NewGraph(root string) (*Graph, error)

func (*Graph) All 

func (graph *Graph) All() ([]*Image, error)

func (*Graph) ByParent 

func (graph *Graph) ByParent() (map[string][]*Image, error)

func (*Graph) Create 

func (graph *Graph) Create(layerData Archive, container *Container, comment string) (*Image, error)

func (*Graph) Delete 

func (graph *Graph) Delete(id string) error

func (*Graph) Exists 

func (graph *Graph) Exists(id string) bool

func (*Graph) Garbage 

func (graph *Graph) Garbage() (*Graph, error)

func (*Graph) GarbageCollect 

func (graph *Graph) GarbageCollect() error

func (*Graph) Get 

func (graph *Graph) Get(id string) (*Image, error)

func (*Graph) Heads 

func (graph *Graph) Heads() (map[string]*Image, error)

func (*Graph) LookupRemoteImage 

func (graph *Graph) LookupRemoteImage(imgId string, authConfig *auth.AuthConfig) bool

Check if an image exists in the Registry

func (*Graph) LookupRemoteRepository 

func (graph *Graph) LookupRemoteRepository(remote string, authConfig *auth.AuthConfig) bool

func (*Graph) Map 

func (graph *Graph) Map() (map[string]*Image, error)

func (*Graph) Mktemp 

func (graph *Graph) Mktemp(id string) (string, error)

func (*Graph) PullImage 

func (graph *Graph) PullImage(imgId string, authConfig *auth.AuthConfig) error

func (*Graph) PullRepository 

func (graph *Graph) PullRepository(stdout io.Writer, remote, askedTag string, repositories *TagStore, authConfig *auth.AuthConfig) error

FIXME: Handle the askedTag parameter

func (*Graph) PushImage 

func (graph *Graph) PushImage(stdout io.Writer, imgOrig *Image, authConfig *auth.AuthConfig) error

Push a local image to the registry with its history if needed

func (*Graph) PushRepository 

func (graph *Graph) PushRepository(stdout io.Writer, remote string, localRepo Repository, authConfig *auth.AuthConfig) error

Push a repository to the registry. Remote has the format '<user>/<repo>

func (*Graph) Register 

func (graph *Graph) Register(layerData Archive, img *Image) error

func (*Graph) Undelete 

func (graph *Graph) Undelete(id string) error

func (*Graph) WalkAll 

func (graph *Graph) WalkAll(handler func(*Image)) error

type History 

type History []*Container

func (*History) Add 

func (history *History) Add(container *Container)

func (*History) Len 

func (history *History) Len() int

func (*History) Less 

func (history *History) Less(i, j int) bool

func (*History) Swap 

func (history *History) Swap(i, j int)

type IPAllocator 

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

IP allocator: Atomatically allocate and release networking ports

func (*IPAllocator) Acquire 

func (alloc *IPAllocator) Acquire() (net.IP, error)

func (*IPAllocator) Release 

func (alloc *IPAllocator) Release(ip net.IP) error

type Image 

type Image struct {
	Id              string    `json:"id"`
	Parent          string    `json:"parent,omitempty"`
	Comment         string    `json:"comment,omitempty"`
	Created         time.Time `json:"created"`
	Container       string    `json:"container,omitempty"`
	ContainerConfig Config    `json:"container_config,omitempty"`
	// contains filtered or unexported fields
}

func LoadImage 

func LoadImage(root string) (*Image, error)

func NewImgJson 

func NewImgJson(src []byte) (*Image, error)

Build an Image object from raw json data

func NewMultipleImgJson 

func NewMultipleImgJson(src []byte) ([]*Image, error)

Build an Image object list from a raw json data FIXME: Do this in "stream" mode

func (*Image) Changes 

func (image *Image) Changes(rw string) ([]Change, error)

func (*Image) GetParent 

func (img *Image) GetParent() (*Image, error)

func (*Image) History 

func (img *Image) History() ([]*Image, error)

Image includes convenience proxy functions to its graph These functions will return an error if the image is not registered (ie. if image.graph == nil)

func (*Image) Mount 

func (image *Image) Mount(root, rw string) error

func (*Image) WalkHistory 

func (img *Image) WalkHistory(handler func(*Image) error) (err error)

type ListOpts 

type ListOpts []string

ListOpts type

func (*ListOpts) Set 

func (opts *ListOpts) Set(value string) error

func (*ListOpts) String 

func (opts *ListOpts) String() string

type NetworkInterface 

type NetworkInterface struct {
	IPNet   net.IPNet
	Gateway net.IP
	// contains filtered or unexported fields
}

Network interface represents the networking stack of a container

func (*NetworkInterface) AllocatePort 

func (iface *NetworkInterface) AllocatePort(port int) (int, error)

Allocate an external TCP port and map it to the interface

func (*NetworkInterface) Release 

func (iface *NetworkInterface) Release() error

Release: Network cleanup - release all resources

type NetworkManager 

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

Network Manager manages a set of network interfaces Only *one* manager per host machine should be used

func (*NetworkManager) Allocate 

func (manager *NetworkManager) Allocate() (*NetworkInterface, error)

Allocate a network interface

type NetworkSettings 

type NetworkSettings struct {
	IpAddress   string
	IpPrefixLen int
	Gateway     string
	PortMapping map[string]string
}

type PortAllocator 

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

Port allocator: Atomatically allocate and release networking ports

func (*PortAllocator) Acquire 

func (alloc *PortAllocator) Acquire() (int, error)

func (*PortAllocator) Release 

func (alloc *PortAllocator) Release(port int) error

type PortMapper 

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

Port mapper takes care of mapping external ports to containers by setting up iptables rules. It keeps track of all mappings and is able to unmap at will

func (*PortMapper) Map 

func (mapper *PortMapper) Map(port int, dest net.TCPAddr) error

func (*PortMapper) Unmap 

func (mapper *PortMapper) Unmap(port int) error

type Repository 

type Repository map[string]string

type Runtime 

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

func NewRuntime 

func NewRuntime() (*Runtime, error)

func NewRuntimeFromDirectory 

func NewRuntimeFromDirectory(root string) (*Runtime, error)

func (*Runtime) Commit 

func (runtime *Runtime) Commit(id, repository, tag string) (*Image, error)

Commit creates a new filesystem image from the current state of a container. The image can optionally be tagged into a repository

func (*Runtime) Create 

func (runtime *Runtime) Create(config *Config) (*Container, error)

func (*Runtime) Destroy 

func (runtime *Runtime) Destroy(container *Container) error

func (*Runtime) Exists 

func (runtime *Runtime) Exists(id string) bool

func (*Runtime) Get 

func (runtime *Runtime) Get(id string) *Container

func (*Runtime) List 

func (runtime *Runtime) List() []*Container

func (*Runtime) Load 

func (runtime *Runtime) Load(id string) (*Container, error)

func (*Runtime) LogToDisk 

func (runtime *Runtime) LogToDisk(src *writeBroadcaster, dst string) error

func (*Runtime) Register 

func (runtime *Runtime) Register(container *Container) error

Register makes a container object usable by the runtime as <container.Id>

type Server 

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

func NewServer 

func NewServer() (*Server, error)

func (*Server) CmdAttach 

func (srv *Server) CmdAttach(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdCommit 

func (srv *Server) CmdCommit(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdDiff 

func (srv *Server) CmdDiff(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdExport 

func (srv *Server) CmdExport(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdHistory 

func (srv *Server) CmdHistory(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdImages 

func (srv *Server) CmdImages(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdImport 

func (srv *Server) CmdImport(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdInfo 

func (srv *Server) CmdInfo(stdin io.ReadCloser, stdout io.Writer, args ...string) error

'docker info': display system-wide information.

func (*Server) CmdInspect 

func (srv *Server) CmdInspect(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdKill 

func (srv *Server) CmdKill(stdin io.ReadCloser, stdout io.Writer, args ...string) error

'docker kill NAME' kills a running container

func (*Server) CmdLogin 

func (srv *Server) CmdLogin(stdin io.ReadCloser, stdout io.Writer, args ...string) error

'docker login': login / register a user to registry service.

func (*Server) CmdLogs 

func (srv *Server) CmdLogs(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdPort 

func (srv *Server) CmdPort(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdPs 

func (srv *Server) CmdPs(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdPull 

func (srv *Server) CmdPull(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdPush 

func (srv *Server) CmdPush(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdRestart 

func (srv *Server) CmdRestart(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdRm 

func (srv *Server) CmdRm(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdRmi 

func (srv *Server) CmdRmi(stdin io.ReadCloser, stdout io.Writer, args ...string) (err error)

'docker rmi NAME' removes all images with the name NAME

func (*Server) CmdRun 

func (srv *Server) CmdRun(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdStart 

func (srv *Server) CmdStart(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdStop 

func (srv *Server) CmdStop(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdTag 

func (srv *Server) CmdTag(stdin io.ReadCloser, stdout io.Writer, args ...string) error

func (*Server) CmdVersion 

func (srv *Server) CmdVersion(stdin io.ReadCloser, stdout io.Writer, args ...string) error

'docker version': show version information

func (*Server) CmdWait 

func (srv *Server) CmdWait(stdin io.ReadCloser, stdout io.Writer, args ...string) error

'docker wait': block until a container stops

func (*Server) Help 

func (srv *Server) Help() string

FIXME: Stop violating DRY by repeating usage here and in Subcmd declarations

func (*Server) Name 

func (srv *Server) Name() string

type State 

type State struct {
	Running   bool
	Pid       int
	ExitCode  int
	StartedAt time.Time
	// contains filtered or unexported fields
}

func (*State) String 

func (s *State) String() string

String returns a human-readable description of the state

type TagStore 

type TagStore struct {
	Repositories map[string]Repository
	// contains filtered or unexported fields
}

func NewTagStore 

func NewTagStore(path string, graph *Graph) (*TagStore, error)

func (*TagStore) ById 

func (store *TagStore) ById() map[string][]string

Return a reverse-lookup table of all the names which refer to each image Eg. {"43b5f19b10584": {"base:latest", "base:v1"}}

func (*TagStore) Get 

func (store *TagStore) Get(repoName string) (Repository, error)

func (*TagStore) GetImage 

func (store *TagStore) GetImage(repoName, tag string) (*Image, error)

func (*TagStore) ImageName 

func (store *TagStore) ImageName(id string) string

func (*TagStore) LookupImage 

func (store *TagStore) LookupImage(name string) (*Image, error)

func (*TagStore) Reload 

func (store *TagStore) Reload() error

func (*TagStore) Save 

func (store *TagStore) Save() error

func (*TagStore) Set 

func (store *TagStore) Set(repoName, tag, imageName string, force bool) error

Source Files

archive.go changes.go commands.go container.go graph.go image.go lxc_template.go mount.go network.go registry.go runtime.go state.go sysinit.go tags.go utils.go

Directories

PathSynopsis
auth
docker
rcli
term
Version
v0.1.0
Published
Mar 24, 2013
Platform
js/wasm
Imports
32 packages
Last checked
1 second ago –

Tools for package owners.