dockerclient

package module
v0.0.0-...-aba6ff5 Latest Latest
Warning

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

 Go to latest Published: Jul 29, 2016 License: Apache-2.0 Imports: 18 Imported by: 0

README

Docker client library in Go

GoDoc

No longer well-maintained docker client library. Docker's supported engine API client for go is docker/engine-api.

How to use it?

Here is an example showing how to use it:

package main

import (
	"github.com/samalba/dockerclient"
	"log"
	"time"
	"os"
)

// Callback used to listen to Docker's events
func eventCallback(event *dockerclient.Event, ec chan error, args ...interface{}) {
	log.Printf("Received event: %#v\n", *event)
}

func main() {
	// Init the client
	docker, _ := dockerclient.NewDockerClient("unix:///var/run/docker.sock", nil)

	// Get only running containers
	containers, err := docker.ListContainers(false, false, "")
	if err != nil {
		log.Fatal(err)
	}
	for _, c := range containers {
		log.Println(c.Id, c.Names)
	}

	// Inspect the first container returned
	if len(containers) > 0 {
		id := containers[0].Id
		info, _ := docker.InspectContainer(id)
		log.Println(info)
	}

	// Build a docker image
	// some.tar contains the build context (Dockerfile any any files it needs to add/copy)
	dockerBuildContext, err := os.Open("some.tar")
	defer dockerBuildContext.Close()
	buildImageConfig := &dockerclient.BuildImage{
			Context:        dockerBuildContext,
			RepoName:       "your_image_name",
			SuppressOutput: false,
	}
	reader, err := docker.BuildImage(buildImageConfig)
	if err != nil {
		log.Fatal(err)
	}

	// Create a container
	containerConfig := &dockerclient.ContainerConfig{
		Image: "ubuntu:14.04",
		Cmd:   []string{"bash"},
		AttachStdin: true,
		Tty:   true}
	containerId, err := docker.CreateContainer(containerConfig, "foobar", nil)
	if err != nil {
		log.Fatal(err)
	}

	// Start the container
	hostConfig := &dockerclient.HostConfig{}
	err = docker.StartContainer(containerId, hostConfig)
	if err != nil {
		log.Fatal(err)
	}

	// Stop the container (with 5 seconds timeout)
	docker.StopContainer(containerId, 5)

	// Listen to events
	docker.StartMonitorEvents(eventCallback, nil)

	// Hold the execution to look at the events coming
	time.Sleep(3600 * time.Second)
}

Maintainers

List of people you can ping for feedback on Pull Requests or any questions.

Documentation

Index

Examples

Constants

View Source 
const (
	APIVersion = "v1.21"
)

Variables

View Source 
var (
	ErrImageNotFound     = errors.New("Image not found")
	ErrNotFound          = errors.New("Not found")
	ErrConnectionRefused = errors.New("Cannot connect to the docker engine endpoint")
)

Functions

func TLSConfigFromCertPath 

func TLSConfigFromCertPath(path string) (*tls.Config, error)

TLSConfigFromCertPath returns a configuration based on PEM files in the directory

path is usually what is set by the environment variable `DOCKER_CERT_PATH`, or `$HOME/.docker`.

Types

type Actor 

type Actor struct {
	ID         string
	Attributes map[string]string
}

type Address 

type Address struct {
	Addr      string
	PrefixLen int
}

Address represents an IP address

type AttachOptions 

type AttachOptions struct {
	Logs   bool
	Stream bool
	Stdin  bool
	Stdout bool
	Stderr bool
}

type AuthConfig 

type AuthConfig struct {
	Username      string `json:"username,omitempty"`
	Password      string `json:"password,omitempty"`
	Email         string `json:"email,omitempty"`
	RegistryToken string `json:"registrytoken,omitempty"`
}

AuthConfig hold parameters for authenticating with the docker registry

type BlkioStatEntry 

type BlkioStatEntry struct {
	Major uint64 `json:"major"`
	Minor uint64 `json:"minor"`
	Op    string `json:"op"`
	Value uint64 `json:"value"`
}

type BlkioStats 

type BlkioStats struct {
	// number of bytes tranferred to and from the block device
	IoServiceBytesRecursive []BlkioStatEntry `json:"io_service_bytes_recursive"`
	IoServicedRecursive     []BlkioStatEntry `json:"io_serviced_recursive"`
	IoQueuedRecursive       []BlkioStatEntry `json:"io_queue_recursive"`
	IoServiceTimeRecursive  []BlkioStatEntry `json:"io_service_time_recursive"`
	IoWaitTimeRecursive     []BlkioStatEntry `json:"io_wait_time_recursive"`
	IoMergedRecursive       []BlkioStatEntry `json:"io_merged_recursive"`
	IoTimeRecursive         []BlkioStatEntry `json:"io_time_recursive"`
	SectorsRecursive        []BlkioStatEntry `json:"sectors_recursive"`
}

