docker

package module
v0.7.7-0...-e6ae8f6 Latest Latest
Warning

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

 Go to latest Published: Jan 25, 2014 License: Apache-2.0 Imports: 67 Imported by: 0

README

Docker: the Linux container engine

Docker is an open source project to pack, ship and run any application as a lightweight container

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.

Getting started

Docker can be installed on your local machine as well as servers - both bare metal and virtualized. It is available as a binary on most modern Linux systems, or as a VM on Windows, Mac and other systems.

We also offer an interactive tutorial for quickly learning the basics of using Docker.

For up-to-date install instructions and online tutorials, see the Getting Started page.

Usage examples

Docker can be used to run short-lived commands, long-running daemons (app servers, databases etc.), interactive shell sessions, etc.

You can find a list of real-world examples in the documentation.

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

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

Brought to you courtesy of our legal counsel. For more context, please see the Notice document.

Use and transfer of Docker may be subject to certain restrictions by the United States and other governments.
It is your responsibility to ensure that your use and/or transfer does not violate applicable laws.

For more information, please see http://www.bis.doc.gov

Documentation

Index

Constants

View Source 
const (
	APIVERSION        = 1.9
	DEFAULTHTTPHOST   = "127.0.0.1"
	DEFAULTHTTPPORT   = 4243
	DEFAULTUNIXSOCKET = "/var/run/docker.sock"
)
View Source 
const (
	DefaultNetworkBridge = "docker0"
	DisableNetworkBridge = "none"
	DefaultNetworkMtu    = 1500
)
View Source 
const (
	PortSpecTemplate       = "ip:hostPort:containerPort"
	PortSpecTemplateFormat = "ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort"
)

FIXME: network related stuff (including parsing) should be grouped in network file

View Source 
const DEFAULTTAG = "latest"
View Source 
const MaxImageDepth = 127

Set the max depth to the aufs default that most kernels are compiled with For more information see: http://sourceforge.net/p/aufs/aufs3-standalone/ci/aufs3.12/tree/config.mk

Variables

View Source 
var (
	GITCOMMIT string
	VERSION   string
)
View Source 
var (
	ErrNotATTY = errors.New("The PTY is not a file")
	ErrNoTTY   = errors.New("No PTY found")
)
View Source 
var (
	ErrContainerStart           = errors.New("The container failed to start. Unknown error")
	ErrContainerStartTimeout    = errors.New("The container failed to start due to timed out.")
	ErrInvalidWorikingDirectory = errors.New("The working directory is invalid. It needs to be an absolute path.")
	ErrConflictAttachDetach     = errors.New("Conflicting options: -a and -d")
	ErrConflictDetachAutoRemove = errors.New("Conflicting options: -rm and -d")
)
View Source 
var (
	ErrConnectionRefused = errors.New("Can't connect to docker daemon. Is 'docker -d' running on this host?")
)
View Source 
var (
	ErrDockerfileEmpty = errors.New("Dockerfile cannot be empty")
)
View Source 
var ErrImageReferenced = errors.New("Image referenced by a repository")

Functions

func AttachProfiler 

func AttachProfiler(router *mux.Router)
func BtrfsReflink(fd_out, fd_in uintptr) error

func CompareConfig 

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 CopyFile 

func CopyFile(dstFile, srcFile *os.File) error

func CreateBridgeIface 

func CreateBridgeIface(config *DaemonConfig) 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 EofReader 

func EofReader(r io.Reader, callback func()) *eofReader

Read an io.Reader and call a function when it returns EOF

func GenerateID 

func GenerateID() string

func ListenAndServe 

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

func MergeConfig 

func MergeConfig(userConf, imageConf *Config) error

func MkBuildContext 

func MkBuildContext(dockerfile string, files [][2]string) (archive.Archive, error)

mkBuildContext returns an archive of an empty context with the contents of `dockerfile` at the path ./Dockerfile

func ParseCommands 

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

func ParseRun 

func ParseRun(args []string, sysInfo *sysinfo.SysInfo) (*Config, *HostConfig, *flag.FlagSet, error)

FIXME Only used in tests

func ServeRequest 

