docker

package
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: Sep 25, 2015 License: BSD-2-Clause, Apache-2.0 Imports: 30 Imported by: 0

README

go-dockerclient

Drone Travis GoDoc

This package presents a client for the Docker remote API. It also provides support for the extensions in the Swarm API.

This package also provides support for docker's network API, which is a simple passthrough to the libnetwork remote API. Note that docker's network API is only available in docker 1.8 and above, and only enabled in docker if DOCKER_EXPERIMENTAL is defined during the docker build process.

For more details, check the remote API documentation.

Vendoring

If you are having issues with Go 1.5 and have GO15VENDOREXPERIMENT set with an application that has go-dockerclient vendored, please update your vendoring of go-dockerclient :) We recently moved the vendor directory to external so that go-dockerclient is compatible with this configuration. See 338 and 339 for details.

Example

package main

import (
	"fmt"

	"github.com/fsouza/go-dockerclient"
)

func main() {
	endpoint := "unix:///var/run/docker.sock"
	client, _ := docker.NewClient(endpoint)
	imgs, _ := client.ListImages(docker.ListImagesOptions{All: false})
	for _, img := range imgs {
		fmt.Println("ID: ", img.ID)
		fmt.Println("RepoTags: ", img.RepoTags)
		fmt.Println("Created: ", img.Created)
		fmt.Println("Size: ", img.Size)
		fmt.Println("VirtualSize: ", img.VirtualSize)
		fmt.Println("ParentId: ", img.ParentID)
	}
}

Using with TLS

In order to instantiate the client for a TLS-enabled daemon, you should use NewTLSClient, passing the endpoint and path for key and certificates as parameters.

package main

import (
	"fmt"

	"github.com/fsouza/go-dockerclient"
)

func main() {
	endpoint := "tcp://[ip]:[port]"
	path := os.Getenv("DOCKER_CERT_PATH")
	ca := fmt.Sprintf("%s/ca.pem", path)
	cert := fmt.Sprintf("%s/cert.pem", path)
	key := fmt.Sprintf("%s/key.pem", path)
	client, _ := docker.NewTLSClient(endpoint, cert, key, ca)
	// use client
}

If using docker-machine, or another application that exports environment variables DOCKER_HOST, DOCKER_TLS_VERIFY, DOCKER_CERT_PATH, you can use NewClientFromEnv.

package main

import (
	"fmt"

	"github.com/fsouza/go-dockerclient"
)

func main() {
	client, _ := docker.NewClientFromEnv()
	// use client
}

See the documentation for more details.

Developing

All development commands can be seen in the Makefile.

Commited code must pass:

Running make test will check all of these. If your editor does not automatically call gofmt, make fmt will format all go files in this repository.

Documentation

Overview

Package docker provides a client for the Docker remote API.

See https://goo.gl/G3plxW for more details on the remote API.

Index

Examples

Constants

View Source 
const (
	SIGABRT   = Signal(0x6)
	SIGALRM   = Signal(0xe)
	SIGBUS    = Signal(0x7)
	SIGCHLD   = Signal(0x11)
	SIGCLD    = Signal(0x11)
	SIGCONT   = Signal(0x12)
	SIGFPE    = Signal(0x8)
	SIGHUP    = Signal(0x1)
	SIGILL    = Signal(0x4)
	SIGINT    = Signal(0x2)
	SIGIO     = Signal(0x1d)
	SIGIOT    = Signal(0x6)
	SIGKILL   = Signal(0x9)
	SIGPIPE   = Signal(0xd)
	SIGPOLL   = Signal(0x1d)
	SIGPROF   = Signal(0x1b)
	SIGPWR    = Signal(0x1e)
	SIGQUIT   = Signal(0x3)
	SIGSEGV   = Signal(0xb)
	SIGSTKFLT = Signal(0x10)
	SIGSTOP   = Signal(0x13)
	SIGSYS    = Signal(0x1f)
	SIGTERM   = Signal(0xf)
	SIGTRAP   = Signal(0x5)
	SIGTSTP   = Signal(0x14)
	SIGTTIN   = Signal(0x15)
	SIGTTOU   = Signal(0x16)
	SIGUNUSED = Signal(0x1f)
	SIGURG    = Signal(0x17)
	SIGUSR1   = Signal(0xa)
	SIGUSR2   = Signal(0xc)
	SIGVTALRM = Signal(0x1a)
	SIGWINCH  = Signal(0x1c)
	SIGXCPU   = Signal(0x18)
	SIGXFSZ   = Signal(0x19)
)

These values represent all signals available on Linux, where containers will be running.

Variables

View Source 
var (
	// ErrInvalidEndpoint is returned when the endpoint is not a valid HTTP URL.
	ErrInvalidEndpoint = errors.New("invalid endpoint")

	// ErrConnectionRefused is returned when the client cannot connect to the given endpoint.
	ErrConnectionRefused = errors.New("cannot connect to Docker endpoint")
)
View Source 
var (
	// ErrNoListeners is the error returned when no listeners are available
	// to receive an event.
	ErrNoListeners = errors.New("no listeners present to receive event")

	// ErrListenerAlreadyExists is the error returned when the listerner already
	// exists.
	ErrListenerAlreadyExists = errors.New("listener already exists for docker events")

	// EOFEvent is sent when the event listener receives an EOF error.
	EOFEvent = &APIEvents{
		Status: "EOF",
	}
)
View Source 
var (
	// ErrNoSuchImage is the error returned when the image does not exist.
	ErrNoSuchImage = errors.New("no such image")

	// ErrMissingRepo is the error returned when the remote repository is
	// missing.
	ErrMissingRepo = errors.New("missing remote repository e.g. 'github.com/user/repo'")

	// ErrMissingOutputStream is the error returned when no output stream
	// is provided to some calls, like BuildImage.
	ErrMissingOutputStream = errors.New("missing output stream")

	// ErrMultipleContexts is the error returned when both a ContextDir and
	// InputStream are provided in BuildImageOptions
	ErrMultipleContexts = errors.New("image build may not be provided BOTH context dir and input stream")

	// ErrMustSpecifyNames is the error rreturned when the Names field on
	// ExportImagesOptions is nil or empty
	ErrMustSpecifyNames = errors.New("must specify at least one name to export")
)
View Source 
var (
	// ErrNoSuchVolume is the error returned when the volume does not exist.
	ErrNoSuchVolume = errors.New("no such volume")

	// ErrVolumeInUse is the error returned when the volume requested to be removed is still in use.
	ErrVolumeInUse = errors.New("volume in use and cannot be removed")
)
View Source 
var ErrCannotParseDockercfg = errors.New("Failed to read authentication from dockercfg")

ErrCannotParseDockercfg is the error returned by NewAuthConfigurations when the dockercfg cannot be parsed.

View Source 
var ErrContainerAlreadyExists = errors.New("container already exists")

ErrContainerAlreadyExists is the error returned by CreateContainer when the container already exists.

View Source 
var ErrNetworkAlreadyExists = errors.New("network already exists")

ErrNetworkAlreadyExists is the error returned by CreateNetwork when the network already exists.

Functions

func ParseRepositoryTag 

func ParseRepositoryTag(repoTag string) (repository string, tag string)

ParseRepositoryTag gets the name of the repository and returns it splitted in two parts: the repository and the tag.

Some examples: 

localhost.localdomain:5000/samalba/hipache:latest -> localhost.localdomain:5000/samalba/hipache, latest
localhost.localdomain:5000/samalba/hipache -> localhost.localdomain:5000/samalba/hipache, ""

Types

type APIContainers 

type APIContainers struct {
	ID         string            `json:"Id" yaml:"Id"`
	Image      string            `json:"Image,omitempty" yaml:"Image,omitempty"`
	Command    string            `json:"Command,omitempty" yaml:"Command,omitempty"`
	Created    int64             `json:"Created,omitempty" yaml:"Created,omitempty"`
	Status     string            `json:"Status,omitempty" yaml:"Status,omitempty"`
	Ports      []APIPort         `json:"Ports,omitempty" yaml:"Ports,omitempty"`
	SizeRw     int64             `json:"SizeRw,omitempty" yaml:"SizeRw,omitempty"`
	SizeRootFs int64             `json:"SizeRootFs,omitempty" yaml:"SizeRootFs,omitempty"`
	Names      []string          `json:"Names,omitempty" yaml:"Names,omitempty"`
	Labels     map[string]string `json:"Labels,omitempty" yaml:"Labels, omitempty"`
}

APIContainers represents each container in the list returned by ListContainers.

type APIEvents 

type APIEvents struct {
	Status string `json:"Status,omitempty" yaml:"Status,omitempty"`
	ID     string `json:"ID,omitempty" yaml:"ID,omitempty"`
	From   string `json:"From,omitempty" yaml:"From,omitempty"`
	Time   int64  `json:"Time,omitempty" yaml:"Time,omitempty"`
}

APIEvents represents an event returned by the API.

type APIImageSearch added in v0.5.1 

type APIImageSearch struct {
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
	IsOfficial  bool   `json:"is_official,omitempty" yaml:"is_official,omitempty"`
	IsAutomated bool   `json:"is_automated,omitempty" yaml:"is_automated,omitempty"`
	Name        string `json:"name,omitempty" yaml:"name,omitempty"`
	StarCount   int    `json:"star_count,omitempty" yaml:"star_count,omitempty"`
}

APIImageSearch reflect the result of a search on the Docker Hub.

See https://goo.gl/AYjyrF for more details.

type APIImages 