type BuildImage 

type BuildImage struct {
	Config         *ConfigFile
	DockerfileName string
	Context        io.Reader
	RemoteURL      string
	RepoName       string
	SuppressOutput bool
	NoCache        bool
	Remove         bool
	ForceRemove    bool
	Pull           bool
	Memory         int64
	MemorySwap     int64
	CpuShares      int64
	CpuPeriod      int64
	CpuQuota       int64
	CpuSetCpus     string
	CpuSetMems     string
	CgroupParent   string
	BuildArgs      map[string]string
	Labels         map[string]string // Labels hold metadata about the image
}

type Callback 

type Callback func(*Event, chan error, ...interface{})

type Client 

type Client interface {
	Info() (*Info, error)
	ListContainers(all, size bool, filters string) ([]Container, error)
	InspectContainer(id string) (*ContainerInfo, error)
	InspectImage(id string) (*ImageInfo, error)
	CreateContainer(config *ContainerConfig, name string, authConfig *AuthConfig) (string, error)
	ContainerLogs(id string, options *LogOptions) (io.ReadCloser, error)
	ContainerChanges(id string) ([]*ContainerChanges, error)
	UpdateContainer(id string, updateConfig *UpdateConfig) error
	// ContainerStats takes a container ID and an optional stop channel and
	// returns a StatsOrError channel. If an error is ever sent, then no
	// more stats will be sent on that channel. If a stop channel is
	// provided, events will stop being monitored after the stop channel is
	// closed.
	ContainerStats(id string, stopChan <-chan struct{}) (<-chan StatsOrError, error)
	ExecCreate(config *ExecConfig) (string, error)
	ExecStart(id string, config *ExecConfig) error
	ExecResize(id string, width, height int) error
	StartContainer(id string, config *HostConfig) error
	AttachContainer(id string, options *AttachOptions) (io.ReadCloser, error)
	StopContainer(id string, timeout int) error
	RestartContainer(id string, timeout int) error
	KillContainer(id, signal string) error
	Wait(id string) <-chan WaitResult
	// MonitorEvents takes options and an optional stop channel, and returns
	// an EventOrError channel. If an error is ever sent, then no more
	// events will be sent. If a stop channel is provided, events will stop
	// being monitored after the stop channel is closed.
	MonitorEvents(options *MonitorEventsOptions, stopChan <-chan struct{}) (<-chan EventOrError, error)
	StartMonitorEvents(cb Callback, ec chan error, args ...interface{})
	StopAllMonitorEvents()
	StartMonitorStats(id string, cb StatCallback, ec chan error, args ...interface{})
	StopAllMonitorStats()
	TagImage(nameOrID string, repo string, tag string, force bool) error
	Version() (*Version, error)
	PullImage(name string, auth *AuthConfig) error
	PushImage(name string, tag string, auth *AuthConfig) error
	LoadImage(reader io.Reader) error
	RemoveContainer(id string, force, volumes bool) error
	ListImages(all bool) ([]*Image, error)
	RemoveImage(name string, force bool) ([]*ImageDelete, error)
	SearchImages(query, registry string, auth *AuthConfig) ([]ImageSearch, error)
	PauseContainer(name string) error
	UnpauseContainer(name string) error
	RenameContainer(oldName string, newName string) error
	ImportImage(source string, repository string, tag string, tar io.Reader) (io.ReadCloser, error)
	BuildImage(image *BuildImage) (io.ReadCloser, error)
	ListVolumes() ([]*Volume, error)
	RemoveVolume(name string) error
	CreateVolume(request *VolumeCreateRequest) (*Volume, error)
	ListNetworks(filters string) ([]*NetworkResource, error)
	InspectNetwork(id string) (*NetworkResource, error)
	CreateNetwork(config *NetworkCreate) (*NetworkCreateResponse, error)
	ConnectNetwork(id, container string, config *EndpointSettings) error
	DisconnectNetwork(id, container string, force bool) error
	RemoveNetwork(id string) error
	GetExecRC(id string, timeout int) (int, error)
}

type Command 

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

func NewCommand 

func NewCommand(parts ...string) *Command

func (*Command) Len 

func (e *Command) Len() int

