docker

package module
v0.5.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 9, 2013 License: Apache-2.0 Imports: 42 Imported by: 0

README

Docker: the Linux container engine

Docker is an open-source engine which automates the deployment of applications as highly portable, self-sufficient containers.

Docker containers are both hardware-agnostic and platform-agnostic. This means that they can run anywhere, from your laptop to the largest EC2 compute instance and everything in between - and they don't require that you use a particular language, framework or packaging system. That makes them great building blocks for deploying and scaling web apps, databases and backend services without depending on a particular stack or provider.

Docker is an open-source implementation of the deployment engine which powers dotCloud, a popular Platform-as-a-Service. It benefits directly from the experience accumulated over several years of large-scale operation and support of hundreds of thousands of applications and databases.

Docker L

Better than VMs

A common method for distributing applications and sandbox their execution is to use virtual machines, or VMs. Typical VM formats are VMWare's vmdk, Oracle Virtualbox's vdi, and Amazon EC2's ami. In theory these formats should allow every developer to automatically package their application into a "machine" for easy distribution and deployment. In practice, that almost never happens, for a few reasons:

  • Size: VMs are very large which makes them impractical to store and transfer.
  • Performance: running VMs consumes significant CPU and memory, which makes them impractical in many scenarios, for example local development of multi-tier applications, and large-scale deployment of cpu and memory-intensive applications on large numbers of machines.
  • Portability: competing VM environments don't play well with each other. Although conversion tools do exist, they are limited and add even more overhead.
  • Hardware-centric: VMs were designed with machine operators in mind, not software developers. As a result, they offer very limited tooling for what developers need most: building, testing and running their software. For example, VMs offer no facilities for application versioning, monitoring, configuration, logging or service discovery.

By contrast, Docker relies on a different sandboxing method known as containerization. Unlike traditional virtualization, containerization takes place at the kernel level. Most modern operating system kernels now support the primitives necessary for containerization, including Linux with openvz, vserver and more recently lxc, Solaris with zones and FreeBSD with Jails.

Docker builds on top of these low-level primitives to offer developers a portable format and runtime environment that solves all 4 problems. Docker containers are small (and their transfer can be optimized with layers), they have basically zero memory and cpu overhead, they are completely portable and are designed from the ground up with an application-centric design.

The best part: because docker operates at the OS level, it can still be run inside a VM!

Plays well with others

Docker does not require that you buy into a particular programming language, framework, packaging system or configuration language.

Is your application a Unix process? Does it use files, tcp connections, environment variables, standard Unix streams and command-line arguments as inputs and outputs? Then docker can run it.

Can your application's build be expressed as a sequence of such commands? Then docker can build it.

Escape dependency hell

A common problem for developers is the difficulty of managing all their application's dependencies in a simple and automated way.

This is usually difficult for several reasons:

  • Cross-platform dependencies. Modern applications often depend on a combination of system libraries and binaries, language-specific packages, framework-specific modules, internal components developed for another project, etc. These dependencies live in different "worlds" and require different tools - these tools typically don't work well with each other, requiring awkward custom integrations.

  • Conflicting dependencies. Different applications may depend on different versions of the same dependency. Packaging tools handle these situations with various degrees of ease - but they all handle them in different and incompatible ways, which again forces the developer to do extra work.

  • Custom dependencies. A developer may need to prepare a custom version of their application's dependency. Some packaging systems can handle custom versions of a dependency, others can't - and all of them handle it differently.

Docker solves dependency hell by giving the developer a simple way to express all their application's dependencies in one place, and streamline the process of assembling them. If this makes you think of XKCD 927, don't worry. Docker doesn't replace your favorite packaging systems. It simply orchestrates their use in a simple and repeatable way. How does it do that? With layers.

Docker defines a build as running a sequence of Unix commands, one after the other, in the same container. Build commands modify the contents of the container (usually by installing new files on the filesystem), the next command modifies it some more, etc. Since each build command inherits the result of the previous commands, the order in which the commands are executed expresses dependencies.

Here's a typical Docker build process:

from ubuntu:12.10
run apt-get update
run DEBIAN_FRONTEND=noninteractive apt-get install -q -y python
run DEBIAN_FRONTEND=noninteractive apt-get install -q -y python-pip
run pip install django
run DEBIAN_FRONTEND=noninteractive apt-get install -q -y curl
run curl -L https://github.com/shykes/helloflask/archive/master.tar.gz | tar -xzv
run cd helloflask-master && pip install -r requirements.txt

Note that Docker doesn't care how dependencies are built - as long as they can be built by running a Unix command in a container.

Install instructions

Quick install on Ubuntu 12.04 and 12.10

curl get.docker.io | sudo sh -x

Binary installs

Docker supports the following binary installation methods. Note that some methods are community contributions and not yet officially supported.

Installing from source

  1. Make sure you have a Go language compiler >= 1.1 and git installed.

  2. Checkout the source code

    git clone http://github.com/dotcloud/docker

  3. Build the docker binary

    cd docker