type APIImages struct {
	ID          string            `json:"Id" yaml:"Id"`
	RepoTags    []string          `json:"RepoTags,omitempty" yaml:"RepoTags,omitempty"`
	Created     int64             `json:"Created,omitempty" yaml:"Created,omitempty"`
	Size        int64             `json:"Size,omitempty" yaml:"Size,omitempty"`
	VirtualSize int64             `json:"VirtualSize,omitempty" yaml:"VirtualSize,omitempty"`
	ParentID    string            `json:"ParentId,omitempty" yaml:"ParentId,omitempty"`
	RepoDigests []string          `json:"RepoDigests,omitempty" yaml:"RepoDigests,omitempty"`
	Labels      map[string]string `json:"Labels,omitempty" yaml:"Labels,omitempty"`
}

APIImages represent an image returned in the ListImages call.

type APIPort 

type APIPort struct {
	PrivatePort int64  `json:"PrivatePort,omitempty" yaml:"PrivatePort,omitempty"`
	PublicPort  int64  `json:"PublicPort,omitempty" yaml:"PublicPort,omitempty"`
	Type        string `json:"Type,omitempty" yaml:"Type,omitempty"`
	IP          string `json:"IP,omitempty" yaml:"IP,omitempty"`
}

APIPort is a type that represents a port mapping returned by the Docker API

type APIVersion added in v0.7.2 

type APIVersion []int

APIVersion is an internal representation of a version of the Remote API.

func NewAPIVersion added in v0.7.2 

func NewAPIVersion(input string) (APIVersion, error)

NewAPIVersion returns an instance of APIVersion for the given string.

The given string must be in the form <major>.<minor>.<patch>, where <major>, <minor> and <patch> are integer numbers.

func (APIVersion) GreaterThan added in v0.7.2 

func (version APIVersion) GreaterThan(other APIVersion) bool

GreaterThan is a function for comparing APIVersion structs

func (APIVersion) GreaterThanOrEqualTo added in v0.7.2 

func (version APIVersion) GreaterThanOrEqualTo(other APIVersion) bool

GreaterThanOrEqualTo is a function for comparing APIVersion structs

func (APIVersion) LessThan added in v0.7.2 

func (version APIVersion) LessThan(other APIVersion) bool

LessThan is a function for comparing APIVersion structs

func (APIVersion) LessThanOrEqualTo added in v0.7.2 

func (version APIVersion) LessThanOrEqualTo(other APIVersion) bool

LessThanOrEqualTo is a function for comparing APIVersion structs

func (APIVersion) String added in v0.7.2 

func (version APIVersion) String() string

type AttachToContainerOptions 

type AttachToContainerOptions struct {
	Container    string    `qs:"-"`
	InputStream  io.Reader `qs:"-"`
	OutputStream io.Writer `qs:"-"`
	ErrorStream  io.Writer `qs:"-"`

	// Get container logs, sending it to OutputStream.
	Logs bool

	// Stream the response?
	Stream bool

	// Attach to stdin, and use InputStream.
	Stdin bool

	// Attach to stdout, and use OutputStream.
	Stdout bool

	// Attach to stderr, and use ErrorStream.
	Stderr bool

	// If set, after a successful connect, a sentinel will be sent and then the
	// client will block on receive before continuing.
	//
	// It must be an unbuffered channel. Using a buffered channel can lead
	// to unexpected behavior.
	Success chan struct{}

	// Use raw terminal? Usually true when the container contains a TTY.
	RawTerminal bool `qs:"-"`
}

AttachToContainerOptions is the set of options that can be used when attaching to a container.

See https://goo.gl/NKpkFk for more details.

type AuthConfiguration 

type AuthConfiguration struct {
	Username      string `json:"username,omitempty"`
	Password      string `json:"password,omitempty"`
	Email         string `json:"email,omitempty"`
	ServerAddress string `json:"serveraddress,omitempty"`
}

AuthConfiguration represents authentication options to use in the PushImage method. It represents the authentication in the Docker index server.

type AuthConfigurations added in v0.7.2 

type AuthConfigurations struct {
	Configs map[string]AuthConfiguration `json:"configs"`
}

AuthConfigurations represents authentication options to use for the PushImage method accommodating the new X-Registry-Config header

func NewAuthConfigurations added in v0.16.0 

func NewAuthConfigurations(r io.Reader) (*AuthConfigurations, error)

NewAuthConfigurations returns AuthConfigurations from a JSON encoded string in the same format as the .dockercfg file.

func NewAuthConfigurationsFromDockerCfg added in v0.16.0 

func NewAuthConfigurationsFromDockerCfg() (*AuthConfigurations, error)

NewAuthConfigurationsFromDockerCfg returns AuthConfigurations from the ~/.dockercfg file.

type AuthConfigurations119 added in v1.1.0 

type AuthConfigurations119 map[string]AuthConfiguration

AuthConfigurations119 is used to serialize a set of AuthConfigurations for Docker API >= 1.19.

type BlkioStatsEntry added in v0.18.0 

type BlkioStatsEntry struct {
	Major uint64 `json:"major,omitempty" yaml:"major,omitempty"`
	Minor uint64 `json:"minor,omitempty" yaml:"minor,omitempty"`
	Op    string `json:"op,omitempty" yaml:"op,omitempty"`
	Value uint64 `json:"value,omitempty" yaml:"value,omitempty"`
}

BlkioStatsEntry is a stats entry for blkio_stats

type BuildImageOptions 

type BuildImageOptions struct {
	Name                string             `qs:"t"`
	Dockerfile          string             `qs:"dockerfile"`
	NoCache             bool               `qs:"nocache"`
	SuppressOutput      bool               `qs:"q"`
	Pull                bool               `qs:"pull"`
	RmTmpContainer      bool               `qs:"rm"`
	ForceRmTmpContainer bool               `qs:"forcerm"`
	Memory              int64              `qs:"memory"`
	Memswap             int64              `qs:"memswap"`
	CPUShares           int64              `qs:"cpushares"`
	CPUSetCPUs          string             `qs:"cpusetcpus"`
	InputStream         io.Reader          `qs:"-"`
	OutputStream        io.Writer          `qs:"-"`
	RawJSONStream       bool               `qs:"-"`
	Remote              string             `qs:"remote"`
	Auth                AuthConfiguration  `qs:"-"` // for older docker X-Registry-Auth header
	AuthConfigs         AuthConfigurations `qs:"-"` // for newer docker X-Registry-Config header
	ContextDir          string             `qs:"-"`
}

BuildImageOptions present the set of informations available for building an image from a tarfile with a Dockerfile in it.

For more details about the Docker building process, see http://goo.gl/tlPXPu.

type CPUStats added in v1.1.0 

type CPUStats struct {
	CPUUsage struct {
		PercpuUsage       []uint64 `json:"percpu_usage,omitempty" yaml:"percpu_usage,omitempty"`
		UsageInUsermode   uint64   `json:"usage_in_usermode,omitempty" yaml:"usage_in_usermode,omitempty"`
		TotalUsage        uint64   `json:"total_usage,omitempty" yaml:"total_usage,omitempty"`
		UsageInKernelmode uint64   `json:"usage_in_kernelmode,omitempty" yaml:"usage_in_kernelmode,omitempty"`
	} `json:"cpu_usage,omitempty" yaml:"cpu_usage,omitempty"`
	SystemCPUUsage uint64 `json:"system_cpu_usage,omitempty" yaml:"system_cpu_usage,omitempty"`
	ThrottlingData struct {
		Periods          uint64 `json:"periods,omitempty"`
		ThrottledPeriods uint64 `json:"throttled_periods,omitempty"`
		ThrottledTime    uint64 `json:"throttled_time,omitempty"`
	} `json:"throttling_data,omitempty" yaml:"throttling_data,omitempty"`
}

CPUStats is a stats entry for cpu stats

type Change 

type Change struct {
	Path string
	Kind ChangeType
}

Change represents a change in a container.

See https://goo.gl/9GsTIF for more details.

func (*Change) String 

func (change *Change) String() string

type ChangeType 

type ChangeType int

ChangeType is a type for constants indicating the type of change in a container 

const (
	// ChangeModify is the ChangeType for container modifications
	ChangeModify ChangeType = iota

	// ChangeAdd is the ChangeType for additions to a container
	ChangeAdd

	// ChangeDelete is the ChangeType for deletions from a container
	ChangeDelete
)

type Client 

type Client struct {
	SkipServerVersionCheck bool
	HTTPClient             *http.Client
	TLSConfig              *tls.Config
	// contains filtered or unexported fields
}

Client is the basic type of this package. It provides methods for interaction with the API.

func NewClient 

func NewClient(endpoint string) (*Client, error)

NewClient returns a Client instance ready for communication with the given server endpoint. It will use the latest remote API version available in the server.

func NewClientFromEnv added in v1.1.0 

func NewClientFromEnv() (*Client, error)

NewClientFromEnv returns a Client instance ready for communication created from Docker's default logic for the environment variables DOCKER_HOST, DOCKER_TLS_VERIFY, and DOCKER_CERT_PATH.

See https://github.com/docker/docker/blob/1f963af697e8df3a78217f6fdbf67b8123a7db94/docker/docker.go#L68. See https://github.com/docker/compose/blob/81707ef1ad94403789166d2fe042c8a718a4c748/compose/cli/docker_client.py#L7.

func NewTLSClient added in v0.7.2 

func NewTLSClient(endpoint string, cert, key, ca string) (*Client, error)

NewTLSClient returns a Client instance ready for TLS communications with the givens server endpoint, key and certificates . It will use the latest remote API version available in the server.

func NewTLSClientFromBytes added in v1.1.0 

func NewTLSClientFromBytes(endpoint string, certPEMBlock, keyPEMBlock, caPEMCert []byte) (*Client, error)

NewTLSClientFromBytes returns a Client instance ready for TLS communications with the givens server endpoint, key and certificates (passed inline to the function as opposed to being read from a local file). It will use the latest remote API version available in the server.

func NewVersionedClient 

func NewVersionedClient(endpoint string, apiVersionString string) (*Client, error)

NewVersionedClient returns a Client instance ready for communication with the given server endpoint, using a specific remote API version.

func NewVersionedClientFromEnv added in v1.1.0 