func (*Command) MarshalJSON 

func (e *Command) MarshalJSON() ([]byte, error)

func (*Command) Slice 

func (e *Command) Slice() []string

func (*Command) ToString 

func (e *Command) ToString() string

func (*Command) UnmarshalJSON 

func (e *Command) UnmarshalJSON(b []byte) error

UnmarshalJSON decoded the entrypoint whether it's a string or an array of strings.

type ConfigFile 

type ConfigFile struct {
	Configs map[string]AuthConfig `json:"configs,omitempty"`
	// contains filtered or unexported fields
}

ConfigFile holds parameters for authenticating during a BuildImage request

type Container 

type Container struct {
	Id              string
	Names           []string
	Image           string
	ImageID         string
	Command         string
	Created         int64
	Status          string
	Ports           []Port
	SizeRw          int64
	SizeRootFs      int64
	Labels          map[string]string
	NetworkSettings struct {
		Networks map[string]EndpointSettings
	}
}

type ContainerChanges 

type ContainerChanges struct {
	Path string
	Kind int
}

type ContainerConfig 

type ContainerConfig struct {
	Hostname        string
	Domainname      string
	User            string
	AttachStdin     bool
	AttachStdout    bool
	AttachStderr    bool
	ExposedPorts    map[string]struct{}
	Tty             bool
	OpenStdin       bool
	StdinOnce       bool
	Env             []string
	Cmd             *Command
	Image           string
	Volumes         map[string]struct{}
	WorkingDir      string
	Entrypoint      *Entrypoint
	NetworkDisabled bool
	MacAddress      string
	OnBuild         []string
	Labels          map[string]string
	StopSignal      string

	// FIXME: VolumeDriver have been removed since docker 1.9
	VolumeDriver string

	// FIXME: The following fields have been removed since API v1.18
	Memory     int64
	MemorySwap int64
	CpuShares  int64
	Cpuset     string
	PortSpecs  []string

	// This is used only by the create command
	HostConfig HostConfig

	// Network configuration support
	NetworkingConfig *NetworkingConfig
}

type ContainerInfo 

type ContainerInfo struct {
	Id              string
	Created         string
	Path            string
	Name            string
	Args            []string
	ExecIDs         []string
	Config          *ContainerConfig
	State           *State
	Image           string
	NetworkSettings NetworkSettings
	SysInitPath     string
	HostnamePath    string
	HostsPath       string
	ResolvConfPath  string
	Volumes         map[string]string
	HostConfig      *HostConfig
	Node            *NodeInfo
	Mounts          []Mount
}

type CpuStats 

type CpuStats struct {
	CpuUsage       CpuUsage       `json:"cpu_usage"`
	SystemUsage    uint64         `json:"system_cpu_usage"`
	ThrottlingData ThrottlingData `json:"throttling_data,omitempty"`
}

type CpuUsage 

type CpuUsage struct {
	// Total CPU time consumed.
	// Units: nanoseconds.
	TotalUsage uint64 `json:"total_usage"`
	// Total CPU time consumed per core.
	// Units: nanoseconds.
	PercpuUsage []uint64 `json:"percpu_usage"`
	// Time spent by tasks of the cgroup in kernel mode.
	// Units: nanoseconds.
	UsageInKernelmode uint64 `json:"usage_in_kernelmode"`
	// Time spent by tasks of the cgroup in user mode.
	// Units: nanoseconds.
	UsageInUsermode uint64 `json:"usage_in_usermode"`
}

All CPU stats are aggregated since container inception.

type DeviceMapping 

type DeviceMapping struct {
	PathOnHost        string `json:"PathOnHost"`
	PathInContainer   string `json:"PathInContainer"`
	CgroupPermissions string `json:"CgroupPermissions"`
}

type DockerClient 

type DockerClient struct {
	URL        *url.URL
	HTTPClient *http.Client
	TLSConfig  *tls.Config
	// contains filtered or unexported fields
}

func NewDockerClient 

func NewDockerClient(daemonUrl string, tlsConfig *tls.Config) (*DockerClient, error)

func NewDockerClientFromHTTP 

func NewDockerClientFromHTTP(u *url.URL, httpClient *http.Client, tlsConfig *tls.Config) *DockerClient

NewDockerClientFromHTTP assumes that the URL, HTTP Client, and TLS Config have been appropriately set when passed. It chooses default values for other fields

func NewDockerClientTimeout 

func NewDockerClientTimeout(daemonUrl string, tlsConfig *tls.Config, timeout time.Duration, setUserTimeout tcpFunc) (*DockerClient, error)