func ServeRequest(srv *Server, apiversion float64, w http.ResponseWriter, req *http.Request) error

ServeRequest processes a single http request to the docker remote api. FIXME: refactor this to be part of Server and not require re-creating a new router each time. This requires first moving ListenAndServe into Server.

func StoreImage 

func StoreImage(img *Image, jsonData []byte, layerData archive.Archive, root, layer string) error

func ValidateAttach 

func ValidateAttach(val string) (string, error)

func ValidateEnv 

func ValidateEnv(val string) (string, error)

func ValidateHost 

func ValidateHost(val string) (string, error)

func ValidateID 

func ValidateID(id string) error

func ValidateIp4Address 

func ValidateIp4Address(val string) (string, error)
func ValidateLink(val string) (string, error)

func ValidatePath 

func ValidatePath(val string) (string, error)

Types

type APICopy 

type APICopy struct {
	Resource string
	HostPath string
}

type APIID 

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

type APIImageConfig 

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

type APIPort 

type APIPort struct {
	PrivatePort int64
	PublicPort  int64
	Type        string
	IP          string
}

type APIRmi 

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

type APIRun 

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

type APITop 

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

type APIWait 

type APIWait struct {
	StatusCode int
}

type BindMap 

type BindMap struct {
	SrcPath string
	DstPath string
	Mode    string
}

type BuildFile 

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

func NewBuildFile 

func NewBuildFile(srv *Server, outStream, errStream io.Writer, verbose, utilizeCache, rm bool, outOld io.Writer, sf *utils.StreamFormatter, auth *auth.AuthConfig, authConfigFile *auth.ConfigFile) BuildFile

type Change 

type Change struct {
	archive.Change
}

type Config 

type Config struct {
	Hostname        string
	Domainname      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 // Deprecated - Can be in the format of 8080/tcp
	ExposedPorts    map[Port]struct{}
	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
	WorkingDir      string
	Entrypoint      []string
	NetworkDisabled bool
}

Note: the Config structure should hold only portable information about the container. Here, "portable" means "independent from the host we are running on". Non-portable information *should* appear in HostConfig.

type Container 