func NewVersionedClientFromEnv(apiVersionString string) (*Client, error)

NewVersionedClientFromEnv returns a Client instance ready for TLS communications created from Docker's default logic for the environment variables DOCKER_HOST, DOCKER_TLS_VERIFY, and DOCKER_CERT_PATH, and using a specific remote API version.

See https://github.com/docker/docker/blob/1f963af697e8df3a78217f6fdbf67b8123a7db94/docker/docker.go#L68. See https://github.com/docker/compose/blob/81707ef1ad94403789166d2fe042c8a718a4c748/compose/cli/docker_client.py#L7.

func NewVersionedTLSClient added in v0.16.0 

func NewVersionedTLSClient(endpoint string, cert, key, ca, apiVersionString string) (*Client, error)

NewVersionedTLSClient returns a Client instance ready for TLS communications with the givens server endpoint, key and certificates, using a specific remote API version.

func NewVersionedTLSClientFromBytes added in v1.1.0 

func NewVersionedTLSClientFromBytes(endpoint string, certPEMBlock, keyPEMBlock, caPEMCert []byte, apiVersionString string) (*Client, error)

NewVersionedTLSClientFromBytes returns a Client instance ready for TLS communications with the givens server endpoint, key and certificates (passed inline to the function as opposed to being read from a local file), using a specific remote API version.

func NewVersionnedTLSClient added in v0.7.2 

func NewVersionnedTLSClient(endpoint string, cert, key, ca, apiVersionString string) (*Client, error)

NewVersionnedTLSClient has been DEPRECATED, please use NewVersionedTLSClient.

func (*Client) AddEventListener 

func (c *Client) AddEventListener(listener chan<- *APIEvents) error

AddEventListener adds a new listener to container events in the Docker API.

The parameter is a channel through which events will be sent.

func (*Client) AttachToContainer 

func (c *Client) AttachToContainer(opts AttachToContainerOptions) error

AttachToContainer attaches to a container, using the given options.

See https://goo.gl/NKpkFk for more details.

Example 
client, err := docker.NewClient("http://localhost:4243")
if err != nil {
	log.Fatal(err)
}
client.SkipServerVersionCheck = true
// Reading logs from container a84849 and sending them to buf.
var buf bytes.Buffer
err = client.AttachToContainer(docker.AttachToContainerOptions{
	Container:    "a84849",
	OutputStream: &buf,
	Logs:         true,
	Stdout:       true,
	Stderr:       true,
})
if err != nil {
	log.Fatal(err)
}
log.Println(buf.String())
buf.Reset()
err = client.AttachToContainer(docker.AttachToContainerOptions{
	Container:    "a84849",
	OutputStream: &buf,
	Stdout:       true,
	Stream:       true,
})
if err != nil {
	log.Fatal(err)
}
log.Println(buf.String())

Output:

func (*Client) AuthCheck added in v1.1.0 

func (c *Client) AuthCheck(conf *AuthConfiguration) error

AuthCheck validates the given credentials. It returns nil if successful.

See https://goo.gl/m2SleN for more details.

func (*Client) BuildImage 

func (c *Client) BuildImage(opts BuildImageOptions) error

BuildImage builds an image from a tarball's url or a Dockerfile in the input stream.

See https://goo.gl/xySxCe for more details.

Example 
client, err := docker.NewClient("http://localhost:4243")
if err != nil {
	log.Fatal(err)
}

t := time.Now()
inputbuf, outputbuf := bytes.NewBuffer(nil), bytes.NewBuffer(nil)
tr := tar.NewWriter(inputbuf)
tr.WriteHeader(&tar.Header{Name: "Dockerfile", Size: 10, ModTime: t, AccessTime: t, ChangeTime: t})
tr.Write([]byte("FROM base\n"))
tr.Close()
opts := docker.BuildImageOptions{
	Name:         "test",
	InputStream:  inputbuf,
	OutputStream: outputbuf,
}
if err := client.BuildImage(opts); err != nil {
	log.Fatal(err)
}

Output:

func (*Client) CommitContainer 

func (c *Client) CommitContainer(opts CommitContainerOptions) (*Image, error)

CommitContainer creates a new image from a container's changes.

See https://goo.gl/mqfoCw for more details.

func (*Client) ContainerChanges 

func (c *Client) ContainerChanges(id string) ([]Change, error)

ContainerChanges returns changes in the filesystem of the given container.

See https://goo.gl/9GsTIF for more details.

func (*Client) CopyFromContainer 

func (c *Client) CopyFromContainer(opts CopyFromContainerOptions) error

CopyFromContainer copy files or folders from a container, using a given resource.

See https://goo.gl/4L7b07 for more details.

Example 
client, err := docker.NewClient("http://localhost:4243")
if err != nil {
	log.Fatal(err)
}
cid := "a84849"
var buf bytes.Buffer
filename := "/tmp/output.txt"
err = client.CopyFromContainer(docker.CopyFromContainerOptions{
	Container:    cid,
	Resource:     filename,
	OutputStream: &buf,
})
if err != nil {
	log.Fatalf("Error while copying from %s: %s\n", cid, err)
}
content := new(bytes.Buffer)
r := bytes.NewReader(buf.Bytes())
tr := tar.NewReader(r)
tr.Next()
if err != nil && err != io.EOF {
	log.Fatal(err)
}
if _, err := io.Copy(content, tr); err != nil {
	log.Fatal(err)
}
log.Println(buf.String())

Output:

func (*Client) CreateContainer 

func (c *Client) CreateContainer(opts CreateContainerOptions) (*Container, error)

CreateContainer creates a new container, returning the container instance, or an error in case of failure.

See https://goo.gl/WxQzrr for more details.

func (*Client) CreateExec added in v0.5.1 

func (c *Client) CreateExec(opts CreateExecOptions) (*Exec, error)

CreateExec sets up an exec instance in a running container `id`, returning the exec instance, or an error in case of failure.

See https://goo.gl/1KSIb7 for more details

func (*Client) CreateNetwork added in v1.1.0 

func (c *Client) CreateNetwork(opts CreateNetworkOptions) (*Network, error)

CreateNetwork creates a new network, returning the network instance, or an error in case of failure.

See http://goo.gl/mErxNp for more details.

func (*Client) CreateVolume added in v1.1.0 

func (c *Client) CreateVolume(opts CreateVolumeOptions) (*Volume, error)

CreateVolume creates a volume on the server.

See https://goo.gl/pBUbZ9 for more details.

func (*Client) ExportContainer 

func (c *Client) ExportContainer(opts ExportContainerOptions) error

ExportContainer export the contents of container id as tar archive and prints the exported contents to stdout.

See https://goo.gl/dOkTyk for more details.

func (*Client) ExportImage 

func (c *Client) ExportImage(opts ExportImageOptions) error

ExportImage exports an image (as a tar file) into the stream.

See https://goo.gl/le7vK8 for more details.

func (*Client) ExportImages added in v0.16.0 

func (c *Client) ExportImages(opts ExportImagesOptions) error

ExportImages exports one or more images (as a tar file) into the stream

See https://goo.gl/huC7HA for more details.

func (*Client) ImageHistory added in v0.5.1 

func (c *Client) ImageHistory(name string) ([]ImageHistory, error)

ImageHistory returns the history of the image by its name or ID.

See https://goo.gl/8bnTId for more details.

func (*Client) ImportImage 

func (c *Client) ImportImage(opts ImportImageOptions) error

ImportImage imports an image from a url, a file or stdin

See https://goo.gl/iJkZjD for more details.

func (*Client) Info 

func (c *Client) Info() (*Env, error)

Info returns system-wide information about the Docker server.

See https://goo.gl/ElTHi2 for more details.

func (*Client) InspectContainer 

func (c *Client) InspectContainer(id string) (*Container, error)

InspectContainer returns information about a container by its ID.

See https://goo.gl/RdIq0b for more details.

func (*Client) InspectExec added in v0.10.0 

func (c *Client) InspectExec(id string) (*ExecInspect, error)

InspectExec returns low-level information about the exec command id.

See https://goo.gl/gPtX9R for more details

func (*Client) InspectImage 

func (c *Client) InspectImage(name string) (*Image, error)

InspectImage returns an image by its name or ID.

See https://goo.gl/jHPcg6 for more details.

func (*Client) InspectVolume added in v1.1.0 

func (c *Client) InspectVolume(name string) (*Volume, error)

InspectVolume returns a volume by its name.

See https://goo.gl/0g9A6i for more details.

func (*Client) KillContainer 

func (c *Client) KillContainer(opts KillContainerOptions) error

KillContainer sends a signal to a container, returning an error in case of failure.

See https://goo.gl/hkS9i8 for more details.

func (*Client) ListContainers 

func (c *Client) ListContainers(opts ListContainersOptions) ([]APIContainers, error)

ListContainers returns a slice of containers matching the given criteria.

See https://goo.gl/47a6tO for more details.

func (*Client) ListImages 

func (c *Client) ListImages(opts ListImagesOptions) ([]APIImages, error)

ListImages returns the list of available images in the server.

See https://goo.gl/xBe1u3 for more details.

func (*Client) ListNetworks added in v1.1.0 

func (c *Client) ListNetworks() ([]Network, error)

ListNetworks returns all networks.

See https://goo.gl/4hCNtZ for more details.

func (*Client) ListVolumes added in v1.1.0 

func (c *Client) ListVolumes(opts ListVolumesOptions) ([]Volume, error)

ListVolumes returns a list of available volumes in the server.

See https://goo.gl/FZA4BK for more details.

func (*Client) LoadImage 

func (c *Client) LoadImage(opts LoadImageOptions) error

LoadImage imports a tarball docker image

See https://goo.gl/JyClMX for more details.

func (*Client) Logs 

func (c *Client) Logs(opts LogsOptions) error

Logs gets stdout and stderr logs from the specified container.