make VERBOSE=1
sudo cp ./bin/docker /usr/local/bin/docker

Usage examples

First run the docker daemon

All the examples assume your machine is running the docker daemon. To run the docker daemon in the background, simply type:

# On a production system you want this running in an init script
sudo docker -d &

Now you can run docker in client mode: all commands will be forwarded to the docker daemon, so the client can run from any account.

# Now you can run docker commands from any account.
docker help

Throwaway shell in a base Ubuntu image

docker pull ubuntu:12.10

# Run an interactive shell, allocate a tty, attach stdin and stdout
# To detach the tty without exiting the shell, use the escape sequence Ctrl-p + Ctrl-q
docker run -i -t ubuntu:12.10 /bin/bash

Starting a long-running worker process

# Start a very useful long-running process
JOB=$(docker run -d ubuntu /bin/sh -c "while true; do echo Hello world; sleep 1; done")

# Collect the output of the job so far
docker logs $JOB

# Kill the job
docker kill $JOB

Running an irc bouncer

BOUNCER_ID=$(docker run -d -p 6667 -u irc shykes/znc zncrun $USER $PASSWORD)
echo "Configure your irc client to connect to port $(docker port $BOUNCER_ID 6667) of this machine"

Running Redis

REDIS_ID=$(docker run -d -p 6379 shykes/redis redis-server)
echo "Configure your redis client to connect to port $(docker port $REDIS_ID 6379) of this machine"

Share your own image!

CONTAINER=$(docker run -d ubuntu:12.10 apt-get install -y curl)
docker commit -m "Installed curl" $CONTAINER $USER/betterbase
docker push $USER/betterbase

A list of publicly available images is available here.

Expose a service on a TCP port

# Expose port 4444 of this container, and tell netcat to listen on it
JOB=$(docker run -d -p 4444 base /bin/nc -l -p 4444)

# Which public port is NATed to my container?
PORT=$(docker port $JOB 4444)

# Connect to the public port via the host's public address
# Please note that because of how routing works connecting to localhost or 127.0.0.1 $PORT will not work.
# Replace *eth0* according to your local interface name.
IP=$(ip -o -4 addr list eth0 | perl -n -e 'if (m{inet\s([\d\.]+)\/\d+\s}xms) { print $1 }')
echo hello world | nc $IP $PORT

# Verify that the network connection worked
echo "Daemon received: $(docker logs $JOB)"

Under the hood

Under the hood, Docker is built on the following components:

  • The cgroup and namespacing capabilities of the Linux kernel;
  • AUFS, a powerful union filesystem with copy-on-write capabilities;
  • The Go programming language;
  • lxc, a set of convenience scripts to simplify the creation of Linux containers.

Contributing to Docker

Want to hack on Docker? Awesome! There are instructions to get you started on the website: http://docs.docker.io/en/latest/contributing/contributing/

They are probably not perfect, please let us know if anything feels wrong or incomplete.

Note

We also keep the documentation in this repository. The website documentation is generated using Sphinx using these sources. Please find it under docs/sources/ and read more about it https://github.com/dotcloud/docker/tree/master/docs/README.md

Please feel free to fix / update the documentation and send us pull requests. More tutorials are also welcome.

Setting up a dev environment

Instructions that have been verified to work on Ubuntu 12.10,

sudo apt-get -y install lxc curl xz-utils golang git

export GOPATH=~/go/
export PATH=$GOPATH/bin:$PATH

mkdir -p $GOPATH/src/github.com/dotcloud
cd $GOPATH/src/github.com/dotcloud
git clone https://github.com/dotcloud/docker.git
cd docker

go get -v github.com/dotcloud/docker/...
go install -v github.com/dotcloud/docker/...

Then run the docker daemon,

sudo $GOPATH/bin/docker -d

Run the go install command (above) to recompile docker.

What is a Standard Container?

Docker defines a unit of software delivery called a Standard Container. The goal of a Standard Container is to encapsulate a software component and all its dependencies in a format that is self-describing and portable, so that any compliant runtime can run it without extra dependencies, regardless of the underlying machine and the contents of the container.

The spec for Standard Containers is currently a work in progress, but it is very straightforward. It mostly defines 1) an image format, 2) a set of standard operations, and 3) an execution environment.

A great analogy for this is the shipping container. Just like how Standard Containers are a fundamental unit of software delivery, shipping containers are a fundamental unit of physical delivery.

1. STANDARD OPERATIONS

Just like shipping containers, Standard Containers define a set of STANDARD OPERATIONS. Shipping containers can be lifted, stacked, locked, loaded, unloaded and labelled. Similarly, Standard Containers can be started, stopped, copied, snapshotted, downloaded, uploaded and tagged.

2. CONTENT-AGNOSTIC

Just like shipping containers, Standard Containers are CONTENT-AGNOSTIC: all standard operations have the same effect regardless of the contents. A shipping container will be stacked in exactly the same way whether it contains Vietnamese powder coffee or spare Maserati parts. Similarly, Standard Containers are started or uploaded in the same way whether they contain a postgres database, a php application with its dependencies and application server, or Java build artifacts.

