docker

package module
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2013 License: Apache-2.0 Imports: 35 Imported by: 0

README

Docker: the Linux container runtime

Docker complements LXC with a high-level API which operates at the process level. It runs unix processes with strong guarantees of isolation and repeatability across servers.

Docker is a great building block for automating distributed systems: large-scale web deployments, database clusters, continuous deployment systems, private PaaS, service-oriented architectures, etc.

Docker L

  • Heterogeneous payloads: any combination of binaries, libraries, configuration files, scripts, virtualenvs, jars, gems, tarballs, you name it. No more juggling between domain-specific tools. Docker can deploy and run them all.

  • Any server: docker can run on any x64 machine with a modern linux kernel - whether it's a laptop, a bare metal server or a VM. This makes it perfect for multi-cloud deployments.

  • Isolation: docker isolates processes from each other and from the underlying host, using lightweight containers.

  • Repeatability: because containers are isolated in their own filesystem, they behave the same regardless of where, when, and alongside what they run.

Notable features

  • Filesystem isolation: each process container runs in a completely separate root filesystem.

  • Resource isolation: system resources like cpu and memory can be allocated differently to each process container, using cgroups.

  • Network isolation: each process container runs in its own network namespace, with a virtual interface and IP address of its own.

  • Copy-on-write: root filesystems are created using copy-on-write, which makes deployment extremely fast, memory-cheap and disk-cheap.

  • Logging: the standard streams (stdout/stderr/stdin) of each process container are collected and logged for real-time or batch retrieval.

  • Change management: changes to a container's filesystem can be committed into a new image and re-used to create more containers. No templating or manual configuration required.

  • Interactive shell: docker can allocate a pseudo-tty and attach to the standard input of any container, for example to run a throwaway interactive shell.

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.

Installing from source

  1. Make sure you have a Go language compiler 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 $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

View Source 
const (
	ChangeModify = iota
	ChangeAdd
	ChangeDelete
)
View Source 
const DEFAULT_TAG = "latest"
View Source 
const (
	DefaultNetworkBridge = "docker0"
)
View Source 
const LxcTemplate = `` /* 2682-byte string literal not displayed */
View Source 
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"

View Source 
const VERSION = "0.2.0"

Variables

View Source 
var (
	GIT_COMMIT 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 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 

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

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

func CreateBridgeIface added in v0.1.4 

func CreateBridgeIface(ifaceName string) error

func Debugf 

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

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

func Download 

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

Request a given URL and return an io.Reader

func FindCgroupMountpoint added in v0.1.8 

func FindCgroupMountpoint(cgroupType string) (string, error)

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, template string) *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 TruncateId added in v0.1.2 

func TruncateId(id string) string

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

func 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 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 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 (*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)
}

func ParseRun 

func ParseRun(args []string, stdout io.Writer, capabilities *Capabilities) (*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
	ResolvConfPath string
	// 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) 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(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) ShortId added in v0.1.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() 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 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) (*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) 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)

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

func (graph *Graph) PullImage(stdout io.Writer, 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

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, 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) 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 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"`
	// 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) ShortId added in v0.1.2 

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

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

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 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]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 PortAllocator 

type PortAllocator struct {
	// 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, 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)

FIXME: harmonize with NewGraph()

func NewRuntimeFromDirectory 

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

func (*Runtime) Commit 

func (runtime *Runtime) Commit(id, repository, tag, comment, author 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(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 *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 rcli.DockerConn, 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 rcli.DockerConn, 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 rcli.DockerConn, 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 rcli.DockerConn, 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 IMAGE' removes all images with the name IMAGE

func (*Server) CmdRun 

func (srv *Server) CmdRun(stdin io.ReadCloser, stdout rcli.DockerConn, 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

	Ghost bool
	// 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

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

func (*TruncIndex) Get added in v0.1.1 

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

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.