See https://goo.gl/yl8PGm for more details.

func (*Client) NetworkInfo added in v1.1.0 

func (c *Client) NetworkInfo(id string) (*Network, error)

NetworkInfo returns information about a network by its ID.

See https://goo.gl/4hCNtZ for more details.

func (*Client) PauseContainer 

func (c *Client) PauseContainer(id string) error

PauseContainer pauses the given container.

See https://goo.gl/OF7W9X for more details.

func (*Client) Ping 

func (c *Client) Ping() error

Ping pings the docker server

See https://goo.gl/kQCfJj for more details.

func (*Client) PullImage 

func (c *Client) PullImage(opts PullImageOptions, auth AuthConfiguration) error

PullImage pulls an image from a remote registry, logging progress to opts.OutputStream.

See https://goo.gl/iJkZjD for more details.

func (*Client) PushImage 

func (c *Client) PushImage(opts PushImageOptions, auth AuthConfiguration) error

PushImage pushes an image to a remote registry, logging progress to w.

An empty instance of AuthConfiguration may be used for unauthenticated pushes.

See https://goo.gl/zPtZaT for more details.

func (*Client) RemoveContainer 

func (c *Client) RemoveContainer(opts RemoveContainerOptions) error

RemoveContainer removes a container, returning an error in case of failure.

See https://goo.gl/RQyX62 for more details.

func (*Client) RemoveEventListener 

func (c *Client) RemoveEventListener(listener chan *APIEvents) error

RemoveEventListener removes a listener from the monitor.

func (*Client) RemoveImage 

func (c *Client) RemoveImage(name string) error

RemoveImage removes an image by its name or ID.

See https://goo.gl/V3ZWnK for more details.

func (*Client) RemoveImageExtended added in v0.16.0 

func (c *Client) RemoveImageExtended(name string, opts RemoveImageOptions) error

RemoveImageExtended removes an image by its name or ID. Extra params can be passed, see RemoveImageOptions

See https://goo.gl/V3ZWnK for more details.

func (*Client) RemoveVolume added in v1.1.0 

func (c *Client) RemoveVolume(name string) error

RemoveVolume removes a volume by its name.

See https://goo.gl/79GNQz for more details.

func (*Client) RenameContainer added in v0.16.0 

func (c *Client) RenameContainer(opts RenameContainerOptions) error

RenameContainer updates and existing containers name

See https://goo.gl/laSOIy for more details.

func (*Client) ResizeContainerTTY 

func (c *Client) ResizeContainerTTY(id string, height, width int) error

ResizeContainerTTY resizes the terminal to the given height and width.

See https://goo.gl/xERhCc for more details.

func (*Client) ResizeExecTTY added in v0.5.1 

func (c *Client) ResizeExecTTY(id string, height, width int) error

ResizeExecTTY resizes the tty session used by the exec command id. This API is valid only if Tty was specified as part of creating and starting the exec command.

See https://goo.gl/e1JpsA for more details

func (*Client) RestartContainer 

func (c *Client) RestartContainer(id string, timeout uint) error

RestartContainer stops a container, killing it after the given timeout (in seconds), during the stop process.

See https://goo.gl/QzsDnz for more details.

func (*Client) SearchImages added in v0.5.1 

func (c *Client) SearchImages(term string) ([]APIImageSearch, error)

SearchImages search the docker hub with a specific given term.

See https://goo.gl/AYjyrF for more details.

func (*Client) StartContainer 

func (c *Client) StartContainer(id string, hostConfig *HostConfig) error

StartContainer starts a container, returning an error in case of failure.

See https://goo.gl/MrBAJv for more details.

func (*Client) StartExec added in v0.5.1 

func (c *Client) StartExec(id string, opts StartExecOptions) error

StartExec starts a previously set up exec instance id. If opts.Detach is true, it returns after starting the exec command. Otherwise, it sets up an interactive session with the exec command.

See https://goo.gl/iQCnto for more details

func (*Client) Stats added in v0.18.0 

func (c *Client) Stats(opts StatsOptions) (retErr error)

Stats sends container statistics for the given container to the given channel.

This function is blocking, similar to a streaming call for logs, and should be run on a separate goroutine from the caller. Note that this function will block until the given container is removed, not just exited. When finished, this function will close the given channel. Alternatively, function can be stopped by signaling on the Done channel.

See https://goo.gl/GNmLHb for more details.

func (*Client) StopContainer 

func (c *Client) StopContainer(id string, timeout uint) error

StopContainer stops a container, killing it after the given timeout (in seconds).

See https://goo.gl/USqsFt for more details.

func (*Client) TagImage 

func (c *Client) TagImage(name string, opts TagImageOptions) error

TagImage adds a tag to the image identified by the given name.

See https://goo.gl/98ZzkU for more details.

func (*Client) TopContainer added in v0.5.1 

func (c *Client) TopContainer(id string, psArgs string) (TopResult, error)

TopContainer returns processes running inside a container

See https://goo.gl/Rb46aY for more details.

func (*Client) UnpauseContainer 

func (c *Client) UnpauseContainer(id string) error

UnpauseContainer unpauses the given container.

See https://goo.gl/7dwyPA for more details.

func (*Client) Version 

func (c *Client) Version() (*Env, error)

Version returns version information about the docker server.

See https://goo.gl/ND9R8L for more details.

func (*Client) WaitContainer 

func (c *Client) WaitContainer(id string) (int, error)

WaitContainer blocks until the given container stops, return the exit code of the container status.

See https://goo.gl/Gc1rge for more details.

type CommitContainerOptions 

type CommitContainerOptions struct {
	Container  string
	Repository string `qs:"repo"`
	Tag        string
	Message    string `qs:"m"`
	Author     string
	Run        *Config `qs:"-"`
}

CommitContainerOptions aggregates parameters to the CommitContainer method.

See https://goo.gl/mqfoCw for more details.

type Config 

type Config struct {
	Hostname        string              `json:"Hostname,omitempty" yaml:"Hostname,omitempty"`
	Domainname      string              `json:"Domainname,omitempty" yaml:"Domainname,omitempty"`
	User            string              `json:"User,omitempty" yaml:"User,omitempty"`
	Memory          int64               `json:"Memory,omitempty" yaml:"Memory,omitempty"`
	MemorySwap      int64               `json:"MemorySwap,omitempty" yaml:"MemorySwap,omitempty"`
	CPUShares       int64               `json:"CpuShares,omitempty" yaml:"CpuShares,omitempty"`
	CPUSet          string              `json:"Cpuset,omitempty" yaml:"Cpuset,omitempty"`
	AttachStdin     bool                `json:"AttachStdin,omitempty" yaml:"AttachStdin,omitempty"`
	AttachStdout    bool                `json:"AttachStdout,omitempty" yaml:"AttachStdout,omitempty"`
	AttachStderr    bool                `json:"AttachStderr,omitempty" yaml:"AttachStderr,omitempty"`
	PortSpecs       []string            `json:"PortSpecs,omitempty" yaml:"PortSpecs,omitempty"`
	ExposedPorts    map[Port]struct{}   `json:"ExposedPorts,omitempty" yaml:"ExposedPorts,omitempty"`
	Tty             bool                `json:"Tty,omitempty" yaml:"Tty,omitempty"`
	OpenStdin       bool                `json:"OpenStdin,omitempty" yaml:"OpenStdin,omitempty"`
	StdinOnce       bool                `json:"StdinOnce,omitempty" yaml:"StdinOnce,omitempty"`
	Env             []string            `json:"Env,omitempty" yaml:"Env,omitempty"`
	Cmd             []string            `json:"Cmd" yaml:"Cmd"`
	DNS             []string            `json:"Dns,omitempty" yaml:"Dns,omitempty"` // For Docker API v1.9 and below only
	Image           string              `json:"Image,omitempty" yaml:"Image,omitempty"`
	Volumes         map[string]struct{} `json:"Volumes,omitempty" yaml:"Volumes,omitempty"`
	VolumesFrom     string              `json:"VolumesFrom,omitempty" yaml:"VolumesFrom,omitempty"`
	WorkingDir      string              `json:"WorkingDir,omitempty" yaml:"WorkingDir,omitempty"`
	MacAddress      string              `json:"MacAddress,omitempty" yaml:"MacAddress,omitempty"`
	Entrypoint      []string            `json:"Entrypoint" yaml:"Entrypoint"`
	NetworkDisabled bool                `json:"NetworkDisabled,omitempty" yaml:"NetworkDisabled,omitempty"`
	SecurityOpts    []string            `json:"SecurityOpts,omitempty" yaml:"SecurityOpts,omitempty"`
	OnBuild         []string            `json:"OnBuild,omitempty" yaml:"OnBuild,omitempty"`
	Mounts          []Mount             `json:"Mounts,omitempty" yaml:"Mounts,omitempty"`
	Labels          map[string]string   `json:"Labels,omitempty" yaml:"Labels,omitempty"`
}

Config is the list of configuration options used when creating a container. Config does not contain the options that are specific to starting a container on a given host. Those are contained in HostConfig

type Container 