3. INFRASTRUCTURE-AGNOSTIC

Both types of containers are INFRASTRUCTURE-AGNOSTIC: they can be transported to thousands of facilities around the world, and manipulated by a wide variety of equipment. A shipping container can be packed in a factory in Ukraine, transported by truck to the nearest routing center, stacked onto a train, loaded into a German boat by an Australian-built crane, stored in a warehouse at a US facility, etc. Similarly, a standard container can be bundled on my laptop, uploaded to S3, downloaded, run and snapshotted by a build server at Equinix in Virginia, uploaded to 10 staging servers in a home-made Openstack cluster, then sent to 30 production instances across 3 EC2 regions.

4. DESIGNED FOR AUTOMATION

Because they offer the same standard operations regardless of content and infrastructure, Standard Containers, just like their physical counterparts, are extremely well-suited for automation. In fact, you could say automation is their secret weapon.

Many things that once required time-consuming and error-prone human effort can now be programmed. Before shipping containers, a bag of powder coffee was hauled, dragged, dropped, rolled and stacked by 10 different people in 10 different locations by the time it reached its destination. 1 out of 50 disappeared. 1 out of 20 was damaged. The process was slow, inefficient and cost a fortune - and was entirely different depending on the facility and the type of goods.

Similarly, before Standard Containers, by the time a software component ran in production, it had been individually built, configured, bundled, documented, patched, vendored, templated, tweaked and instrumented by 10 different people on 10 different computers. Builds failed, libraries conflicted, mirrors crashed, post-it notes were lost, logs were misplaced, cluster updates were half-broken. The process was slow, inefficient and cost a fortune - and was entirely different depending on the language and infrastructure provider.

5. INDUSTRIAL-GRADE DELIVERY

There are 17 million shipping containers in existence, packed with every physical good imaginable. Every single one of them can be loaded onto the same boats, by the same cranes, in the same facilities, and sent anywhere in the World with incredible efficiency. It is embarrassing to think that a 30 ton shipment of coffee can safely travel half-way across the World in less time than it takes a software team to deliver its code from one datacenter to another sitting 10 miles away.

With Standard Containers we can put an end to that embarrassment, by making INDUSTRIAL-GRADE DELIVERY of software a reality.

Transfers of Docker shall be in accordance with applicable export controls of any country and all other applicable legal requirements. Docker shall not be distributed or downloaded to or in Cuba, Iran, North Korea, Sudan or Syria and shall not be distributed or downloaded to any person on the Denied Persons List administered by the U.S. Department of Commerce.

Documentation

Index

Constants

View Source 
const (
	ChangeModify = iota
	ChangeAdd
	ChangeDelete
)
View Source 
const (
	DefaultNetworkBridge = "docker0"
	DisableNetworkBridge = "none"
)
View Source 
const (
	UDPConnTrackTimeout = 90 * time.Second
	UDPBufSize          = 2048
)
View Source 
const APIVERSION = 1.4
View Source 
const DEFAULTHTTPHOST = "127.0.0.1"
View Source 
const DEFAULTHTTPPORT = 4243
View Source 
const DEFAULTTAG = "latest"
View Source 
const DEFAULTUNIXSOCKET = "/var/run/docker.sock"
View Source 
const LxcTemplate = `` /* 3612-byte string literal not displayed */
View Source 
const VERSION = "0.5.2"

Variables

View Source 
var ErrImageReferenced = errors.New("Image referenced by a repository")
View Source 
var (
	GITCOMMIT string
)
View Source 
var LxcTemplateCompiled *template.Template
View Source 
var NetworkBridgeIface string

Functions

func CmdStream 

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

CmdStream executes a command, and returns its stdout as a stream. If the command fails to run or doesn't complete successfully, an error will be returned, including anything written on stderr.

func CompareConfig added in v0.3.1 

func CompareConfig(a, b *Config) bool

Compare two Config struct. Do not compare the "Image" nor "Hostname" fields If OpenStdin is set, then it differs

func CopyFileWithTar added in v0.4.5 

func CopyFileWithTar(src, dst string) error

CopyFileWithTar emulates the behavior of the 'cp' command-line for a single file. It copies a regular file from path `src` to path `dst`, and preserves all its metadata.

If `dst` ends with a trailing slash '/', the final destination path will be `dst/base(src)`.

func CopyWithTar added in v0.4.1 

func CopyWithTar(src, dst string) error

CopyWithTar creates a tar archive of filesystem path `src`, and unpacks it at filesystem path `dst`. The archive is streamed directly with fixed buffering and no intermediary disk IO.

func CreateBridgeIface added in v0.1.4 

func CreateBridgeIface(ifaceName string) error

CreateBridgeIface creates a network bridge interface on the host system with the name `ifaceName`, and attempts to configure it with an address which doesn't conflict with any other interface on the host. If it can't find an address which doesn't conflict, it will return an error.

func GenerateID added in v0.4.1 

func GenerateID() string