func (*DockerClient) AttachContainer 

func (client *DockerClient) AttachContainer(id string, options *AttachOptions) (io.ReadCloser, error)
Example 
docker, err := NewDockerClient("unix:///var/run/docker.sock", nil)
if err != nil {
	panic(err)
}
cID, err := docker.CreateContainer(&ContainerConfig{
	Cmd:   NewCommand("echo", "hi"),
	Image: "busybox",
}, "", nil)
if err != nil {
	panic(err)
}
done := make(chan struct{})
if body, err := docker.AttachContainer(cID, &AttachOptions{
	Stream: true,
	Stdout: true,
}); err != nil {
	panic(err)
} else {
	go func() {
		defer body.Close()
		if _, err := stdcopy.StdCopy(os.Stdout, os.Stderr, body); err != nil {
			panic(err)
		}
		close(done)
	}()
}

if err := docker.StartContainer(cID, nil); err != nil {
	panic(err)
}
<-done

Output:

func (*DockerClient) BuildImage 

func (client *DockerClient) BuildImage(image *BuildImage) (io.ReadCloser, error)

func (*DockerClient) ConnectNetwork 

func (client *DockerClient) ConnectNetwork(id, container string, config *EndpointSettings) error

func (*DockerClient) ContainerChanges 

func (client *DockerClient) ContainerChanges(id string) ([]*ContainerChanges, error)

func (*DockerClient) ContainerLogs 

func (client *DockerClient) ContainerLogs(id string, options *LogOptions) (io.ReadCloser, error)

func (*DockerClient) ContainerStats 

func (client *DockerClient) ContainerStats(id string, stopChan <-chan struct{}) (<-chan StatsOrError, error)

func (*DockerClient) CreateContainer 

func (client *DockerClient) CreateContainer(config *ContainerConfig, name string, auth *AuthConfig) (string, error)

func (*DockerClient) CreateNetwork 

func (client *DockerClient) CreateNetwork(config *NetworkCreate) (*NetworkCreateResponse, error)

func (*DockerClient) CreateVolume 

func (client *DockerClient) CreateVolume(request *VolumeCreateRequest) (*Volume, error)

func (*DockerClient) DisconnectNetwork 

func (client *DockerClient) DisconnectNetwork(id, container string, force bool) error

func (*DockerClient) ExecCreate 

func (client *DockerClient) ExecCreate(config *ExecConfig) (string, error)

func (*DockerClient) ExecResize 

func (client *DockerClient) ExecResize(id string, width, height int) error

func (*DockerClient) ExecStart 

func (client *DockerClient) ExecStart(id string, config *ExecConfig) error

func (*DockerClient) GetExecRC 

func (client *DockerClient) GetExecRC(id string, timeout int) (int, error)

func (*DockerClient) ImportImage 

func (client *DockerClient) ImportImage(source string, repository string, tag string, tar io.Reader) (io.ReadCloser, error)

func (*DockerClient) Info 

func (client *DockerClient) Info() (*Info, error)

func (*DockerClient) InspectContainer 

func (client *DockerClient) InspectContainer(id string) (*ContainerInfo, error)

func (*DockerClient) InspectImage 

func (client *DockerClient) InspectImage(id string) (*ImageInfo, error)

func (*DockerClient) InspectNetwork 

func (client *DockerClient) InspectNetwork(id string) (*NetworkResource, error)

func (*DockerClient) KillContainer 

func (client *DockerClient) KillContainer(id, signal string) error

func (*DockerClient) ListContainers 

func (client *DockerClient) ListContainers(all bool, size bool, filters string) ([]Container, error)

func (*DockerClient) ListImages 

func (client *DockerClient) ListImages(all bool) ([]*Image, error)

func (*DockerClient) ListNetworks 

func (client *DockerClient) ListNetworks(filters string) ([]*NetworkResource, error)

func (*DockerClient) ListVolumes 

func (client *DockerClient) ListVolumes() ([]*Volume, error)

func (*DockerClient) LoadImage 

func (client *DockerClient) LoadImage(reader io.Reader) error

func (*DockerClient) MonitorEvents 

func (client *DockerClient) MonitorEvents(options *MonitorEventsOptions, stopChan <-chan struct{}) (<-chan EventOrError, error)

func (*DockerClient) PauseContainer 

func (client *DockerClient) PauseContainer(id string) error

func (*DockerClient) PullImage 

func (client *DockerClient) PullImage(name string, auth *AuthConfig) error