type Container struct {
	sync.Mutex

	ID string

	Created time.Time

	Path string
	Args []string

	Config *Config
	State  State
	Image  string

	NetworkSettings *NetworkSettings

	ResolvConfPath string
	HostnamePath   string
	HostsPath      string
	Name           string
	Driver         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 

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() ([]archive.Change, error)

func (*Container) Copy 

func (container *Container) Copy(resource string) (archive.Archive, error)

func (*Container) EnvConfigPath 

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

func (*Container) Export 

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

func (*Container) ExportRw 

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

func (*Container) Exposes 

func (container *Container) Exposes(p Port) bool

Returns true if the container exposes a certain port

func (*Container) FromDisk 

func (container *Container) FromDisk() error

func (*Container) GetImage 

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

func (*Container) GetPtyMaster 

func (container *Container) GetPtyMaster() (*os.File, error)

func (*Container) GetSize 

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

GetSize, return real size, virtual size

func (*Container) Inject 

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

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

func (*Container) ReadLog 

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

func (*Container) Resize 

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

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

func (*Container) StderrPipe 

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

func (*Container) StdinPipe 

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

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 DaemonConfig 

type DaemonConfig struct {
	Pidfile                     string
	Root                        string
	AutoRestart                 bool
	EnableCors                  bool
	Dns                         []string
	EnableIptables              bool
	BridgeIface                 string
	BridgeIp                    string
	DefaultIp                   net.IP
	InterContainerCommunication bool
	GraphDriver                 string
	Mtu                         int
}

FIXME: separate runtime configuration from http api configuration

func ConfigFromJob 

func ConfigFromJob(job *engine.Job) *DaemonConfig

ConfigFromJob creates and returns a new DaemonConfig object by parsing the contents of a job's environment.

type DockerCli 

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

func NewDockerCli 

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

func (*DockerCli) CmdAttach 

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

func (*DockerCli) CmdBuild 

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

func (*DockerCli) CmdCommit 

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

func (*DockerCli) CmdCp 

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

func (*DockerCli) CmdDiff 

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

func (*DockerCli) CmdEvents 

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

func (*DockerCli) CmdExport 

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

func (*DockerCli) CmdHelp 

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

func (*DockerCli) CmdHistory 

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

func (*DockerCli) CmdImages 

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

func (*DockerCli) CmdImport 

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

func (*DockerCli) CmdInfo 

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

'docker info': display system-wide information.

func (*DockerCli) CmdInsert 

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

func (*DockerCli) CmdInspect 

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

func (*DockerCli) CmdKill 

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

'docker kill NAME' kills a running container

func (*DockerCli) CmdLoad 

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

func (*DockerCli) CmdLogin 

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

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

func (*DockerCli) CmdLogs 

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

func (*DockerCli) CmdPort 

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

func (*DockerCli) CmdPs 

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

func (*DockerCli) CmdPull 

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

func (*DockerCli) CmdPush 

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

func (*DockerCli) CmdRestart 

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

func (*DockerCli) CmdRm 

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

func (*DockerCli) CmdRmi 

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

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

func (*DockerCli) CmdRun 

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

func (*DockerCli) CmdSave 

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

func (*DockerCli) CmdSearch 

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

func (*DockerCli) CmdStart 

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

func (*DockerCli) CmdStop 

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

func (*DockerCli) CmdTag 

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

func (*DockerCli) CmdTop 

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

func (*DockerCli) CmdVersion 

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

'docker version': show version information

func (*DockerCli) CmdWait 

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

'docker wait': block until a container stops

func (*DockerCli) LoadConfigFile 

func (cli *DockerCli) LoadConfigFile() (err error)

func (*DockerCli) Subcmd 

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

func (*DockerCli) WalkTree 

func (cli *DockerCli) WalkTree(noTrunc bool, images *engine.Table, byParent map[string]*engine.Table, prefix string, printNode func(cli *DockerCli, noTrunc bool, image *engine.Env, prefix string))

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, driver graphdriver.Driver) (*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) 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.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) Driver 

func (graph *Graph) Driver() graphdriver.Driver

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 

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(jsonData []byte, layerData archive.Archive, img *Image) (err error)

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

func (*Graph) TempLayerArchive 