func ListenAndServe added in v0.3.3 

func ListenAndServe(proto, addr string, srv *Server, logging bool) error

func MergeConfig added in v0.3.3 

func MergeConfig(userConf, imageConf *Config)

func MountAUFS 

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

func Mounted 

func Mounted(mountpoint string) (bool, error)

func ParseCommands added in v0.3.3 

func ParseCommands(proto, addr string, args ...string) error

func ParseRun 

func ParseRun(args []string, capabilities *Capabilities) (*Config, *HostConfig, *flag.FlagSet, error)

func StoreImage 

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

func StoreSize added in v0.4.1 

func StoreSize(img *Image, root string) error

func Subcmd added in v0.3.3 

func Subcmd(name, signature, description string) *flag.FlagSet

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)

Tar creates an archive from the directory at `path`, and returns it as a stream of bytes.

func TarFilter added in v0.4.3 

func TarFilter(path string, compression Compression, filter []string) (io.Reader, error)

Tar creates an archive from the directory at `path`, only including files whose relative paths are included in `filter`. If `filter` is nil, then all files are included.

func TarUntar added in v0.4.3 

func TarUntar(src string, filter []string, dst string) error

TarUntar is a convenience function which calls Tar and Untar, with the output of one piped into the other. If either Tar or Untar fails, TarUntar aborts and returns the error.

func Unmount 

func Unmount(target string) error

func Untar 

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

Untar reads a stream of bytes from `archive`, parses it as a tar archive, and unpacks it into the directory at `path`. The archive may be compressed with one of the following algorithgms: 

identity (uncompressed), gzip, bzip2, xz.

FIXME: specify behavior when target path exists vs. doesn't exist.

func UntarPath added in v0.4.1 

func UntarPath(src, dst string) error

UntarPath is a convenience function which looks for an archive at filesystem path `src`, and unpacks it at `dst`.

func ValidateID added in v0.4.1 

func ValidateID(id string) error

Types

type APIAuth added in v0.4.1 

type APIAuth struct {
	Status string
}

type APIContainers added in v0.4.1 

type APIContainers struct {
	ID         string `json:"Id"`
	Image      string
	Command    string
	Created    int64
	Status     string
	Ports      string
	SizeRw     int64
	SizeRootFs int64
}

type APIHistory added in v0.4.1 

type APIHistory struct {
	ID        string   `json:"Id"`
	Tags      []string `json:",omitempty"`
	Created   int64
	CreatedBy string `json:",omitempty"`
}

type APIID added in v0.4.1 

type APIID struct {
	ID string `json:"Id"`
}

type APIImageConfig added in v0.4.1 

type APIImageConfig struct {
	ID string `json:"Id"`
	*Config
}

type APIImages added in v0.4.1 

type APIImages struct {
	Repository  string `json:",omitempty"`
	Tag         string `json:",omitempty"`
	ID          string `json:"Id"`
	Created     int64
	Size        int64
	VirtualSize int64
}

type APIInfo added in v0.4.1 

type APIInfo struct {
	Debug           bool
	Containers      int
	Images          int
	NFd             int    `json:",omitempty"`
	NGoroutines     int    `json:",omitempty"`
	MemoryLimit     bool   `json:",omitempty"`
	SwapLimit       bool   `json:",omitempty"`
	LXCVersion      string `json:",omitempty"`
	NEventsListener int    `json:",omitempty"`
	KernelVersion   string `json:",omitempty"`
}

type APIPort added in v0.4.1 

type APIPort struct {
	Port string
}

type APIRmi added in v0.4.1 

type APIRmi struct {
	Deleted  string `json:",omitempty"`
	Untagged string `json:",omitempty"`
}

type APIRun added in v0.4.1 

type APIRun struct {
	ID       string   `json:"Id"`
	Warnings []string `json:",omitempty"`
}

type APISearch added in v0.4.1 

type APISearch struct {
	Name        string
	Description string
}

type APITop added in v0.5.0 

type APITop struct {
	Titles    []string
	Processes [][]string
}

type APIVersion added in v0.4.1 

type APIVersion struct {
	Version   string
	GitCommit string `json:",omitempty"`
	GoVersion string `json:",omitempty"`
}

type APIWait added in v0.4.1 

type APIWait struct {
	StatusCode int
}

type Archive 

type Archive io.Reader

type AttachOpts added in v0.1.2 

type AttachOpts map[string]bool

AttachOpts stores arguments to 'docker run -a', eg. which streams to attach to

func NewAttachOpts added in v0.1.2 

func NewAttachOpts() AttachOpts

func (AttachOpts) Get added in v0.1.2 

func (opts AttachOpts) Get(val string) bool

func (AttachOpts) Set added in v0.1.2 

func (opts AttachOpts) Set(val string) error

func (AttachOpts) String added in v0.1.2 

func (opts AttachOpts) String() string

type BindMap added in v0.4.7 

type BindMap struct {
	SrcPath string
	DstPath string
	Mode    string
}

type BuildFile added in v0.3.4 