func (*DockerClient) PushImage 

func (client *DockerClient) PushImage(name string, tag string, auth *AuthConfig) error

func (*DockerClient) RemoveContainer 

func (client *DockerClient) RemoveContainer(id string, force, volumes bool) error

func (*DockerClient) RemoveImage 

func (client *DockerClient) RemoveImage(name string, force bool) ([]*ImageDelete, error)

func (*DockerClient) RemoveNetwork 

func (client *DockerClient) RemoveNetwork(id string) error

func (*DockerClient) RemoveVolume 

func (client *DockerClient) RemoveVolume(name string) error

func (*DockerClient) RenameContainer 

func (client *DockerClient) RenameContainer(oldName string, newName string) error

func (*DockerClient) RestartContainer 

func (client *DockerClient) RestartContainer(id string, timeout int) error

func (*DockerClient) SearchImages 

func (client *DockerClient) SearchImages(query, registry string, auth *AuthConfig) ([]ImageSearch, error)

func (*DockerClient) StartContainer 

func (client *DockerClient) StartContainer(id string, config *HostConfig) error

func (*DockerClient) StartMonitorEvents 

func (client *DockerClient) StartMonitorEvents(cb Callback, ec chan error, args ...interface{})

func (*DockerClient) StartMonitorStats 

func (client *DockerClient) StartMonitorStats(id string, cb StatCallback, ec chan error, args ...interface{})

func (*DockerClient) StopAllMonitorEvents 

func (client *DockerClient) StopAllMonitorEvents()

func (*DockerClient) StopAllMonitorStats 

func (client *DockerClient) StopAllMonitorStats()

func (*DockerClient) StopContainer 

func (client *DockerClient) StopContainer(id string, timeout int) error

func (*DockerClient) TagImage 

func (client *DockerClient) TagImage(nameOrID string, repo string, tag string, force bool) error

func (*DockerClient) UnpauseContainer 

func (client *DockerClient) UnpauseContainer(id string) error

func (*DockerClient) UpdateContainer 

func (client *DockerClient) UpdateContainer(id string, updateConfig *UpdateConfig) error

func (*DockerClient) Version 

func (client *DockerClient) Version() (*Version, error)

func (*DockerClient) Wait 

func (client *DockerClient) Wait(id string) <-chan WaitResult

type EndpointIPAMConfig 

type EndpointIPAMConfig struct {
	IPv4Address string `json:",omitempty"`
	IPv6Address string `json:",omitempty"`
}

EndpointIPAMConfig represents IPAM configurations for the endpoint

type EndpointResource 

type EndpointResource struct {
	Name        string
	EndpointID  string
	MacAddress  string
	IPv4Address string
	IPv6Address string
}

EndpointResource contains network resources allocated and used for a container in a network

type EndpointSettings 

type EndpointSettings struct {
	// Configurations
	IPAMConfig *EndpointIPAMConfig
	Links      []string
	Aliases    []string
	// Operational data
	NetworkID           string
	EndpointID          string
	Gateway             string
	IPAddress           string
	IPPrefixLen         int
	IPv6Gateway         string
	GlobalIPv6Address   string
	GlobalIPv6PrefixLen int
	MacAddress          string
}

EndpointSettings stores the network endpoint details

type Entrypoint 

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

Entrypoint encapsulates the container entrypoint. It might be represented as a string or an array of strings. We need to override the json decoder to accept both options. The JSON decoder will fail if the api sends an string and 

we try to decode it into an array of string.

func NewEntrypoint 

func NewEntrypoint(parts ...string) *Entrypoint

func (*Entrypoint) Len 

func (e *Entrypoint) Len() int

func (*Entrypoint) MarshalJSON 

func (e *Entrypoint) MarshalJSON() ([]byte, error)

func (*Entrypoint) Slice 

func (e *Entrypoint) Slice() []string

func (*Entrypoint) UnmarshalJSON 

func (e *Entrypoint) UnmarshalJSON(b []byte) error

UnmarshalJSON decoded the entrypoint whether it's a string or an array of strings.

type Error 

type Error struct {
	StatusCode int
	Status     string
	// contains filtered or unexported fields
}

func (Error) Error 

func (e Error) Error() string

type Event 

type Event struct {
	Status string `json:"status,omitempty"`
	ID     string `json:"id,omitempty"`
	From   string `json:"from,omitempty"`

	Type   string
	Action string
	Actor  Actor

	Time     int64 `json:"time,omitempty"`
	TimeNano int64 `json:"timeNano,omitempty"`
}

type EventOrError 