type Container struct {
	ID string `json:"Id" yaml:"Id"`

	Created time.Time `json:"Created,omitempty" yaml:"Created,omitempty"`

	Path string   `json:"Path,omitempty" yaml:"Path,omitempty"`
	Args []string `json:"Args,omitempty" yaml:"Args,omitempty"`

	Config *Config `json:"Config,omitempty" yaml:"Config,omitempty"`
	State  State   `json:"State,omitempty" yaml:"State,omitempty"`
	Image  string  `json:"Image,omitempty" yaml:"Image,omitempty"`

	Node *SwarmNode `json:"Node,omitempty" yaml:"Node,omitempty"`

	NetworkSettings *NetworkSettings `json:"NetworkSettings,omitempty" yaml:"NetworkSettings,omitempty"`

	SysInitPath    string `json:"SysInitPath,omitempty" yaml:"SysInitPath,omitempty"`
	ResolvConfPath string `json:"ResolvConfPath,omitempty" yaml:"ResolvConfPath,omitempty"`
	HostnamePath   string `json:"HostnamePath,omitempty" yaml:"HostnamePath,omitempty"`
	HostsPath      string `json:"HostsPath,omitempty" yaml:"HostsPath,omitempty"`
	LogPath        string `json:"LogPath,omitempty" yaml:"LogPath,omitempty"`
	Name           string `json:"Name,omitempty" yaml:"Name,omitempty"`
	Driver         string `json:"Driver,omitempty" yaml:"Driver,omitempty"`

	Volumes    map[string]string `json:"Volumes,omitempty" yaml:"Volumes,omitempty"`
	VolumesRW  map[string]bool   `json:"VolumesRW,omitempty" yaml:"VolumesRW,omitempty"`
	HostConfig *HostConfig       `json:"HostConfig,omitempty" yaml:"HostConfig,omitempty"`
	ExecIDs    []string          `json:"ExecIDs,omitempty" yaml:"ExecIDs,omitempty"`

	RestartCount int `json:"RestartCount,omitempty" yaml:"RestartCount,omitempty"`

	AppArmorProfile string `json:"AppArmorProfile,omitempty" yaml:"AppArmorProfile,omitempty"`
}

Container is the type encompasing everything about a container - its config, hostconfig, etc.

type ContainerAlreadyRunning 

type ContainerAlreadyRunning struct {
	ID string
}

ContainerAlreadyRunning is the error returned when a given container is already running.

func (*ContainerAlreadyRunning) Error 

func (err *ContainerAlreadyRunning) Error() string

type ContainerNotRunning 

type ContainerNotRunning struct {
	ID string
}

ContainerNotRunning is the error returned when a given container is not running.

func (*ContainerNotRunning) Error 

func (err *ContainerNotRunning) Error() string

type CopyFromContainerOptions 

type CopyFromContainerOptions struct {
	OutputStream io.Writer `json:"-"`
	Container    string    `json:"-"`
	Resource     string
}

CopyFromContainerOptions is the set of options that can be used when copying files or folders from a container.

See https://goo.gl/4L7b07 for more details.

type CreateContainerOptions 

type CreateContainerOptions struct {
	Name       string
	Config     *Config     `qs:"-"`
	HostConfig *HostConfig `qs:"-"`
}

CreateContainerOptions specify parameters to the CreateContainer function.

See https://goo.gl/WxQzrr for more details.

type CreateExecOptions added in v0.5.1 

type CreateExecOptions struct {
	AttachStdin  bool     `json:"AttachStdin,omitempty" yaml:"AttachStdin,omitempty"`
	AttachStdout bool     `json:"AttachStdout,omitempty" yaml:"AttachStdout,omitempty"`
	AttachStderr bool     `json:"AttachStderr,omitempty" yaml:"AttachStderr,omitempty"`
	Tty          bool     `json:"Tty,omitempty" yaml:"Tty,omitempty"`
	Cmd          []string `json:"Cmd,omitempty" yaml:"Cmd,omitempty"`
	Container    string   `json:"Container,omitempty" yaml:"Container,omitempty"`
	User         string   `json:"User,omitempty" yaml:"User,omitempty"`
}

CreateExecOptions specify parameters to the CreateExecContainer function.

See https://goo.gl/1KSIb7 for more details

type CreateNetworkOptions added in v1.1.0 

type CreateNetworkOptions struct {
	Name        string                 `json:"name"`
	NetworkType string                 `json:"network_type"`
	Options     map[string]interface{} `json:"options"`
}

CreateNetworkOptions specify parameters to the CreateNetwork function and (for now) is the expected body of the "create network" http request message

See https://goo.gl/FDkCdQ for more details.

type CreateVolumeOptions added in v1.1.0 

type CreateVolumeOptions struct {
	Name       string
	Driver     string
	DriverOpts map[string]string
}

CreateVolumeOptions specify parameters to the CreateVolume function.

See https://goo.gl/pBUbZ9 for more details.

type Device added in v0.16.0 

type Device struct {
	PathOnHost        string `json:"PathOnHost,omitempty" yaml:"PathOnHost,omitempty"`
	PathInContainer   string `json:"PathInContainer,omitempty" yaml:"PathInContainer,omitempty"`
	CgroupPermissions string `json:"CgroupPermissions,omitempty" yaml:"CgroupPermissions,omitempty"`
}

Device represents a device mapping between the Docker host and the container.

type Endpoint added in v1.1.0 

type Endpoint struct {
	Name    string `json:"name"`
	ID      string `json:"id"`
	Network string `json:"network"`
}

Endpoint represents an endpoint.

See https://goo.gl/FDkCdQ for more details.

type Env 

type Env []string

Env represents a list of key-pair represented in the form KEY=VALUE.

func (*Env) Decode 

func (env *Env) Decode(src io.Reader) error

Decode decodes `src` as a json dictionary, and adds each decoded key-value pair to the environment.

If `src` cannot be decoded as a json dictionary, an error is returned.

func (*Env) Exists 

func (env *Env) Exists(key string) bool

Exists checks whether the given key is defined in the internal Env representation.

func (*Env) Get 

func (env *Env) Get(key string) (value string)

Get returns the string value of the given key.

func (*Env) GetBool 

func (env *Env) GetBool(key string) (value bool)

GetBool returns a boolean representation of the given key. The key is false whenever its value if 0, no, false, none or an empty string. Any other value will be interpreted as true.

func (*Env) GetInt 

func (env *Env) GetInt(key string) int

GetInt returns the value of the provided key, converted to int.

It the value cannot be represented as an integer, it returns -1.

func (*Env) GetInt64 

func (env *Env) GetInt64(key string) int64

GetInt64 returns the value of the provided key, converted to int64.

It the value cannot be represented as an integer, it returns -1.

func (*Env) GetJSON 

func (env *Env) GetJSON(key string, iface interface{}) error

GetJSON unmarshals the value of the provided key in the provided iface.

iface is a value that can be provided to the json.Unmarshal function.

Example 
type Person struct {
	Name string
	Age  int
}
p := Person{Name: "Gopher", Age: 4}
var e docker.Env
e.Set("person", `{"name":"Gopher","age":4}`)
err := e.GetJSON("person", &p)
if err != nil {
	log.Fatal(err)
}

Output:

func (*Env) GetList 

func (env *Env) GetList(key string) []string

GetList returns a list of strings matching the provided key. It handles the list as a JSON representation of a list of strings.

If the given key matches to a single string, it will return a list containing only the value that matches the key.

func (*Env) Map 

func (env *Env) Map() map[string]string

Map returns the map representation of the env.

Example 
e := docker.Env([]string{"A=1", "B=2", "C=3"})
envs := e.Map()
for k, v := range envs {
	fmt.Printf("%s=%q\n", k, v)
}

Output:

func (*Env) Set 

func (env *Env) Set(key, value string)

Set defines the value of a key to the given string.

func (*Env) SetAuto 

func (env *Env) SetAuto(key string, value interface{})

SetAuto will try to define the Set* method to call based on the given value.

func (*Env) SetBool 

func (env *Env) SetBool(key string, value bool)

SetBool defines a boolean value to the given key.

func (*Env) SetInt 

func (env *Env) SetInt(key string, value int)

SetInt defines an integer value to the given key.

func (*Env) SetInt64 

func (env *Env) SetInt64(key string, value int64)

SetInt64 defines an integer (64-bit wide) value to the given key.

func (*Env) SetJSON 

func (env *Env) SetJSON(key string, value interface{}) error

SetJSON marshals the given value to JSON format and stores it using the provided key.

Example 
type Person struct {
	Name string
	Age  int
}
p := Person{Name: "Gopher", Age: 4}
var e docker.Env
err := e.SetJSON("person", p)
if err != nil {
	log.Fatal(err)
}

Output:

func (*Env) SetList 

func (env *Env) SetList(key string, value []string) error

SetList stores the given list in the provided key, after serializing it to JSON format.

type Error 

type Error struct {
	Status  int
	Message string
}

Error represents failures in the API. It represents a failure from the API.

func (*Error) Error 

func (e *Error) Error() string

type Exec added in v0.5.1 

type Exec struct {
	ID string `json:"Id,omitempty" yaml:"Id,omitempty"`
}

Exec is the type representing a `docker exec` instance and containing the instance ID

type ExecInspect added in v0.10.0 

type ExecInspect struct {
	ID            string            `json:"ID,omitempty" yaml:"ID,omitempty"`
	Running       bool              `json:"Running,omitempty" yaml:"Running,omitempty"`
	ExitCode      int               `json:"ExitCode,omitempty" yaml:"ExitCode,omitempty"`
	OpenStdin     bool              `json:"OpenStdin,omitempty" yaml:"OpenStdin,omitempty"`
	OpenStderr    bool              `json:"OpenStderr,omitempty" yaml:"OpenStderr,omitempty"`
	OpenStdout    bool              `json:"OpenStdout,omitempty" yaml:"OpenStdout,omitempty"`
	ProcessConfig ExecProcessConfig `json:"ProcessConfig,omitempty" yaml:"ProcessConfig,omitempty"`
	Container     Container         `json:"Container,omitempty" yaml:"Container,omitempty"`
}

ExecInspect is a type with details about a exec instance, including the exit code if the command has finished running. It's returned by a api call to /exec/(id)/json

See https://goo.gl/gPtX9R for more details

type ExecProcessConfig added in v0.10.0 

type ExecProcessConfig struct {
	Privileged bool     `json:"privileged,omitempty" yaml:"privileged,omitempty"`
	User       string   `json:"user,omitempty" yaml:"user,omitempty"`
	Tty        bool     `json:"tty,omitempty" yaml:"tty,omitempty"`
	EntryPoint string   `json:"entrypoint,omitempty" yaml:"entrypoint,omitempty"`
	Arguments  []string `json:"arguments,omitempty" yaml:"arguments,omitempty"`
}