type BuildFile interface {
	Build(io.Reader) (string, error)
	CmdFrom(string) error
	CmdRun(string) error
}

func NewBuildFile added in v0.3.4 

func NewBuildFile(srv *Server, out io.Writer, verbose bool) BuildFile

type Builder added in v0.3.1 

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

func NewBuilder added in v0.3.1 

func NewBuilder(runtime *Runtime) *Builder

func (*Builder) Commit added in v0.3.1 

func (builder *Builder) Commit(container *Container, repository, tag, comment, author string, config *Config) (*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 (*Builder) Create added in v0.3.1 

func (builder *Builder) Create(config *Config) (*Container, error)

type Capabilities added in v0.1.8 

type Capabilities struct {
	MemoryLimit bool
	SwapLimit   bool
}

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
	Xz
)

func DetectCompression added in v0.4.3 

func DetectCompression(source []byte) Compression

func (*Compression) Extension added in v0.3.4 

func (compression *Compression) Extension() string

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
	CpuShares       int64 // CPU shares (relative weight vs. other containers)
	AttachStdin     bool
	AttachStdout    bool
	AttachStderr    bool
	PortSpecs       []string
	Tty             bool // Attach standard streams to a tty, including stdin if it is not closed.
	OpenStdin       bool // Open stdin
	StdinOnce       bool // If true, close stdin after the 1 attached client disconnects.
	Env             []string
	Cmd             []string
	Dns             []string
	Image           string // Name of the image as it was passed by the operator (eg. could be symbolic)
	Volumes         map[string]struct{}
	VolumesFrom     string
	Entrypoint      []string
	NetworkDisabled bool
}

type Container 

type Container struct {
	ID string

	Created time.Time

	Path string
	Args []string

	Config *Config
	State  State
	Image  string

	NetworkSettings *NetworkSettings

	SysInitPath    string
	ResolvConfPath string

	Volumes map[string]string
	// Store rw/ro in a separate structure to preserve reverse-compatibility on-disk.
	// Easier than migrating older container configs :)
	VolumesRW map[string]bool
	// contains filtered or unexported fields
}

func (*Container) Attach added in v0.1.2 

func (container *Container) Attach(stdin io.ReadCloser, stdinCloser io.Closer, stdout io.Writer, stderr io.Writer) chan error

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) GetSize added in v0.4.1 

func (container *Container) GetSize() (int64, int64)

GetSize, return real size, virtual size

func (*Container) Inject added in v0.3.1 

func (container *Container) Inject(file io.Reader, pth string) error

Inject the io.Reader at the given path. Note: do not close the reader

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) ReadHostConfig added in v0.5.0 

func (container *Container) ReadHostConfig() (*HostConfig, error)

func (*Container) ReadLog 

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

func (*Container) Resize added in v0.3.4 

func (container *Container) Resize(h, w int) error

func (*Container) Restart 

func (container *Container) Restart(seconds int) 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) RwChecksum added in v0.3.0 

func (container *Container) RwChecksum() (string, error)

func (*Container) SaveHostConfig added in v0.5.0 

func (container *Container) SaveHostConfig(hostConfig *HostConfig) (err error)

func (*Container) ShortID added in v0.4.1 

func (container *Container) ShortID() string

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

func (*Container) Start 

func (container *Container) Start(hostConfig *HostConfig) 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(seconds int) 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 DockerCli added in v0.3.3 

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

func NewDockerCli added in v0.3.3 

func NewDockerCli(in io.ReadCloser, out, err io.Writer, proto, addr string) *DockerCli

func (*DockerCli) CmdAttach added in v0.3.3 

func (cli *DockerCli) CmdAttach(args ...string) error

func (*DockerCli) CmdBuild added in v0.3.3 

func (cli *DockerCli) CmdBuild(args ...string) error

func (*DockerCli) CmdCommit added in v0.3.3 

func (cli *DockerCli) CmdCommit(args ...string) error

func (*DockerCli) CmdDiff added in v0.3.3 

func (cli *DockerCli) CmdDiff(args ...string) error

func (*DockerCli) CmdEvents added in v0.5.1 

func (cli *DockerCli) CmdEvents(args ...string) error

func (*DockerCli) CmdExport added in v0.3.3 

func (cli *DockerCli) CmdExport(args ...string) error

func (*DockerCli) CmdHelp added in v0.3.3 

func (cli *DockerCli) CmdHelp(args ...string) error

func (*DockerCli) CmdHistory added in v0.3.3 

func (cli *DockerCli) CmdHistory(args ...string) error

func (*DockerCli) CmdImages added in v0.3.3 

func (cli *DockerCli) CmdImages(args ...string) error

func (*DockerCli) CmdImport added in v0.3.3 

func (cli *DockerCli) CmdImport(args ...string) error

func (*DockerCli) CmdInfo added in v0.3.3 

func (cli *DockerCli) CmdInfo(args ...string) error

'docker info': display system-wide information.

func (*DockerCli) CmdInsert added in v0.3.3 

func (cli *DockerCli) CmdInsert(args ...string) error