type EventOrError struct {
	Event
	Error error
}

type ExecConfig 

type ExecConfig struct {
	AttachStdin  bool
	AttachStdout bool
	AttachStderr bool
	Tty          bool
	Cmd          []string
	Container    string
	Detach       bool
}

type HostConfig 

type HostConfig struct {
	Binds                []string
	ContainerIDFile      string
	LxcConf              []map[string]string
	Memory               int64
	MemoryReservation    int64
	MemorySwap           int64
	KernelMemory         int64
	CpuShares            int64
	CpuPeriod            int64
	CpusetCpus           string
	CpusetMems           string
	CpuQuota             int64
	BlkioWeight          int64
	OomKillDisable       bool
	MemorySwappiness     int64
	Privileged           bool
	PortBindings         map[string][]PortBinding
	Links                []string
	PublishAllPorts      bool
	Dns                  []string
	DNSOptions           []string
	DnsSearch            []string
	ExtraHosts           []string
	VolumesFrom          []string
	Devices              []DeviceMapping
	NetworkMode          string
	IpcMode              string
	PidMode              string
	UTSMode              string
	CapAdd               []string
	CapDrop              []string
	GroupAdd             []string
	RestartPolicy        RestartPolicy
	SecurityOpt          []string
	ReadonlyRootfs       bool
	Ulimits              []Ulimit
	LogConfig            LogConfig
	CgroupParent         string
	ConsoleSize          [2]int
	VolumeDriver         string
	OomScoreAdj          int
	Tmpfs                map[string]string
	ShmSize              int64 `json:"omitempty"`
	BlkioWeightDevice    []WeightDevice
	BlkioDeviceReadBps   []ThrottleDevice
	BlkioDeviceWriteBps  []ThrottleDevice
	BlkioDeviceReadIOps  []ThrottleDevice
	BlkioDeviceWriteIOps []ThrottleDevice
}

type IPAM 

type IPAM struct {
	Driver  string
	Options map[string]string //Per network IPAM driver options
	Config  []IPAMConfig
}

IPAM represents IP Address Management

type IPAMConfig 

type IPAMConfig struct {
	Subnet     string            `json:",omitempty"`
	IPRange    string            `json:",omitempty"`
	Gateway    string            `json:",omitempty"`
	AuxAddress map[string]string `json:"AuxiliaryAddresses,omitempty"`
}

IPAMConfig represents IPAM configurations

type Image 

type Image struct {
	Created     int64
	Id          string
	Labels      map[string]string
	ParentId    string
	RepoDigests []string
	RepoTags    []string
	Size        int64
	VirtualSize int64
}

type ImageDelete 

type ImageDelete struct {
	Deleted  string
	Untagged string
}

type ImageInfo 

type ImageInfo struct {
	Architecture    string
	Author          string
	Comment         string
	Config          *ContainerConfig
	Container       string
	ContainerConfig *ContainerConfig
	Created         time.Time
	DockerVersion   string
	Id              string
	Os              string
	Parent          string
	Size            int64
	VirtualSize     int64
}

type ImageSearch 

type ImageSearch 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"`
}

type Info 

type Info struct {
	ID                 string
	Containers         int64
	Driver             string
	DriverStatus       [][]string
	ExecutionDriver    string
	Images             int64
	KernelVersion      string
	OperatingSystem    string
	NCPU               int64
	MemTotal           int64
	Name               string
	Labels             []string
	Debug              interface{}
	NFd                int64
	NGoroutines        int64
	SystemTime         string
	NEventsListener    int64
	InitPath           string
	InitSha1           string
	IndexServerAddress string
	MemoryLimit        interface{}
	SwapLimit          interface{}
	IPv4Forwarding     interface{}
	BridgeNfIptables   bool
	BridgeNfIp6tables  bool
	DockerRootDir      string
	HttpProxy          string
	HttpsProxy         string
	NoProxy            string
}

Info is the struct returned by /info The API is currently in flux, so Debug, MemoryLimit, SwapLimit, and IPv4Forwarding are interfaces because in docker 1.6.1 they are 0 or 1 but in master they are bools.

type LogConfig 

type LogConfig struct {
	Type   string            `json:"type"`
	Config map[string]string `json:"config"`
}

type LogOptions 

type LogOptions struct {
	Follow     bool
	Stdout     bool
	Stderr     bool
	Timestamps bool
	Tail       int64
	Since      int64
}

type MemoryStats 

