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.
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, the 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 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 his 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 his 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 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 apt-get install python
run apt-get install python-pip
run pip install django
run apt-get install curl
run curl http://github.com/shykes/helloflask/helloflask/master.tar.gz | tar -zxv
run cd 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 | sh -x
Binary installs
Docker supports the following binary installation methods. Note that some methods are community contributions and not yet officially supported.
- Ubuntu 12.04 and 12.10 (officially supported)
- Arch Linux
- MacOS X (with Vagrant)
- Windows (with Vagrant)
- Amazon EC2 (with Vagrant)
Installing from source
-
Make sure you have a Go language compiler and git installed.
-
Checkout the source code
git clone http://github.com/dotcloud/docker
-
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 $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.
IP=$(ifconfig eth0 | perl -n -e 'if (m/inet addr:([\d\.]+)/g) { 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/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 wget bsdtar curl 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 git@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 Standard Containers are a fundamental unit of software delivery, shipping containers (http://bricks.argz.com/ins/7823-1/12) 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 counterpart, 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 on 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.
Standard Container Specification
(TODO)
Image format
Standard operations
- Copy
- Run
- Stop
- Wait
- Commit
- Attach standard streams
- List filesystem changes
- ...
Execution environment
Root filesystem
Environment variables
Process arguments
Networking
Process namespacing
Resource limits
Process monitoring
Logging
Signals
Pseudo-terminal allocation
Security
Documentation ¶
Index ¶
- Constants
- Variables
- func CmdStream(cmd *exec.Cmd) (io.Reader, error)
- func CompareConfig(a, b *Config) bool
- func CompareKernelVersion(a, b *KernelVersionInfo) int
- func CopyEscapable(dst io.Writer, src io.ReadCloser) (written int64, err error)
- func CreateBridgeIface(ifaceName string) error
- func Debugf(format string, a ...interface{})
- func Download(url string, stderr io.Writer) (*http.Response, error)
- func FindCgroupMountpoint(cgroupType string) (string, error)
- func GenerateId() string
- func Go(f func() error) chan error
- func HashData(src io.Reader) (string, error)
- func HumanDuration(d time.Duration) string
- func MountAUFS(ro []string, rw string, target string) error
- func Mounted(mountpoint string) (bool, error)
- func NopWriteCloser(w io.Writer) io.WriteCloser
- func ProgressReader(r io.ReadCloser, size int, output io.Writer, template string) *progressReader
- func SelfPath() string
- func StoreImage(img *Image, layerData Archive, root string) error
- func SysInit()
- func Tar(path string, compression Compression) (io.Reader, error)
- func Trunc(s string, maxlen int) string
- func TruncateId(id string) string
- func Unmount(target string) error
- func Untar(archive io.Reader, path string) error
- func ValidateId(id string) error
- type Archive
- type AttachOpts
- type Builder
- type Capabilities
- type Change
- type ChangeType
- type Compression
- type Config
- type Container
- func (container *Container) Attach(stdin io.ReadCloser, stdinCloser io.Closer, stdout io.Writer, stderr io.Writer) chan error
- func (container *Container) Changes() ([]Change, error)
- func (container *Container) Cmd() *exec.Cmd
- func (container *Container) EnsureMounted() error
- func (container *Container) Export() (Archive, error)
- func (container *Container) ExportRw() (Archive, error)
- func (container *Container) FromDisk() error
- func (container *Container) GetImage() (*Image, error)
- func (container *Container) GetVolumes() (map[string]string, error)
- func (container *Container) Inject(file io.Reader, pth string) error
- func (container *Container) Kill() error
- func (container *Container) Mount() error
- func (container *Container) Mounted() (bool, error)
- func (container *Container) Output() (output []byte, err error)
- func (container *Container) ReadLog(name string) (io.Reader, error)
- func (container *Container) Restart(seconds int) error
- func (container *Container) RootfsPath() string
- func (container *Container) Run() error
- func (container *Container) RwChecksum() (string, error)
- func (container *Container) ShortId() string
- func (container *Container) Start() error
- func (container *Container) StderrPipe() (io.ReadCloser, error)
- func (container *Container) StdinPipe() (io.WriteCloser, error)
- func (container *Container) StdoutPipe() (io.ReadCloser, error)
- func (container *Container) Stop(seconds int) error
- func (container *Container) ToDisk() (err error)
- func (container *Container) Unmount() error
- func (container *Container) Wait() int
- func (container *Container) WaitTimeout(timeout time.Duration) error
- func (container *Container) When() time.Time
- type Graph
- func (graph *Graph) All() ([]*Image, error)
- func (graph *Graph) ByParent() (map[string][]*Image, error)
- func (graph *Graph) Checksums(output io.Writer, repo Repository) ([]map[string]string, error)
- func (graph *Graph) Create(layerData Archive, container *Container, comment, author string, ...) (*Image, error)
- func (graph *Graph) Delete(name string) error
- func (graph *Graph) Exists(id string) bool
- func (graph *Graph) Get(name string) (*Image, error)
- func (graph *Graph) Heads() (map[string]*Image, error)
- func (graph *Graph) IsNotExist(err error) bool
- func (graph *Graph) LookupRemoteImage(imgId, registry string, authConfig *auth.AuthConfig) bool
- func (graph *Graph) Map() (map[string]*Image, error)
- func (graph *Graph) Mktemp(id string) (string, error)
- func (graph *Graph) PullImage(stdout io.Writer, imgId, registry string, token []string) error
- func (graph *Graph) PullRepository(stdout io.Writer, remote, askedTag string, repositories *TagStore, ...) error
- func (graph *Graph) PushImage(stdout io.Writer, imgOrig *Image, registry string, token []string) error
- func (graph *Graph) PushRepository(stdout io.Writer, remote string, localRepo Repository, ...) error
- func (graph *Graph) Register(layerData Archive, img *Image) error
- func (graph *Graph) SearchRepositories(stdout io.Writer, term string) (*SearchResults, error)
- func (graph *Graph) TempLayerArchive(id string, compression Compression, output io.Writer) (*TempArchive, error)
- func (graph *Graph) WalkAll(handler func(*Image)) error
- type History
- type IPAllocator
- type Image
- func (image *Image) Changes(rw string) ([]Change, error)
- func (img *Image) Checksum() (string, error)
- func (img *Image) GetParent() (*Image, error)
- func (img *Image) History() ([]*Image, error)
- func (image *Image) Mount(root, rw string) error
- func (image *Image) ShortId() string
- func (image *Image) TarLayer(compression Compression) (Archive, error)
- func (img *Image) WalkHistory(handler func(*Image) error) (err error)
- type KernelVersionInfo
- type ListOpts
- type Nat
- type NetworkInterface
- type NetworkManager
- type NetworkSettings
- type PathOpts
- type PortAllocator
- type PortMapper
- type Repository
- type Runtime
- func (runtime *Runtime) Destroy(container *Container) error
- func (runtime *Runtime) Exists(id string) bool
- func (runtime *Runtime) Get(name string) *Container
- func (runtime *Runtime) List() []*Container
- func (runtime *Runtime) Load(id string) (*Container, error)
- func (runtime *Runtime) LogToDisk(src *writeBroadcaster, dst string) error
- func (runtime *Runtime) Register(container *Container) error
- func (runtime *Runtime) UpdateCapabilities(quiet bool)
- type SearchResults
- type Server
- func (srv *Server) CmdAttach(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
- func (srv *Server) CmdBuild(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
- func (srv *Server) CmdCommit(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdDiff(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdExport(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdHistory(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdImages(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdImport(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
- func (srv *Server) CmdInfo(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdInsert(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
- func (srv *Server) CmdInspect(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdKill(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdLogin(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
- func (srv *Server) CmdLogs(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdPort(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdPs(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdPull(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdPush(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
- func (srv *Server) CmdRestart(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdRm(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdRmi(stdin io.ReadCloser, stdout io.Writer, args ...string) (err error)
- func (srv *Server) CmdRun(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
- func (srv *Server) CmdSearch(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
- func (srv *Server) CmdStart(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdStop(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdTag(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdVersion(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) CmdWait(stdin io.ReadCloser, stdout io.Writer, args ...string) error
- func (srv *Server) Help() string
- func (srv *Server) Name() string
- type State
- type TagStore
- func (store *TagStore) ById() map[string][]string
- func (store *TagStore) Get(repoName string) (Repository, error)
- func (store *TagStore) GetImage(repoName, tag string) (*Image, error)
- func (store *TagStore) ImageName(id string) string
- func (store *TagStore) LookupImage(name string) (*Image, error)
- func (store *TagStore) Reload() error
- func (store *TagStore) Save() error
- func (store *TagStore) Set(repoName, tag, imageName string, force bool) error
- type TempArchive
- type TruncIndex
Constants ¶
const ( ChangeModify = iota ChangeAdd ChangeDelete )
const DEFAULT_TAG = "latest"
const (
DefaultNetworkBridge = "docker0"
)
const INDEX_ENDPOINT = auth.INDEX_SERVER + "/v1"
FIXME: Set the endpoint in a conf file or via commandline
const LxcTemplate = `` /* 2840-byte string literal not displayed */
const VERSION = "0.3.1"
Variables ¶
var (
GIT_COMMIT string
)
var LxcTemplateCompiled *template.Template
var NetworkBridgeIface string
Functions ¶
func CmdStream ¶
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
Compare two Config struct. Do not compare the "Image" nor "Hostname" fields If OpenStdin is set, then it differs
func CompareKernelVersion ¶ added in v0.1.8
func CompareKernelVersion(a, b *KernelVersionInfo) int
Compare two KernelVersionInfo struct. Returns -1 if a < b, = if a == b, 1 it a > b
func CopyEscapable ¶ added in v0.1.4
Code c/c from io.Copy() modified to handle escape sequence
func CreateBridgeIface ¶ added in v0.1.4
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 FindCgroupMountpoint ¶ added in v0.1.8
func GenerateId ¶
func GenerateId() string
func Go ¶
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 ¶
HumanDuration returns a human-readable approximation of a duration (eg. "About a minute", "4 hours ago", etc.)
func NopWriteCloser ¶
func NopWriteCloser(w io.Writer) io.WriteCloser
func ProgressReader ¶
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 TruncateId ¶ added in v0.1.2
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 ValidateId ¶
Types ¶
type AttachOpts ¶ added in v0.1.2
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 Builder ¶ added in v0.3.1
type Builder struct {
// contains filtered or unexported fields
}
func NewBuilder ¶ added in v0.3.1
type Capabilities ¶ added in v0.1.8
type Change ¶
type Change struct { Path string Kind ChangeType }
type ChangeType ¶
type ChangeType int
type Compression ¶
type Compression uint32
const ( Uncompressed Compression = iota Bzip2 Gzip Xz )
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 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 }
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 // contains filtered or unexported fields }
func (*Container) EnsureMounted ¶
func (*Container) GetVolumes ¶ added in v0.2.2
func (*Container) Inject ¶ added in v0.3.1
Inject the io.Reader at the given path. Note: do not close the reader
func (*Container) RootfsPath ¶
This method must be exported to be used from the lxc template
func (*Container) RwChecksum ¶ added in v0.3.0
func (*Container) ShortId ¶ added in v0.1.1
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) 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) WaitTimeout ¶
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 ¶
NewGraph instantiates a new graph at the given root path in the filesystem. `root` will be created if it doesn't exist.
func (*Graph) ByParent ¶
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) Exists ¶
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 ¶
Get returns the image with the given id, or an error if the image doesn't exist.
func (*Graph) Heads ¶
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
FIXME: Implement error subclass instead of looking at the error text Note: This is the way golang implements os.IsNotExists on Plan9
func (*Graph) LookupRemoteImage ¶
func (graph *Graph) LookupRemoteImage(imgId, registry string, authConfig *auth.AuthConfig) bool
Check if an image exists in the Registry
func (*Graph) PullRepository ¶
func (*Graph) PushImage ¶
func (graph *Graph) PushImage(stdout io.Writer, imgOrig *Image, registry string, token []string) 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 ¶
Register imports a pre-existing image into the graph. FIXME: pass img as first argument
func (*Graph) SearchRepositories ¶ added in v0.3.1
func (*Graph) TempLayerArchive ¶ added in v0.1.8
func (graph *Graph) TempLayerArchive(id string, compression Compression, 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?
type IPAllocator ¶
type IPAllocator struct {
// contains filtered or unexported fields
}
IP allocator: Atomatically allocate and release networking ports
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"` // contains filtered or unexported fields }
func NewImgJson ¶
Build an Image object from raw json data
func (*Image) History ¶
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)
type KernelVersionInfo ¶ added in v0.1.8
func GetKernelVersion ¶ added in v0.1.8
func GetKernelVersion() (*KernelVersionInfo, error)
FIXME: this doens't build on Darwin
func (*KernelVersionInfo) String ¶ added in v0.1.8
func (k *KernelVersionInfo) 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(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]string }
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
type PortAllocator ¶
type PortAllocator struct {
// contains filtered or unexported fields
}
Port allocator: Atomatically allocate and release networking ports
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) Unmap ¶
func (mapper *PortMapper) Unmap(port int) error
type Repository ¶
type Runtime ¶
type Runtime struct {
// contains filtered or unexported fields
}
func NewRuntime ¶
FIXME: harmonize with NewGraph()
func NewRuntimeFromDirectory ¶
func (*Runtime) Register ¶
Register makes a container object usable by the runtime as <container.Id>
func (*Runtime) UpdateCapabilities ¶ added in v0.2.2
type SearchResults ¶ added in v0.3.1
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
func (*Server) CmdAttach ¶
func (srv *Server) CmdAttach(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
func (*Server) CmdBuild ¶ added in v0.3.1
func (srv *Server) CmdBuild(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
func (*Server) CmdHistory ¶
func (*Server) CmdImport ¶
func (srv *Server) CmdImport(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
func (*Server) CmdInsert ¶ added in v0.3.1
func (srv *Server) CmdInsert(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
func (*Server) CmdInspect ¶
func (*Server) CmdLogin ¶
func (srv *Server) CmdLogin(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
'docker login': login / register a user to registry service.
func (*Server) CmdPush ¶
func (srv *Server) CmdPush(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
func (*Server) CmdRestart ¶
func (*Server) CmdRun ¶
func (srv *Server) CmdRun(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
func (*Server) CmdSearch ¶ added in v0.3.1
func (srv *Server) CmdSearch(stdin io.ReadCloser, stdout rcli.DockerConn, args ...string) error
func (*Server) CmdVersion ¶
'docker version': show version information
type State ¶
type TagStore ¶
type TagStore struct { Repositories map[string]Repository // contains filtered or unexported fields }
type TempArchive ¶ added in v0.1.8
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.
type TruncIndex ¶ added in v0.1.1
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 ¶ added in v0.1.1
func NewTruncIndex() *TruncIndex
func (*TruncIndex) Add ¶ added in v0.1.1
func (idx *TruncIndex) Add(id string) error
func (*TruncIndex) Delete ¶ added in v0.1.1
func (idx *TruncIndex) Delete(id string) error