ExecProcessConfig is a type describing the command associated to a Exec instance. It's used in the ExecInspect type.

type ExportContainerOptions 

type ExportContainerOptions struct {
	ID           string
	OutputStream io.Writer
}

ExportContainerOptions is the set of parameters to the ExportContainer method.

See https://goo.gl/dOkTyk for more details.

type ExportImageOptions 

type ExportImageOptions struct {
	Name         string
	OutputStream io.Writer
}

ExportImageOptions represent the options for ExportImage Docker API call.

See https://goo.gl/le7vK8 for more details.

type ExportImagesOptions added in v0.16.0 

type ExportImagesOptions struct {
	Names        []string
	OutputStream io.Writer `qs:"-"`
}

ExportImagesOptions represent the options for ExportImages Docker API call

See https://goo.gl/huC7HA for more details.

type HostConfig 

type HostConfig struct {
	Binds            []string               `json:"Binds,omitempty" yaml:"Binds,omitempty"`
	CapAdd           []string               `json:"CapAdd,omitempty" yaml:"CapAdd,omitempty"`
	CapDrop          []string               `json:"CapDrop,omitempty" yaml:"CapDrop,omitempty"`
	ContainerIDFile  string                 `json:"ContainerIDFile,omitempty" yaml:"ContainerIDFile,omitempty"`
	LxcConf          []KeyValuePair         `json:"LxcConf,omitempty" yaml:"LxcConf,omitempty"`
	Privileged       bool                   `json:"Privileged,omitempty" yaml:"Privileged,omitempty"`
	PortBindings     map[Port][]PortBinding `json:"PortBindings,omitempty" yaml:"PortBindings,omitempty"`
	Links            []string               `json:"Links,omitempty" yaml:"Links,omitempty"`
	PublishAllPorts  bool                   `json:"PublishAllPorts,omitempty" yaml:"PublishAllPorts,omitempty"`
	DNS              []string               `json:"Dns,omitempty" yaml:"Dns,omitempty"` // For Docker API v1.10 and above only
	DNSSearch        []string               `json:"DnsSearch,omitempty" yaml:"DnsSearch,omitempty"`
	ExtraHosts       []string               `json:"ExtraHosts,omitempty" yaml:"ExtraHosts,omitempty"`
	VolumesFrom      []string               `json:"VolumesFrom,omitempty" yaml:"VolumesFrom,omitempty"`
	NetworkMode      string                 `json:"NetworkMode,omitempty" yaml:"NetworkMode,omitempty"`
	IpcMode          string                 `json:"IpcMode,omitempty" yaml:"IpcMode,omitempty"`
	PidMode          string                 `json:"PidMode,omitempty" yaml:"PidMode,omitempty"`
	UTSMode          string                 `json:"UTSMode,omitempty" yaml:"UTSMode,omitempty"`
	RestartPolicy    RestartPolicy          `json:"RestartPolicy,omitempty" yaml:"RestartPolicy,omitempty"`
	Devices          []Device               `json:"Devices,omitempty" yaml:"Devices,omitempty"`
	LogConfig        LogConfig              `json:"LogConfig,omitempty" yaml:"LogConfig,omitempty"`
	ReadonlyRootfs   bool                   `json:"ReadonlyRootfs,omitempty" yaml:"ReadonlyRootfs,omitempty"`
	SecurityOpt      []string               `json:"SecurityOpt,omitempty" yaml:"SecurityOpt,omitempty"`
	CgroupParent     string                 `json:"CgroupParent,omitempty" yaml:"CgroupParent,omitempty"`
	Memory           int64                  `json:"Memory,omitempty" yaml:"Memory,omitempty"`
	MemorySwap       int64                  `json:"MemorySwap,omitempty" yaml:"MemorySwap,omitempty"`
	MemorySwappiness int64                  `json:"MemorySwappiness,omitempty" yaml:"MemorySwappiness,omitempty"`
	OOMKillDisable   bool                   `json:"OomKillDisable,omitempty" yaml:"OomKillDisable"`
	CPUShares        int64                  `json:"CpuShares,omitempty" yaml:"CpuShares,omitempty"`
	CPUSet           string                 `json:"Cpuset,omitempty" yaml:"Cpuset,omitempty"`
	CPUSetCPUs       string                 `json:"CpusetCpus,omitempty" yaml:"CpusetCpus,omitempty"`
	CPUSetMEMs       string                 `json:"CpusetMems,omitempty" yaml:"CpusetMems,omitempty"`
	CPUQuota         int64                  `json:"CpuQuota,omitempty" yaml:"CpuQuota,omitempty"`
	CPUPeriod        int64                  `json:"CpuPeriod,omitempty" yaml:"CpuPeriod,omitempty"`
	BlkioWeight      int64                  `json:"BlkioWeight,omitempty" yaml:"BlkioWeight"`
	Ulimits          []ULimit               `json:"Ulimits,omitempty" yaml:"Ulimits,omitempty"`
}

HostConfig contains the container options related to starting a container on a given host

type Image 

type Image struct {
	ID              string    `json:"Id" yaml:"Id"`
	Parent          string    `json:"Parent,omitempty" yaml:"Parent,omitempty"`
	Comment         string    `json:"Comment,omitempty" yaml:"Comment,omitempty"`
	Created         time.Time `json:"Created,omitempty" yaml:"Created,omitempty"`
	Container       string    `json:"Container,omitempty" yaml:"Container,omitempty"`
	ContainerConfig Config    `json:"ContainerConfig,omitempty" yaml:"ContainerConfig,omitempty"`
	DockerVersion   string    `json:"DockerVersion,omitempty" yaml:"DockerVersion,omitempty"`
	Author          string    `json:"Author,omitempty" yaml:"Author,omitempty"`
	Config          *Config   `json:"Config,omitempty" yaml:"Config,omitempty"`
	Architecture    string    `json:"Architecture,omitempty" yaml:"Architecture,omitempty"`
	Size            int64     `json:"Size,omitempty" yaml:"Size,omitempty"`
	VirtualSize     int64     `json:"VirtualSize,omitempty" yaml:"VirtualSize,omitempty"`
}

Image is the type representing a docker image and its various properties

type ImageHistory added in v0.5.1 

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

ImageHistory represent a layer in an image's history returned by the ImageHistory call.

type ImagePre012 

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

ImagePre012 serves the same purpose as the Image type except that it is for earlier versions of the Docker API (pre-012 to be specific)

type ImportImageOptions 

type ImportImageOptions struct {
	Repository string `qs:"repo"`
	Source     string `qs:"fromSrc"`
	Tag        string `qs:"tag"`

	InputStream   io.Reader `qs:"-"`
	OutputStream  io.Writer `qs:"-"`
	RawJSONStream bool      `qs:"-"`
}

ImportImageOptions present the set of informations available for importing an image from a source file or the stdin.

See https://goo.gl/iJkZjD for more details.

type KeyValuePair 

type KeyValuePair struct {
	Key   string `json:"Key,omitempty" yaml:"Key,omitempty"`
	Value string `json:"Value,omitempty" yaml:"Value,omitempty"`
}

KeyValuePair is a type for generic key/value pairs as used in the Lxc configuration

type KillContainerOptions 

type KillContainerOptions struct {
	// The ID of the container.
	ID string `qs:"-"`

	// The signal to send to the container. When omitted, Docker server
	// will assume SIGKILL.
	Signal Signal
}

KillContainerOptions represents the set of options that can be used in a call to KillContainer.

See https://goo.gl/hkS9i8 for more details.

type ListContainersOptions 

type ListContainersOptions struct {
	All     bool
	Size    bool
	Limit   int
	Since   string
	Before  string
	Filters map[string][]string
}

ListContainersOptions specify parameters to the ListContainers function.

See https://goo.gl/47a6tO for more details.

type ListImagesOptions added in v0.7.2 

type ListImagesOptions struct {
	All     bool
	Filters map[string][]string
	Digests bool
}

ListImagesOptions specify parameters to the ListImages function.

See https://goo.gl/xBe1u3 for more details.

type ListVolumesOptions added in v1.1.0 

type ListVolumesOptions struct {
	Filters map[string][]string
}

ListVolumesOptions specify parameters to the ListVolumes function.

See https://goo.gl/FZA4BK for more details.

type LoadImageOptions 

type LoadImageOptions struct {
	InputStream io.Reader
}

LoadImageOptions represents the options for LoadImage Docker API Call

See https://goo.gl/JyClMX for more details.

type LogConfig added in v0.16.0 

type LogConfig struct {
	Type   string            `json:"Type,omitempty" yaml:"Type,omitempty"`
	Config map[string]string `json:"Config,omitempty" yaml:"Config,omitempty"`
}

LogConfig defines the log driver type and the configuration for it.

type LogsOptions 

type LogsOptions struct {
	Container    string    `qs:"-"`
	OutputStream io.Writer `qs:"-"`
	ErrorStream  io.Writer `qs:"-"`
	Follow       bool
	Stdout       bool
	Stderr       bool
	Since        int64
	Timestamps   bool
	Tail         string

	// Use raw terminal? Usually true when the container contains a TTY.
	RawTerminal bool `qs:"-"`
}

LogsOptions represents the set of options used when getting logs from a container.

See https://goo.gl/yl8PGm for more details.

type Mount added in v1.1.0 

type Mount struct {
	Source      string
	Destination string
	Mode        string
	RW          bool
}

Mount represents a mount point in the container.

It has been added in the version 1.20 of the Docker API, available since Docker 1.8.

type Network added in v1.1.0 

type Network struct {
	Name      string      `json:"name"`
	ID        string      `json:"id"`
	Type      string      `json:"type"`
	Endpoints []*Endpoint `json:"endpoints"`
}