func (*DockerCli) CmdInspect added in v0.3.3 

func (cli *DockerCli) CmdInspect(args ...string) error

func (*DockerCli) CmdKill added in v0.3.3 

func (cli *DockerCli) CmdKill(args ...string) error

'docker kill NAME' kills a running container

func (*DockerCli) CmdLogin added in v0.3.3 

func (cli *DockerCli) CmdLogin(args ...string) error

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

func (*DockerCli) CmdLogs added in v0.3.3 

func (cli *DockerCli) CmdLogs(args ...string) error

func (*DockerCli) CmdPort added in v0.3.3 

func (cli *DockerCli) CmdPort(args ...string) error

func (*DockerCli) CmdPs added in v0.3.3 

func (cli *DockerCli) CmdPs(args ...string) error

func (*DockerCli) CmdPull added in v0.3.3 

func (cli *DockerCli) CmdPull(args ...string) error

func (*DockerCli) CmdPush added in v0.3.3 

func (cli *DockerCli) CmdPush(args ...string) error

func (*DockerCli) CmdRestart added in v0.3.3 

func (cli *DockerCli) CmdRestart(args ...string) error

func (*DockerCli) CmdRm added in v0.3.3 

func (cli *DockerCli) CmdRm(args ...string) error

func (*DockerCli) CmdRmi added in v0.3.3 

func (cli *DockerCli) CmdRmi(args ...string) error

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

func (*DockerCli) CmdRun added in v0.3.3 

func (cli *DockerCli) CmdRun(args ...string) error

func (*DockerCli) CmdSearch added in v0.3.3 

func (cli *DockerCli) CmdSearch(args ...string) error

func (*DockerCli) CmdStart added in v0.3.3 

func (cli *DockerCli) CmdStart(args ...string) error

func (*DockerCli) CmdStop added in v0.3.3 

func (cli *DockerCli) CmdStop(args ...string) error

func (*DockerCli) CmdTag added in v0.3.3 

func (cli *DockerCli) CmdTag(args ...string) error

func (*DockerCli) CmdTop added in v0.5.0 

func (cli *DockerCli) CmdTop(args ...string) error

func (*DockerCli) CmdVersion added in v0.3.3 

func (cli *DockerCli) CmdVersion(args ...string) error

'docker version': show version information

func (*DockerCli) CmdWait added in v0.3.3 

func (cli *DockerCli) CmdWait(args ...string) error

'docker wait': block until a container stops

type Graph 

type Graph struct {
	Root string
	// contains filtered or unexported fields
}

A Graph is a store for versioned filesystem images and the relationship between them.

func NewGraph 

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

NewGraph instantiates a new graph at the given root path in the filesystem. `root` will be created if it doesn't exist.

func (*Graph) All 

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

All returns a list of all images in the graph.

func (*Graph) ByParent 

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

ByParent returns a lookup table of images by their parent. If an image of id ID has 3 children images, then the value for key ID will be a list of 3 images. If an image has no children, it will not have an entry in the table.

func (*Graph) Create 

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

Create creates a new image and registers it in the graph.

func (*Graph) Delete 

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

Delete atomically removes an image from the graph.

func (*Graph) Exists 

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

Exists returns true if an image is registered at the given id. If the image doesn't exist or if an error is encountered, false is returned.

func (*Graph) Get 

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

Get returns the image with the given id, or an error if the image doesn't exist.

func (*Graph) Heads 

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

Heads returns all heads in the graph, keyed by id. A head is an image which is not the parent of another image in the graph.

func (*Graph) IsNotExist added in v0.1.1 

func (graph *Graph) IsNotExist(err error) bool

FIXME: Implement error subclass instead of looking at the error text Note: This is the way golang implements os.IsNotExists on Plan9

func (*Graph) Map 

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

Map returns a list of all images in the graph, addressable by ID.

func (*Graph) Mktemp 

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

Mktemp creates a temporary sub-directory inside the graph's filesystem.

func (*Graph) Register 

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

Register imports a pre-existing image into the graph. FIXME: pass img as first argument

func (*Graph) TempLayerArchive added in v0.1.8 

func (graph *Graph) TempLayerArchive(id string, compression Compression, sf *utils.StreamFormatter, output io.Writer) (*TempArchive, error)

TempLayerArchive creates a temporary archive of the given image's filesystem layer. 

The archive is stored on disk and will be automatically deleted as soon as has been read.
If output is not nil, a human-readable progress bar will be written to it.
FIXME: does this belong in Graph? How about MktempFile, let the caller use it for archives?

func (*Graph) UpdateChecksums added in v0.3.3 

func (graph *Graph) UpdateChecksums(newChecksums map[string]*registry.ImgData) error

func (*Graph) WalkAll 

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

WalkAll iterates over each image in the graph, and passes it to a handler. The walking order is undetermined.

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 HostConfig added in v0.4.7 