type MemoryStats struct {
	Usage    uint64            `json:"usage"`
	MaxUsage uint64            `json:"max_usage"`
	Stats    map[string]uint64 `json:"stats"`
	Failcnt  uint64            `json:"failcnt"`
	Limit    uint64            `json:"limit"`
}

type MonitorEventsFilters 

type MonitorEventsFilters struct {
	Event      string   `json:",omitempty"`
	Events     []string `json:",omitempty"`
	Image      string   `json:",omitempty"`
	Images     []string `json:",omitempty"`
	Container  string   `json:",omitempty"`
	Containers []string `json:",omitempty"`
}

type MonitorEventsOptions 

type MonitorEventsOptions struct {
	Since   int
	Until   int
	Filters *MonitorEventsFilters `json:",omitempty"`
}

type Mount 

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

type NetworkConnect 

type NetworkConnect struct {
	Container      string
	EndpointConfig *EndpointSettings `json:",omitempty"`
}

NetworkConnect represents the data to be used to connect a container to the network

type NetworkCreate 

type NetworkCreate struct {
	Name           string
	CheckDuplicate bool
	Driver         string
	IPAM           IPAM
	Internal       bool
	Options        map[string]string
	Labels         map[string]string // Labels hold metadata about the network
}

NetworkCreate is the expected body of the "create network" http request message

type NetworkCreateResponse 

type NetworkCreateResponse struct {
	ID      string `json:"Id"`
	Warning string
}

NetworkCreateResponse is the response message sent by the server for network create call

type NetworkDisconnect 

type NetworkDisconnect struct {
	Container string
	Force     bool
}

NetworkDisconnect represents the data to be used to disconnect a container from the network

type NetworkResource 

type NetworkResource struct {
	Name   string
	ID     string `json:"Id"`
	Scope  string
	Driver string
	IPAM   IPAM
	//Internal   bool
	Containers map[string]EndpointResource
	Options    map[string]string
	Labels     map[string]string // Labels hold metadata about the network
}

NetworkResource is the body of the "get network" http response message

type NetworkSettings 

type NetworkSettings struct {
	IPAddress              string
	IPPrefixLen            int
	Gateway                string
	Bridge                 string
	Ports                  map[string][]PortBinding
	SandboxID              string
	HairpinMode            bool
	LinkLocalIPv6Address   string
	LinkLocalIPv6PrefixLen int
	Networks               map[string]*EndpointSettings
	SandboxKey             string
	SecondaryIPAddresses   []Address
	SecondaryIPv6Addresses []Address
	IsAnonymousEndpoint    bool
}

Settings stores configuration details about the daemon network config TODO Windows. Many of these fields can be factored out.,

type NetworkStats 

type NetworkStats struct {
	RxBytes   uint64 `json:"rx_bytes"`
	RxPackets uint64 `json:"rx_packets"`
	RxErrors  uint64 `json:"rx_errors"`
	RxDropped uint64 `json:"rx_dropped"`
	TxBytes   uint64 `json:"tx_bytes"`
	TxPackets uint64 `json:"tx_packets"`
	TxErrors  uint64 `json:"tx_errors"`
	TxDropped uint64 `json:"tx_dropped"`
}

type NetworkingConfig 

type NetworkingConfig struct {
	EndpointsConfig map[string]*EndpointSettings // Endpoint configs for each conencting network
}

NetworkingConfig represents the container's networking configuration for each of its interfaces Carries the networink configs specified in the `docker run` and `docker network connect` commands

type NodeInfo 

type NodeInfo struct {
	Name string
	Id   string
	Addr string
	Ip   string
}

type Port 

type Port struct {
	IP          string
	PrivatePort int
	PublicPort  int
	Type        string
}

type PortBinding 

type PortBinding struct {
	HostIp   string
	HostPort string
}

type RespContainersCreate 

type RespContainersCreate struct {
	Id       string
	Warnings []string
}

type RestartPolicy 

type RestartPolicy struct {
	Name              string
	MaximumRetryCount int64
}

type StatCallback 

type StatCallback func(string, *Stats, chan error, ...interface{})

type State 

type State struct {
	Running    bool
	Paused     bool
	Restarting bool
	OOMKilled  bool
	Dead       bool
	Pid        int
	ExitCode   int
	Error      string // contains last known error when starting the container
	StartedAt  time.Time
	FinishedAt time.Time
	Ghost      bool
}

func (*State) StateString 

func (s *State) StateString() string

StateString returns a single string to describe state Stoken from docker/docker/daemon/state.go

func (*State) String 

func (s *State) String() string

String returns a human-readable description of the state Stoken from docker/docker/daemon/state.go