Network represents a network.

See https://goo.gl/FDkCdQ for more details.

type NetworkSettings 

type NetworkSettings struct {
	IPAddress              string                 `json:"IPAddress,omitempty" yaml:"IPAddress,omitempty"`
	IPPrefixLen            int                    `json:"IPPrefixLen,omitempty" yaml:"IPPrefixLen,omitempty"`
	MacAddress             string                 `json:"MacAddress,omitempty" yaml:"MacAddress,omitempty"`
	Gateway                string                 `json:"Gateway,omitempty" yaml:"Gateway,omitempty"`
	Bridge                 string                 `json:"Bridge,omitempty" yaml:"Bridge,omitempty"`
	PortMapping            map[string]PortMapping `json:"PortMapping,omitempty" yaml:"PortMapping,omitempty"`
	Ports                  map[Port][]PortBinding `json:"Ports,omitempty" yaml:"Ports,omitempty"`
	NetworkID              string                 `json:"NetworkID,omitempty" yaml:"NetworkID,omitempty"`
	EndpointID             string                 `json:"EndpointID,omitempty" yaml:"EndpointID,omitempty"`
	SandboxKey             string                 `json:"SandboxKey,omitempty" yaml:"SandboxKey,omitempty"`
	GlobalIPv6Address      string                 `json:"GlobalIPv6Address,omitempty" yaml:"GlobalIPv6Address,omitempty"`
	GlobalIPv6PrefixLen    int                    `json:"GlobalIPv6PrefixLen,omitempty" yaml:"GlobalIPv6PrefixLen,omitempty"`
	IPv6Gateway            string                 `json:"IPv6Gateway,omitempty" yaml:"IPv6Gateway,omitempty"`
	LinkLocalIPv6Address   string                 `json:"LinkLocalIPv6Address,omitempty" yaml:"LinkLocalIPv6Address,omitempty"`
	LinkLocalIPv6PrefixLen int                    `json:"LinkLocalIPv6PrefixLen,omitempty" yaml:"LinkLocalIPv6PrefixLen,omitempty"`
	SecondaryIPAddresses   []string               `json:"SecondaryIPAddresses,omitempty" yaml:"SecondaryIPAddresses,omitempty"`
	SecondaryIPv6Addresses []string               `json:"SecondaryIPv6Addresses,omitempty" yaml:"SecondaryIPv6Addresses,omitempty"`
}

NetworkSettings contains network-related information about a container

func (*NetworkSettings) PortMappingAPI 

func (settings *NetworkSettings) PortMappingAPI() []APIPort

PortMappingAPI translates the port mappings as contained in NetworkSettings into the format in which they would appear when returned by the API

type NoSuchContainer 

type NoSuchContainer struct {
	ID  string
	Err error
}

NoSuchContainer is the error returned when a given container does not exist.

func (*NoSuchContainer) Error 

func (err *NoSuchContainer) Error() string

type NoSuchExec added in v0.5.1 

type NoSuchExec struct {
	ID string
}

NoSuchExec is the error returned when a given exec instance does not exist.

func (*NoSuchExec) Error added in v0.5.1 

func (err *NoSuchExec) Error() string

type NoSuchNetwork added in v1.1.0 

type NoSuchNetwork struct {
	ID string
}

NoSuchNetwork is the error returned when a given network does not exist.

func (*NoSuchNetwork) Error added in v1.1.0 

func (err *NoSuchNetwork) Error() string

type Port 

type Port string

Port represents the port number and the protocol, in the form <number>/<protocol>. For example: 80/tcp.

func (Port) Port 

func (p Port) Port() string

Port returns the number of the port.

func (Port) Proto 

func (p Port) Proto() string

Proto returns the name of the protocol.

type PortBinding 

type PortBinding struct {
	HostIP   string `json:"HostIP,omitempty" yaml:"HostIP,omitempty"`
	HostPort string `json:"HostPort,omitempty" yaml:"HostPort,omitempty"`
}

PortBinding represents the host/container port mapping as returned in the `docker inspect` json

type PortMapping 

type PortMapping map[string]string

PortMapping represents a deprecated field in the `docker inspect` output, and its value as found in NetworkSettings should always be nil

type PullImageOptions 

type PullImageOptions struct {
	Repository    string `qs:"fromImage"`
	Registry      string
	Tag           string
	OutputStream  io.Writer `qs:"-"`
	RawJSONStream bool      `qs:"-"`
}

PullImageOptions present the set of options available for pulling an image from a registry.

See https://goo.gl/iJkZjD for more details.

type PushImageOptions 

type PushImageOptions struct {
	// Name of the image
	Name string

	// Tag of the image
	Tag string

	// Registry server to push the image
	Registry string

	OutputStream  io.Writer `qs:"-"`
	RawJSONStream bool      `qs:"-"`
}

PushImageOptions represents options to use in the PushImage method.

See https://goo.gl/zPtZaT for more details.

type RemoveContainerOptions 

type RemoveContainerOptions struct {
	// The ID of the container.
	ID string `qs:"-"`

	// A flag that indicates whether Docker should remove the volumes
	// associated to the container.
	RemoveVolumes bool `qs:"v"`

	// A flag that indicates whether Docker should remove the container
	// even if it is currently running.
	Force bool
}

RemoveContainerOptions encapsulates options to remove a container.

See https://goo.gl/RQyX62 for more details.

type RemoveImageOptions added in v0.16.0 

type RemoveImageOptions struct {
	Force   bool `qs:"force"`
	NoPrune bool `qs:"noprune"`
}

RemoveImageOptions present the set of options available for removing an image from a registry.

See https://goo.gl/V3ZWnK for more details.

type RenameContainerOptions added in v0.16.0 

type RenameContainerOptions struct {
	// ID of container to rename
	ID string `qs:"-"`

	// New name
	Name string `json:"name,omitempty" yaml:"name,omitempty"`
}

RenameContainerOptions specify parameters to the RenameContainer function.

See https://goo.gl/laSOIy for more details.

type RestartPolicy 

type RestartPolicy struct {
	Name              string `json:"Name,omitempty" yaml:"Name,omitempty"`
	MaximumRetryCount int    `json:"MaximumRetryCount,omitempty" yaml:"MaximumRetryCount,omitempty"`
}

RestartPolicy represents the policy for automatically restarting a container.

Possible values are:

  • always: the docker daemon will always restart the container
  • on-failure: the docker daemon will restart the container on failures, at most MaximumRetryCount times
  • no: the docker daemon will not restart the container automatically

func AlwaysRestart 

func AlwaysRestart() RestartPolicy

AlwaysRestart returns a restart policy that tells the Docker daemon to always restart the container.

func NeverRestart 

func NeverRestart() RestartPolicy

NeverRestart returns a restart policy that tells the Docker daemon to never restart the container on failures.

func RestartOnFailure 

func RestartOnFailure(maxRetry int) RestartPolicy

RestartOnFailure returns a restart policy that tells the Docker daemon to restart the container on failures, trying at most maxRetry times.

type Signal 

type Signal int

Signal represents a signal that can be send to the container on KillContainer call.

type StartExecOptions added in v0.5.1 

type StartExecOptions struct {
	Detach bool `json:"Detach,omitempty" yaml:"Detach,omitempty"`

	Tty bool `json:"Tty,omitempty" yaml:"Tty,omitempty"`

	InputStream  io.Reader `qs:"-"`
	OutputStream io.Writer `qs:"-"`
	ErrorStream  io.Writer `qs:"-"`

	// Use raw terminal? Usually true when the container contains a TTY.
	RawTerminal bool `qs:"-"`

	// If set, after a successful connect, a sentinel will be sent and then the
	// client will block on receive before continuing.
	//
	// It must be an unbuffered channel. Using a buffered channel can lead
	// to unexpected behavior.
	Success chan struct{} `json:"-"`
}

StartExecOptions specify parameters to the StartExecContainer function.

See https://goo.gl/iQCnto for more details

type State 

type State struct {
	Running    bool      `json:"Running,omitempty" yaml:"Running,omitempty"`
	Paused     bool      `json:"Paused,omitempty" yaml:"Paused,omitempty"`
	Restarting bool      `json:"Restarting,omitempty" yaml:"Restarting,omitempty"`
	OOMKilled  bool      `json:"OOMKilled,omitempty" yaml:"OOMKilled,omitempty"`
	Pid        int       `json:"Pid,omitempty" yaml:"Pid,omitempty"`
	ExitCode   int       `json:"ExitCode,omitempty" yaml:"ExitCode,omitempty"`
	Error      string    `json:"Error,omitempty" yaml:"Error,omitempty"`
	StartedAt  time.Time `json:"StartedAt,omitempty" yaml:"StartedAt,omitempty"`
	FinishedAt time.Time `json:"FinishedAt,omitempty" yaml:"FinishedAt,omitempty"`
}

State represents the state of a container.

func (*State) String 

func (s *State) String() string

String returns the string representation of a state.

type Stats added in v0.18.0 