func (graph *Graph) TempLayerArchive(id string, compression archive.Compression, sf *utils.StreamFormatter, output io.Writer) (*archive.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 History 

type History []*Container

History is a convenience type for storing a list of containers, ordered by creation date.

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 

type HostConfig struct {
	Binds           []string
	ContainerIDFile string
	LxcConf         []KeyValuePair
	Privileged      bool
	PortBindings    map[Port][]PortBinding
	Links           []string
	PublishAllPorts bool
}

type HttpApiFunc 

type HttpApiFunc func(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error

type Image 

type Image struct {
	ID              string    `json:"id"`
	Parent          string    `json:"parent,omitempty"`
	Comment         string    `json:"comment,omitempty"`
	Created         time.Time `json:"created"`
	Container       string    `json:"container,omitempty"`
	ContainerConfig Config    `json:"container_config,omitempty"`
	DockerVersion   string    `json:"docker_version,omitempty"`
	Author          string    `json:"author,omitempty"`
	Config          *Config   `json:"config,omitempty"`
	Architecture    string    `json:"architecture,omitempty"`
	OS              string    `json:"os,omitempty"`

	Size int64
	// 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 (*Image) Depth 

func (img *Image) Depth() (int, error)

Depth returns the number of parents for a current image

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

func (img *Image) SaveSize(root string) error

SaveSize stores the current `size` value of `img` in the directory `root`.

func (*Image) TarLayer 

func (img *Image) TarLayer() (arch archive.Archive, err 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 KeyValuePair 

type KeyValuePair struct {
	Key   string
	Value string
}
type Link struct {
	ParentIP         string
	ChildIP          string
	Name             string
	BridgeInterface  string
	ChildEnvironment []string
	Ports            []Port
	IsEnabled        bool
}
func NewLink(parent, child *Container, name, bridgeInterface string) (*Link, error)

func (*Link) Alias 

func (l *Link) Alias() string

func (*Link) Disable 

func (l *Link) Disable()

func (*Link) Enable 

func (l *Link) Enable() error

func (*Link) ToEnv 

func (l *Link) ToEnv() []string

type ListOpts 

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

ListOpts type

func NewListOpts 

func NewListOpts(validator ValidatorFctType) ListOpts

func (*ListOpts) Delete 

func (opts *ListOpts) Delete(key string)

Delete remove the given element from the slice.

func (*ListOpts) Get 

func (opts *ListOpts) Get(key string) bool

Get checks the existence of the given key.

func (*ListOpts) GetAll 

func (opts *ListOpts) GetAll() []string

GetAll returns the values' slice. FIXME: Can we remove this?

func (*ListOpts) GetMap 

func (opts *ListOpts) GetMap() map[string]struct{}

GetMap returns the content of values in a map in order to avoid duplicates. FIXME: can we remove this?

func (*ListOpts) Len 

func (opts *ListOpts) Len() int

Len returns the amount of element in the slice.

func (*ListOpts) Set 

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

Set validates if needed the input value and add it to the internal slice.

func (*ListOpts) String 

func (opts *ListOpts) String() string

type Nat 

type Nat struct {
	Port    Port
	Binding PortBinding
}

func (*Nat) String 

func (n *Nat) String() string

type NetworkInterface 

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

Network interface represents the networking stack of a container

func (*NetworkInterface) AllocatePort 

func (iface *NetworkInterface) AllocatePort(port Port, binding PortBinding) (*Nat, error)

Allocate an external 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

func (*NetworkManager) Close 

func (manager *NetworkManager) Close() error

type NetworkSettings 

type NetworkSettings struct {
	IPAddress   string
	IPPrefixLen int
	Gateway     string
	Bridge      string
	PortMapping map[string]PortMapping // Deprecated
	Ports       map[Port][]PortBinding
}

func (*NetworkSettings) PortMappingAPI 

func (settings *NetworkSettings) PortMappingAPI() *engine.Table

type Port 

type Port string

80/tcp

func NewPort 

func NewPort(proto, port string) Port

func (Port) Int 

func (p Port) Int() int

func (Port) Port 

func (p Port) Port() string

func (Port) Proto 

func (p Port) Proto() string

type PortAllocator 

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

Port allocator: Automatically allocate and release networking ports

func (*PortAllocator) Acquire 

func (alloc *PortAllocator) Acquire(addr net.IP, port int) (int, error)

func (*PortAllocator) Close 

func (alloc *PortAllocator) Close() error

func (*PortAllocator) Release 

func (alloc *PortAllocator) Release(addr net.IP, port int) error

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

type PortBinding 

type PortBinding struct {
	HostIp   string
	HostPort string
}

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(ip net.IP, port int, backendAddr net.Addr) error

func (*PortMapper) Unmap 

func (mapper *PortMapper) Unmap(ip net.IP, port int, proto string) error

type PortMapping 

type PortMapping map[string]string // Deprecated

type Repository 

type Repository map[string]string

type Runtime 

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

func NewRuntime 

func NewRuntime(config *DaemonConfig) (*Runtime, error)

FIXME: harmonize with NewGraph()

func NewRuntimeFromDirectory 

func NewRuntimeFromDirectory(config *DaemonConfig) (*Runtime, error)

func (*Runtime) Changes 

func (runtime *Runtime) Changes(container *Container) ([]archive.Change, error)

func (*Runtime) Children 

func (runtime *Runtime) Children(name string) (map[string]*Container, error)

func (*Runtime) Close 

func (runtime *Runtime) Close() error

func (*Runtime) Commit 

func (runtime *Runtime) 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 (*Runtime) Create 

func (runtime *Runtime) Create(config *Config, name string) (*Container, []string, error)

Create creates a new container from the given configuration with a given name.

func (*Runtime) Destroy 

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

Destroy unregisters a container from the runtime and cleanly removes its contents from the filesystem.

func (*Runtime) Diff 

func (runtime *Runtime) Diff(container *Container) (archive.Archive, error)

func (*Runtime) Exists 

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

Exists returns a true if a container of the specified ID or name exists, false otherwise.

func (*Runtime) Get 

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

Get looks for a container by the specified ID or name, and returns it. If the container is not found, or if an error occurs, nil is returned.

func (*Runtime) GetByName 

func (runtime *Runtime) GetByName(name string) (*Container, error)

func (*Runtime) Graph 

func (runtime *Runtime) Graph() *Graph

FIXME: this is a convenience function for integration tests which need direct access to runtime.graph. Once the tests switch to using engine and jobs, this method can go away.

func (*Runtime) Kill 

func (runtime *Runtime) Kill(c *Container, sig int) error

func (*Runtime) List 

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

List returns an array of all containers registered in the runtime.

func (*Runtime) LogToDisk 

func (runtime *Runtime) LogToDisk(src *utils.WriteBroadcaster, dst, stream string) error

func (*Runtime) Mount 

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

func (*Runtime) Nuke 

func (runtime *Runtime) Nuke() error

Nuke kills all containers then removes all content from the content root, including images, volumes and container filesystems. Again: this will remove your entire docker runtime!

func (*Runtime) Register 

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

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

func (runtime *Runtime) RegisterLink(parent, child *Container, alias string) error

func (*Runtime) RestoreCommand 

func (runtime *Runtime) RestoreCommand(c *Container) error

func (*Runtime) Run 

func (runtime *Runtime) Run(c *Container, startCallback execdriver.StartCallback) (int, error)

func (*Runtime) Unmount 

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

type Server 

type Server struct {
	sync.RWMutex

	Eng *engine.Engine
	// contains filtered or unexported fields
}

func NewServer 

func NewServer(eng *engine.Engine, config *DaemonConfig) (*Server, error)

func (*Server) AddEvent 

func (srv *Server) AddEvent(jm utils.JSONMessage)

func (*Server) Auth 

func (srv *Server) Auth(job *engine.Job) engine.Status

func (*Server) Build 

func (srv *Server) Build(job *engine.Job) engine.Status

func (*Server) Close 

func (srv *Server) Close() error

func (*Server) ContainerAttach 

func (srv *Server) ContainerAttach(job *engine.Job) engine.Status

func (*Server) ContainerChanges 

func (srv *Server) ContainerChanges(job *engine.Job) engine.Status

func (*Server) ContainerCommit 

func (srv *Server) ContainerCommit(job *engine.Job) engine.Status

func (*Server) ContainerCopy 

func (srv *Server) ContainerCopy(job *engine.Job) engine.Status

func (*Server) ContainerCreate 

func (srv *Server) ContainerCreate(job *engine.Job) engine.Status

func (*Server) ContainerDestroy 

func (srv *Server) ContainerDestroy(job *engine.Job) engine.Status

func (*Server) ContainerExport 

func (srv *Server) ContainerExport(job *engine.Job) engine.Status

func (*Server) ContainerInspect 

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

func (*Server) ContainerKill 

func (srv *Server) ContainerKill(job *engine.Job) engine.Status

ContainerKill send signal to the container If no signal is given (sig 0), then Kill with SIGKILL and wait for the container to exit. If a signal is given, then just send it to the container and return.

func (*Server) ContainerResize 

func (srv *Server) ContainerResize(job *engine.Job) engine.Status

func (*Server) ContainerRestart 

func (srv *Server) ContainerRestart(job *engine.Job) engine.Status

func (*Server) ContainerStart 

func (srv *Server) ContainerStart(job *engine.Job) engine.Status

func (*Server) ContainerStop 

func (srv *Server) ContainerStop(job *engine.Job) engine.Status

func (*Server) ContainerTop 

func (srv *Server) ContainerTop(job *engine.Job) engine.Status

func (*Server) ContainerWait 

func (srv *Server) ContainerWait(job *engine.Job) engine.Status

func (*Server) Containers 

func (srv *Server) Containers(job *engine.Job) engine.Status

func (*Server) DeleteImage 

func (srv *Server) DeleteImage(name string, autoPrune bool) (*engine.Table, error)

func (*Server) DockerInfo 

func (srv *Server) DockerInfo(job *engine.Job) engine.Status

func (*Server) Events 

func (srv *Server) Events(job *engine.Job) engine.Status

func (*Server) GetEvents 

func (srv *Server) GetEvents() []utils.JSONMessage

func (*Server) HTTPRequestFactory 

func (srv *Server) HTTPRequestFactory(metaHeaders map[string][]string) *utils.HTTPRequestFactory

func (*Server) ImageDelete 

func (srv *Server) ImageDelete(job *engine.Job) engine.Status

func (*Server) ImageExport 

func (srv *Server) ImageExport(job *engine.Job) engine.Status

ImageExport exports all images with the given tag. All versions containing the same tag are exported. The resulting output is an uncompressed tar ball. name is the set of tags to export. out is the writer where the images are written to.

func (*Server) ImageGetCached 

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

func (*Server) ImageHistory 

func (srv *Server) ImageHistory(job *engine.Job) engine.Status

func (*Server) ImageImport 

func (srv *Server) ImageImport(job *engine.Job) engine.Status

func (*Server) ImageInsert 

func (srv *Server) ImageInsert(job *engine.Job) engine.Status

func (*Server) ImageInspect 

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

func (*Server) ImageLoad 

func (srv *Server) ImageLoad(job *engine.Job) engine.Status

Loads a set of images into the repository. This is the complementary of ImageExport. The input stream is an uncompressed tar ball containing images and metadata.

func (*Server) ImagePull 

func (srv *Server) ImagePull(job *engine.Job) engine.Status

func (*Server) ImagePush 

func (srv *Server) ImagePush(job *engine.Job) engine.Status

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

func (*Server) ImageTag 

func (srv *Server) ImageTag(job *engine.Job) engine.Status

func (*Server) Images 

func (srv *Server) Images(job *engine.Job) engine.Status

func (*Server) ImagesSearch 

func (srv *Server) ImagesSearch(job *engine.Job) engine.Status

func (*Server) ImagesViz 

func (srv *Server) ImagesViz(job *engine.Job) engine.Status

func (*Server) JobInspect 

func (srv *Server) JobInspect(job *engine.Job) engine.Status

func (*Server) ListenAndServe 

func (srv *Server) ListenAndServe(job *engine.Job) engine.Status

func (*Server) LogEvent 

func (srv *Server) LogEvent(action, id, from string) *utils.JSONMessage
func (srv *Server) RegisterLinks(container *Container, hostConfig *HostConfig) error

type State 

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

func (*State) GetExitCode 

func (s *State) GetExitCode() int

func (*State) IsGhost 

func (s *State) IsGhost() bool

func (*State) IsRunning 

func (s *State) IsRunning() bool

func (*State) SetGhost 

func (s *State) SetGhost(val bool)

func (*State) SetRunning 

func (s *State) SetRunning(pid int)

func (*State) SetStopped 

func (s *State) SetStopped(exitCode int)

func (*State) String 

func (s *State) String() string

String returns a human-readable description of the state

type StderrFormater 

type StderrFormater struct {
	io.Writer
	*utils.StreamFormatter
}

func (*StderrFormater) Write 

func (sf *StderrFormater) Write(buf []byte) (int, error)

type StdoutFormater 

type StdoutFormater struct {
	io.Writer
	*utils.StreamFormatter
}

func (*StdoutFormater) Write 

func (sf *StdoutFormater) Write(buf []byte) (int, error)

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

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

func (*TagStore) DeleteAll 

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 ValidatorFctType 

type ValidatorFctType func(val string) (string, error)

Validators

Source Files

View all Source files

Directories

Path Synopsis
docker-device-tool
host-integration
chroot
lxc
aufs
devmapper
vfs
ipallocator
pkg
cgroups
graphdb
iptables
mflag
Package flag implements command-line flag parsing.
 Package flag implements command-line flag parsing.
mflag/example
mount
namesgenerator
netlink
Packet netlink provide access to low level Netlink sockets and messages.
 Packet netlink provide access to low level Netlink sockets and messages.
sysinfo
systemd
term

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.