type Stats 

type Stats struct {
	Read         time.Time    `json:"read"`
	NetworkStats NetworkStats `json:"network,omitempty"`
	CpuStats     CpuStats     `json:"cpu_stats,omitempty"`
	MemoryStats  MemoryStats  `json:"memory_stats,omitempty"`
	BlkioStats   BlkioStats   `json:"blkio_stats,omitempty"`
}

type StatsOrError 

type StatsOrError struct {
	Stats
	Error error
}

type ThrottleDevice 

type ThrottleDevice struct {
	Path string
	Rate uint64
}

type ThrottlingData 

type ThrottlingData struct {
	// Number of periods with throttling active
	Periods uint64 `json:"periods"`
	// Number of periods when the container hit its throttling limit.
	ThrottledPeriods uint64 `json:"throttled_periods"`
	// Aggregate time the container was throttled for in nanoseconds.
	ThrottledTime uint64 `json:"throttled_time"`
}

The following are types for the API stats endpoint

type Ulimit 

type Ulimit struct {
	Name string `json:"name"`
	Soft uint64 `json:"soft"`
	Hard uint64 `json:"hard"`
}

type UpdateConfig 

type UpdateConfig struct {
	// Applicable to all platforms
	CPUShares int64 `json:"CpuShares"` // CPU shares (relative weight vs. other containers)
	Memory    int64 // Memory limit (in bytes)

	// Applicable to UNIX platforms
	CgroupParent         string // Parent cgroup.
	BlkioWeight          uint16 // Block IO weight (relative weight vs. other containers)
	BlkioWeightDevice    []*WeightDevice
	BlkioDeviceReadBps   []*ThrottleDevice
	BlkioDeviceWriteBps  []*ThrottleDevice
	BlkioDeviceReadIOps  []*ThrottleDevice
	BlkioDeviceWriteIOps []*ThrottleDevice
	CPUPeriod            int64           `json:"CpuPeriod"` // CPU CFS (Completely Fair Scheduler) period
	CPUQuota             int64           `json:"CpuQuota"`  // CPU CFS (Completely Fair Scheduler) quota
	CpusetCpus           string          // CpusetCpus 0-2, 0,1
	CpusetMems           string          // CpusetMems 0-2, 0,1
	Devices              []DeviceMapping // List of devices to map inside the container
	DiskQuota            int64           // Disk limit (in bytes)
	KernelMemory         int64           // Kernel memory limit (in bytes)
	MemoryReservation    int64           // Memory soft limit (in bytes)
	MemorySwap           int64           // Total memory usage (memory + swap); set `-1` to enable unlimited swap
	MemorySwappiness     *int64          // Tuning container memory swappiness behaviour
	OomKillDisable       *bool           // Whether to disable OOM Killer or not
	PidsLimit            int64           // Setting pids limit for a container
	Ulimits              []*Ulimit       // List of ulimits to be set in the container

	// Applicable to Windows
	CPUCount           int64  `json:"CpuCount"`   // CPU count
	CPUPercent         int64  `json:"CpuPercent"` // CPU percent
	IOMaximumIOps      uint64 // Maximum IOps for the container system drive
	IOMaximumBandwidth uint64 // Maximum IO in bytes per second for the container system drive
}

UpdateConfig holds the mutable attributes of a Container. Those attributes can be updated at runtime.

type Version 

type Version struct {
	ApiVersion    string
	Arch          string
	GitCommit     string
	GoVersion     string
	KernelVersion string
	Os            string
	Version       string
}

type Volume 

type Volume struct {
	Name       string            // Name is the name of the volume
	Driver     string            // Driver is the Driver name used to create the volume
	Mountpoint string            // Mountpoint is the location on disk of the volume
	Labels     map[string]string // Labels hold metadata about the volume
}

type VolumeCreateRequest 

type VolumeCreateRequest struct {
	Name       string            // Name is the requested name of the volume
	Driver     string            // Driver is the name of the driver that should be used to create the volume
	DriverOpts map[string]string // DriverOpts holds the driver specific options to use for when creating the volume.
	Labels     map[string]string // Labels hold metadata about the volume
}

type VolumesListResponse 

type VolumesListResponse struct {
	Volumes []*Volume // Volumes is the list of volumes being returned
}

type WaitResult 

type WaitResult struct {
	ExitCode int
	Error    error
}

type WeightDevice 

type WeightDevice struct {
	Path   string
	Weight uint16
}

Source Files

View all Source files

Directories

Path Synopsis
stats

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.