type Stats struct {
	Read    time.Time `json:"read,omitempty" yaml:"read,omitempty"`
	Network struct {
		RxDropped uint64 `json:"rx_dropped,omitempty" yaml:"rx_dropped,omitempty"`
		RxBytes   uint64 `json:"rx_bytes,omitempty" yaml:"rx_bytes,omitempty"`
		RxErrors  uint64 `json:"rx_errors,omitempty" yaml:"rx_errors,omitempty"`
		TxPackets uint64 `json:"tx_packets,omitempty" yaml:"tx_packets,omitempty"`
		TxDropped uint64 `json:"tx_dropped,omitempty" yaml:"tx_dropped,omitempty"`
		RxPackets uint64 `json:"rx_packets,omitempty" yaml:"rx_packets,omitempty"`
		TxErrors  uint64 `json:"tx_errors,omitempty" yaml:"tx_errors,omitempty"`
		TxBytes   uint64 `json:"tx_bytes,omitempty" yaml:"tx_bytes,omitempty"`
	} `json:"network,omitempty" yaml:"network,omitempty"`
	MemoryStats struct {
		Stats struct {
			TotalPgmafault          uint64 `json:"total_pgmafault,omitempty" yaml:"total_pgmafault,omitempty"`
			Cache                   uint64 `json:"cache,omitempty" yaml:"cache,omitempty"`
			MappedFile              uint64 `json:"mapped_file,omitempty" yaml:"mapped_file,omitempty"`
			TotalInactiveFile       uint64 `json:"total_inactive_file,omitempty" yaml:"total_inactive_file,omitempty"`
			Pgpgout                 uint64 `json:"pgpgout,omitempty" yaml:"pgpgout,omitempty"`
			Rss                     uint64 `json:"rss,omitempty" yaml:"rss,omitempty"`
			TotalMappedFile         uint64 `json:"total_mapped_file,omitempty" yaml:"total_mapped_file,omitempty"`
			Writeback               uint64 `json:"writeback,omitempty" yaml:"writeback,omitempty"`
			Unevictable             uint64 `json:"unevictable,omitempty" yaml:"unevictable,omitempty"`
			Pgpgin                  uint64 `json:"pgpgin,omitempty" yaml:"pgpgin,omitempty"`
			TotalUnevictable        uint64 `json:"total_unevictable,omitempty" yaml:"total_unevictable,omitempty"`
			Pgmajfault              uint64 `json:"pgmajfault,omitempty" yaml:"pgmajfault,omitempty"`
			TotalRss                uint64 `json:"total_rss,omitempty" yaml:"total_rss,omitempty"`
			TotalRssHuge            uint64 `json:"total_rss_huge,omitempty" yaml:"total_rss_huge,omitempty"`
			TotalWriteback          uint64 `json:"total_writeback,omitempty" yaml:"total_writeback,omitempty"`
			TotalInactiveAnon       uint64 `json:"total_inactive_anon,omitempty" yaml:"total_inactive_anon,omitempty"`
			RssHuge                 uint64 `json:"rss_huge,omitempty" yaml:"rss_huge,omitempty"`
			HierarchicalMemoryLimit uint64 `json:"hierarchical_memory_limit,omitempty" yaml:"hierarchical_memory_limit,omitempty"`
			TotalPgfault            uint64 `json:"total_pgfault,omitempty" yaml:"total_pgfault,omitempty"`
			TotalActiveFile         uint64 `json:"total_active_file,omitempty" yaml:"total_active_file,omitempty"`
			ActiveAnon              uint64 `json:"active_anon,omitempty" yaml:"active_anon,omitempty"`
			TotalActiveAnon         uint64 `json:"total_active_anon,omitempty" yaml:"total_active_anon,omitempty"`
			TotalPgpgout            uint64 `json:"total_pgpgout,omitempty" yaml:"total_pgpgout,omitempty"`
			TotalCache              uint64 `json:"total_cache,omitempty" yaml:"total_cache,omitempty"`
			InactiveAnon            uint64 `json:"inactive_anon,omitempty" yaml:"inactive_anon,omitempty"`
			ActiveFile              uint64 `json:"active_file,omitempty" yaml:"active_file,omitempty"`
			Pgfault                 uint64 `json:"pgfault,omitempty" yaml:"pgfault,omitempty"`
			InactiveFile            uint64 `json:"inactive_file,omitempty" yaml:"inactive_file,omitempty"`
			TotalPgpgin             uint64 `json:"total_pgpgin,omitempty" yaml:"total_pgpgin,omitempty"`
		} `json:"stats,omitempty" yaml:"stats,omitempty"`
		MaxUsage uint64 `json:"max_usage,omitempty" yaml:"max_usage,omitempty"`
		Usage    uint64 `json:"usage,omitempty" yaml:"usage,omitempty"`
		Failcnt  uint64 `json:"failcnt,omitempty" yaml:"failcnt,omitempty"`
		Limit    uint64 `json:"limit,omitempty" yaml:"limit,omitempty"`
	} `json:"memory_stats,omitempty" yaml:"memory_stats,omitempty"`
	BlkioStats struct {
		IOServiceBytesRecursive []BlkioStatsEntry `json:"io_service_bytes_recursive,omitempty" yaml:"io_service_bytes_recursive,omitempty"`
		IOServicedRecursive     []BlkioStatsEntry `json:"io_serviced_recursive,omitempty" yaml:"io_serviced_recursive,omitempty"`
		IOQueueRecursive        []BlkioStatsEntry `json:"io_queue_recursive,omitempty" yaml:"io_queue_recursive,omitempty"`
		IOServiceTimeRecursive  []BlkioStatsEntry `json:"io_service_time_recursive,omitempty" yaml:"io_service_time_recursive,omitempty"`
		IOWaitTimeRecursive     []BlkioStatsEntry `json:"io_wait_time_recursive,omitempty" yaml:"io_wait_time_recursive,omitempty"`
		IOMergedRecursive       []BlkioStatsEntry `json:"io_merged_recursive,omitempty" yaml:"io_merged_recursive,omitempty"`
		IOTimeRecursive         []BlkioStatsEntry `json:"io_time_recursive,omitempty" yaml:"io_time_recursive,omitempty"`
		SectorsRecursive        []BlkioStatsEntry `json:"sectors_recursive,omitempty" yaml:"sectors_recursive,omitempty"`
	} `json:"blkio_stats,omitempty" yaml:"blkio_stats,omitempty"`
	CPUStats    CPUStats `json:"cpu_stats,omitempty" yaml:"cpu_stats,omitempty"`
	PreCPUStats CPUStats `json:"precpu_stats,omitempty"`
}

Stats represents container statistics, returned by /containers/<id>/stats.

See https://goo.gl/GNmLHb for more details.

type StatsOptions added in v0.18.0 

type StatsOptions struct {
	ID     string
	Stats  chan<- *Stats
	Stream bool
	// A flag that enables stopping the stats operation
	Done <-chan bool
	// Initial connection timeout
	Timeout time.Duration
}

StatsOptions specify parameters to the Stats function.

See https://goo.gl/GNmLHb for more details.

type SwarmNode added in v0.16.0 

type SwarmNode struct {
	ID     string            `json:"ID,omitempty" yaml:"ID,omitempty"`
	IP     string            `json:"IP,omitempty" yaml:"IP,omitempty"`
	Addr   string            `json:"Addr,omitempty" yaml:"Addr,omitempty"`
	Name   string            `json:"Name,omitempty" yaml:"Name,omitempty"`
	CPUs   int64             `json:"CPUs,omitempty" yaml:"CPUs,omitempty"`
	Memory int64             `json:"Memory,omitempty" yaml:"Memory,omitempty"`
	Labels map[string]string `json:"Labels,omitempty" yaml:"Labels,omitempty"`
}

SwarmNode containers information about which Swarm node the container is on

type TagImageOptions 

type TagImageOptions struct {
	Repo  string
	Tag   string
	Force bool
}

TagImageOptions present the set of options to tag an image.

See https://goo.gl/98ZzkU for more details.

type TopResult added in v0.5.1 

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

TopResult represents the list of processes running in a container, as returned by /containers/<id>/top.

See https://goo.gl/Rb46aY for more details.

type ULimit added in v1.1.0 

type ULimit struct {
	Name string `json:"Name,omitempty" yaml:"Name,omitempty"`
	Soft int64  `json:"Soft,omitempty" yaml:"Soft,omitempty"`
	Hard int64  `json:"Hard,omitempty" yaml:"Hard,omitempty"`
}

ULimit defines system-wide resource limitations This can help a lot in system administration, e.g. when a user starts too many processes and therefore makes the system unresponsive for other users.

type Volume added in v1.1.0 

type Volume struct {
	Name       string `json:"Name" yaml:"Name"`
	Driver     string `json:"Driver,omitempty" yaml:"Driver,omitempty"`
	Mountpoint string `json:"Mountpoint,omitempty" yaml:"Mountpoint,omitempty"`
}

Volume represents a volume.

See https://goo.gl/FZA4BK for more details.

Source Files

View all Source files

Directories

Path Synopsis
external
github.com/Sirupsen/logrus
github.com/docker/docker/opts
github.com/docker/docker/pkg/archive
github.com/docker/docker/pkg/fileutils
github.com/docker/docker/pkg/homedir
github.com/docker/docker/pkg/ioutils
github.com/docker/docker/pkg/mflag
github.com/docker/docker/pkg/parsers
Package parsers provides helper functions to parse and validate different type of string.
 Package parsers provides helper functions to parse and validate different type of string.
github.com/docker/docker/pkg/pools
Package pools provides a collection of pools which provide various data types with buffers.
 Package pools provides a collection of pools which provide various data types with buffers.
github.com/docker/docker/pkg/promise
github.com/docker/docker/pkg/stdcopy
github.com/docker/docker/pkg/system
github.com/docker/docker/pkg/ulimit
Package ulimit provides structure and helper function to parse and represent resource limits (Rlimit and Ulimit, its human friendly version).
 Package ulimit provides structure and helper function to parse and represent resource limits (Rlimit and Ulimit, its human friendly version).
github.com/docker/docker/pkg/units
Package units provides helper function to parse and print size and time units in human-readable format.
 Package units provides helper function to parse and print size and time units in human-readable format.
github.com/docker/docker/volume
github.com/docker/libcontainer/user
github.com/gorilla/context
Package context stores values shared during a request lifetime.
 Package context stores values shared during a request lifetime.
github.com/gorilla/mux
Package gorilla/mux implements a request router and dispatcher.
 Package gorilla/mux implements a request router and dispatcher.
github.com/opencontainers/runc/libcontainer/user
Package testing provides a fake implementation of the Docker API, useful for testing purpose.
 Package testing provides a fake implementation of the Docker API, useful for testing purpose.

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.