type HostConfig struct {
	Binds           []string
	ContainerIDFile string
}

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)

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"`
	DockerVersion   string    `json:"docker_version,omitempty"`
	Author          string    `json:"author,omitempty"`
	Config          *Config   `json:"config,omitempty"`
	Architecture    string    `json:"architecture,omitempty"`

	Size int64
	// contains filtered or unexported fields
}

func LoadImage 

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

func NewImgJSON added in v0.4.1 

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

Build an Image object from raw json data

func (*Image) Changes 

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

func (*Image) Checksum added in v0.3.0 

func (img *Image) Checksum() (string, 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) ShortID added in v0.4.1 

func (image *Image) ShortID() string

func (*Image) TarLayer added in v0.1.8 

func (image *Image) TarLayer(compression Compression) (Archive, error)

TarLayer returns a tar archive of the image's filesystem layer.

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 Nat added in v0.1.3 

type Nat struct {
	Proto    string
	Frontend int
	Backend  int
}

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(spec string) (*Nat, error)

Allocate an external TCP port and map it to the interface

func (*NetworkInterface) Release 

func (iface *NetworkInterface) Release()

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
	Bridge      string
	PortMapping map[string]PortMapping
}

func (*NetworkSettings) PortMappingHuman added in v0.1.7 

func (settings *NetworkSettings) PortMappingHuman() string

String returns a human-readable description of the port mapping defined in the settings

type PathOpts added in v0.2.2 

type PathOpts map[string]struct{}

PathOpts stores a unique set of absolute paths

func NewPathOpts added in v0.2.2 

func NewPathOpts() PathOpts

func (PathOpts) Set added in v0.2.2 

func (opts PathOpts) Set(val string) error

func (PathOpts) String added in v0.2.2 

func (opts PathOpts) String() string

type PortAllocator 

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

Port allocator: Atomatically allocate and release networking ports

func (*PortAllocator) Acquire 

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

func (*PortAllocator) Release 

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

FIXME: Release can no longer fail, change its prototype to reflect that.

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, backendAddr net.Addr) error

func (*PortMapper) Unmap 

func (mapper *PortMapper) Unmap(port int, proto string) error

type PortMapping added in v0.5.0 

type PortMapping map[string]string

type Proxy added in v0.5.0 

type Proxy interface {
	// Start forwarding traffic back and forth the front and back-end
	// addresses.
	Run()
	// Stop forwarding traffic and close both ends of the Proxy.
	Close()
	// Return the address on which the proxy is listening.
	FrontendAddr() net.Addr
	// Return the proxied address.
	BackendAddr() net.Addr
}

func NewProxy added in v0.5.0 

func NewProxy(frontendAddr, backendAddr net.Addr) (Proxy, error)

type Repository 

type Repository map[string]string

type Runtime 

type Runtime struct {
	Dns []string
	// contains filtered or unexported fields
}

func NewRuntime 

func NewRuntime(flGraphPath string, autoRestart bool, dns []string) (*Runtime, error)

FIXME: harmonize with NewGraph()

func NewRuntimeFromDirectory 

func NewRuntimeFromDirectory(root string, autoRestart bool) (*Runtime, 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(name 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 *utils.WriteBroadcaster, dst, stream string) error

func (*Runtime) Register 

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

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

func (*Runtime) UpdateCapabilities added in v0.2.2 

func (runtime *Runtime) UpdateCapabilities(quiet bool)

type Server 

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

func NewServer 

func NewServer(flGraphPath string, autoRestart, enableCors bool, dns ListOpts) (*Server, error)

func (*Server) ContainerAttach added in v0.3.3 

func (srv *Server) ContainerAttach(name string, logs, stream, stdin, stdout, stderr bool, in io.ReadCloser, out io.Writer) error

func (*Server) ContainerChanges added in v0.3.3 

func (srv *Server) ContainerChanges(name string) ([]Change, error)

func (*Server) ContainerCommit added in v0.3.3 

func (srv *Server) ContainerCommit(name, repo, tag, author, comment string, config *Config) (string, error)

func (*Server) ContainerCreate added in v0.3.3 

func (srv *Server) ContainerCreate(config *Config) (string, error)

func (*Server) ContainerDestroy added in v0.3.3 

func (srv *Server) ContainerDestroy(name string, removeVolume bool) error

func (*Server) ContainerExport added in v0.3.3 

func (srv *Server) ContainerExport(name string, out io.Writer) error

func (*Server) ContainerInspect added in v0.3.3 

func (srv *Server) ContainerInspect(name string) (*Container, error)

func (*Server) ContainerKill added in v0.3.3 

func (srv *Server) ContainerKill(name string) error

func (*Server) ContainerResize added in v0.3.4 

func (srv *Server) ContainerResize(name string, h, w int) error

func (*Server) ContainerRestart added in v0.3.3 

func (srv *Server) ContainerRestart(name string, t int) error

func (*Server) ContainerStart added in v0.3.3 

func (srv *Server) ContainerStart(name string, hostConfig *HostConfig) error

func (*Server) ContainerStop added in v0.3.3 

func (srv *Server) ContainerStop(name string, t int) error

func (*Server) ContainerTag added in v0.3.3 

func (srv *Server) ContainerTag(name, repo, tag string, force bool) error

func (*Server) ContainerTop added in v0.5.0 

func (srv *Server) ContainerTop(name, ps_args string) (*APITop, error)

func (*Server) ContainerWait added in v0.3.3 

func (srv *Server) ContainerWait(name string) (int, error)

func (*Server) Containers added in v0.3.3 

func (srv *Server) Containers(all, size bool, n int, since, before string) []APIContainers

func (*Server) DockerInfo added in v0.3.3 

func (srv *Server) DockerInfo() *APIInfo

func (*Server) DockerVersion added in v0.3.3 

func (srv *Server) DockerVersion() APIVersion

func (*Server) ImageDelete added in v0.3.3 

func (srv *Server) ImageDelete(name string, autoPrune bool) ([]APIRmi, error)

func (*Server) ImageGetCached added in v0.3.3 

func (srv *Server) ImageGetCached(imgID string, config *Config) (*Image, error)

func (*Server) ImageHistory added in v0.3.3 

func (srv *Server) ImageHistory(name string) ([]APIHistory, error)

func (*Server) ImageImport added in v0.3.3 

func (srv *Server) ImageImport(src, repo, tag string, in io.Reader, out io.Writer, sf *utils.StreamFormatter) error

func (*Server) ImageInsert added in v0.3.3 

func (srv *Server) ImageInsert(name, url, path string, out io.Writer, sf *utils.StreamFormatter) (string, error)

func (*Server) ImageInspect added in v0.3.3 

func (srv *Server) ImageInspect(name string) (*Image, error)

func (*Server) ImagePull added in v0.3.3 

func (srv *Server) ImagePull(localName string, tag string, out io.Writer, sf *utils.StreamFormatter, authConfig *auth.AuthConfig) error

func (*Server) ImagePush added in v0.3.3 

func (srv *Server) ImagePush(localName string, out io.Writer, sf *utils.StreamFormatter, authConfig *auth.AuthConfig) error

FIXME: Allow to interupt current push when new push of same image is done.

func (*Server) Images added in v0.3.3 

func (srv *Server) Images(all bool, filter string) ([]APIImages, error)

func (*Server) ImagesSearch added in v0.3.3 

func (srv *Server) ImagesSearch(term string) ([]APISearch, error)

func (*Server) ImagesViz added in v0.3.3 

func (srv *Server) ImagesViz(out io.Writer) error

func (*Server) LogEvent added in v0.5.1 

func (srv *Server) LogEvent(action, id string)

type State 

type State struct {
	sync.Mutex
	Running   bool
	Pid       int
	ExitCode  int
	StartedAt time.Time
	Ghost     bool
}

func (*State) String 

func (s *State) String() string

String returns a human-readable description of the state

type TCPProxy added in v0.5.0 

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

func NewTCPProxy added in v0.5.0 

func NewTCPProxy(frontendAddr, backendAddr *net.TCPAddr) (*TCPProxy, error)

func (*TCPProxy) BackendAddr added in v0.5.0 

func (proxy *TCPProxy) BackendAddr() net.Addr

func (*TCPProxy) Close added in v0.5.0 

func (proxy *TCPProxy) Close()

func (*TCPProxy) FrontendAddr added in v0.5.0 

func (proxy *TCPProxy) FrontendAddr() net.Addr

func (*TCPProxy) Run added in v0.5.0 

func (proxy *TCPProxy) Run()

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

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) Delete added in v0.4.1 

func (store *TagStore) Delete(repoName, tag string) (bool, error)

func (*TagStore) DeleteAll added in v0.4.1 

func (store *TagStore) DeleteAll(id string) error

func (*TagStore) Get 

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

func (*TagStore) GetImage 

func (store *TagStore) GetImage(repoName, tagOrID 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

type TempArchive added in v0.1.8 

type TempArchive struct {
	*os.File
	Size int64 // Pre-computed from Stat().Size() as a convenience
}

func NewTempArchive added in v0.1.8 

func NewTempArchive(src Archive, dir string) (*TempArchive, error)

NewTempArchive reads the content of src into a temporary file, and returns the contents of that file as an archive. The archive can only be read once - as soon as reading completes, the file will be deleted.

func (*TempArchive) Read added in v0.1.8 

func (archive *TempArchive) Read(data []byte) (int, error)

type UDPProxy added in v0.5.0 

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

func NewUDPProxy added in v0.5.0 

func NewUDPProxy(frontendAddr, backendAddr *net.UDPAddr) (*UDPProxy, error)

func (*UDPProxy) BackendAddr added in v0.5.0 

func (proxy *UDPProxy) BackendAddr() net.Addr

func (*UDPProxy) Close added in v0.5.0 

func (proxy *UDPProxy) Close()

func (*UDPProxy) FrontendAddr added in v0.5.0 

func (proxy *UDPProxy) FrontendAddr() net.Addr

func (*UDPProxy) Run added in v0.5.0 

func (proxy *UDPProxy) Run()

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.