Versions in this module Expand all Collapse all v0 v0.1.9 Feb 24, 2017 v0.1.8 Aug 2, 2016 v0.1.7 May 25, 2016 v0.1.4 May 5, 2016 Changes in this version + const SIGABRT + const SIGALRM + const SIGBUS + const SIGCHLD + const SIGCLD + const SIGCONT + const SIGFPE + const SIGHUP + const SIGILL + const SIGINT + const SIGIO + const SIGIOT + const SIGKILL + const SIGPIPE + const SIGPOLL + const SIGPROF + const SIGPWR + const SIGQUIT + const SIGSEGV + const SIGSTKFLT + const SIGSTOP + const SIGSYS + const SIGTERM + const SIGTRAP + const SIGTSTP + const SIGTTIN + const SIGTTOU + const SIGUNUSED + const SIGURG + const SIGUSR1 + const SIGUSR2 + const SIGVTALRM + const SIGWINCH + const SIGXCPU + const SIGXFSZ + var EOFEvent = &APIEvents + var ErrCannotParseDockercfg = errors.New("Failed to read authentication from dockercfg") + var ErrConnectionRefused = errors.New("cannot connect to Docker endpoint") + var ErrContainerAlreadyExists = errors.New("container already exists") + var ErrInactivityTimeout = errors.New("inactivity time exceeded timeout") + var ErrInvalidEndpoint = errors.New("invalid endpoint") + var ErrListenerAlreadyExists = errors.New("listener already exists for docker events") + var ErrMissingOutputStream = errors.New("missing output stream") + var ErrMissingRepo = errors.New("missing remote repository e.g. 'github.com/user/repo'") + var ErrMultipleContexts = errors.New("image build may not be provided BOTH context dir and input stream") + var ErrMustSpecifyNames = errors.New("must specify at least one name to export") + var ErrNetworkAlreadyExists = errors.New("network already exists") + var ErrNoListeners = errors.New("no listeners present to receive event") + var ErrNoSuchImage = errors.New("no such image") + var ErrNoSuchVolume = errors.New("no such volume") + var ErrVolumeInUse = errors.New("volume in use and cannot be removed") + func DefaultDockerHost() (string, error) + func ParseRepositoryTag(repoTag string) (repository string, tag string) + type APIActor struct + Attributes map[string]string + ID string + type APIContainers struct + Command string + Created int64 + ID string + Image string + Labels map[string]string + Mounts []APIMount + Names []string + Networks NetworkList + Ports []APIPort + SizeRootFs int64 + SizeRw int64 + State string + Status string + type APIEvents struct + Action string + Actor APIActor + From string + ID string + Status string + Time int64 + TimeNano int64 + Type string + type APIImageSearch struct + Description string + IsAutomated bool + IsOfficial bool + Name string + StarCount int + type APIImages struct + Created int64 + ID string + Labels map[string]string + ParentID string + RepoDigests []string + RepoTags []string + Size int64 + VirtualSize int64 + type APIMount struct + Destination string + Driver string + Mode string + Name string + Propogation string + RW bool + Source string + type APIPort struct + IP string + PrivatePort int64 + PublicPort int64 + Type string + type APIVersion []int + func NewAPIVersion(input string) (APIVersion, error) + func (version APIVersion) GreaterThan(other APIVersion) bool + func (version APIVersion) GreaterThanOrEqualTo(other APIVersion) bool + func (version APIVersion) LessThan(other APIVersion) bool + func (version APIVersion) LessThanOrEqualTo(other APIVersion) bool + func (version APIVersion) String() string + type AttachToContainerOptions struct + Container string + ErrorStream io.Writer + InputStream io.Reader + Logs bool + OutputStream io.Writer + RawTerminal bool + Stderr bool + Stdin bool + Stdout bool + Stream bool + Success chan struct{} + type AuthConfiguration struct + Email string + Password string + ServerAddress string + Username string + type AuthConfigurations struct + Configs map[string]AuthConfiguration + func NewAuthConfigurations(r io.Reader) (*AuthConfigurations, error) + func NewAuthConfigurationsFromDockerCfg() (*AuthConfigurations, error) + type AuthConfigurations119 map[string]AuthConfiguration + type AuthStatus struct + IdentityToken string + Status string + type BlkioStatsEntry struct + Major uint64 + Minor uint64 + Op string + Value uint64 + type BlockLimit struct + Path string + Rate string + type BlockWeight struct + Path string + Weight string + type BuildArg struct + Name string + Value string + type BuildImageOptions struct + Auth AuthConfiguration + AuthConfigs AuthConfigurations + BuildArgs []BuildArg + CPUPeriod int64 + CPUQuota int64 + CPUSetCPUs string + CPUShares int64 + ContextDir string + Dockerfile string + ForceRmTmpContainer bool + InactivityTimeout time.Duration + InputStream io.Reader + Memory int64 + Memswap int64 + Name string + NoCache bool + OutputStream io.Writer + Pull bool + RawJSONStream bool + Remote string + RmTmpContainer bool + SuppressOutput bool + Ulimits []ULimit + type CPUStats struct + CPUUsage struct{ ... } + SystemCPUUsage uint64 + ThrottlingData struct{ ... } + type Change struct + Kind ChangeType + Path string + func (change *Change) String() string + type ChangeType int + const ChangeAdd + const ChangeDelete + const ChangeModify + type Client struct + Dialer *net.Dialer + HTTPClient *http.Client + SkipServerVersionCheck bool + TLSConfig *tls.Config + func NewClient(endpoint string) (*Client, error) + func NewClientFromEnv() (*Client, error) + func NewTLSClient(endpoint string, cert, key, ca string) (*Client, error) + func NewTLSClientFromBytes(endpoint string, certPEMBlock, keyPEMBlock, caPEMCert []byte) (*Client, error) + func NewVersionedClient(endpoint string, apiVersionString string) (*Client, error) + func NewVersionedClientFromEnv(apiVersionString string) (*Client, error) + func NewVersionedTLSClient(endpoint string, cert, key, ca, apiVersionString string) (*Client, error) + func NewVersionedTLSClientFromBytes(endpoint string, certPEMBlock, keyPEMBlock, caPEMCert []byte, ...) (*Client, error) + func NewVersionnedTLSClient(endpoint string, cert, key, ca, apiVersionString string) (*Client, error) + func (c *Client) AddEventListener(listener chan<- *APIEvents) error + func (c *Client) AttachToContainer(opts AttachToContainerOptions) error + func (c *Client) AttachToContainerNonBlocking(opts AttachToContainerOptions) (CloseWaiter, error) + func (c *Client) AuthCheck(conf *AuthConfiguration) (AuthStatus, error) + func (c *Client) BuildImage(opts BuildImageOptions) error + func (c *Client) CommitContainer(opts CommitContainerOptions) (*Image, error) + func (c *Client) ConnectNetwork(id string, opts NetworkConnectionOptions) error + func (c *Client) ContainerChanges(id string) ([]Change, error) + func (c *Client) CopyFromContainer(opts CopyFromContainerOptions) error + func (c *Client) CreateContainer(opts CreateContainerOptions) (*Container, error) + func (c *Client) CreateExec(opts CreateExecOptions) (*Exec, error) + func (c *Client) CreateNetwork(opts CreateNetworkOptions) (*Network, error) + func (c *Client) CreateVolume(opts CreateVolumeOptions) (*Volume, error) + func (c *Client) DisconnectNetwork(id string, opts NetworkConnectionOptions) error + func (c *Client) DownloadFromContainer(id string, opts DownloadFromContainerOptions) error + func (c *Client) Endpoint() string + func (c *Client) ExportContainer(opts ExportContainerOptions) error + func (c *Client) ExportImage(opts ExportImageOptions) error + func (c *Client) ExportImages(opts ExportImagesOptions) error + func (c *Client) FilteredListNetworks(opts NetworkFilterOpts) ([]Network, error) + func (c *Client) ImageHistory(name string) ([]ImageHistory, error) + func (c *Client) ImportImage(opts ImportImageOptions) error + func (c *Client) Info() (*DockerInfo, error) + func (c *Client) InspectContainer(id string) (*Container, error) + func (c *Client) InspectExec(id string) (*ExecInspect, error) + func (c *Client) InspectImage(name string) (*Image, error) + func (c *Client) InspectVolume(name string) (*Volume, error) + func (c *Client) KillContainer(opts KillContainerOptions) error + func (c *Client) ListContainers(opts ListContainersOptions) ([]APIContainers, error) + func (c *Client) ListImages(opts ListImagesOptions) ([]APIImages, error) + func (c *Client) ListNetworks() ([]Network, error) + func (c *Client) ListVolumes(opts ListVolumesOptions) ([]Volume, error) + func (c *Client) LoadImage(opts LoadImageOptions) error + func (c *Client) Logs(opts LogsOptions) error + func (c *Client) NetworkInfo(id string) (*Network, error) + func (c *Client) PauseContainer(id string) error + func (c *Client) Ping() error + func (c *Client) PullImage(opts PullImageOptions, auth AuthConfiguration) error + func (c *Client) PushImage(opts PushImageOptions, auth AuthConfiguration) error + func (c *Client) RemoveContainer(opts RemoveContainerOptions) error + func (c *Client) RemoveEventListener(listener chan *APIEvents) error + func (c *Client) RemoveImage(name string) error + func (c *Client) RemoveImageExtended(name string, opts RemoveImageOptions) error + func (c *Client) RemoveNetwork(id string) error + func (c *Client) RemoveVolume(name string) error + func (c *Client) RenameContainer(opts RenameContainerOptions) error + func (c *Client) ResizeContainerTTY(id string, height, width int) error + func (c *Client) ResizeExecTTY(id string, height, width int) error + func (c *Client) RestartContainer(id string, timeout uint) error + func (c *Client) SearchImages(term string) ([]APIImageSearch, error) + func (c *Client) SearchImagesEx(term string, auth AuthConfiguration) ([]APIImageSearch, error) + func (c *Client) StartContainer(id string, hostConfig *HostConfig) error + func (c *Client) StartExec(id string, opts StartExecOptions) error + func (c *Client) StartExecNonBlocking(id string, opts StartExecOptions) (CloseWaiter, error) + func (c *Client) Stats(opts StatsOptions) (retErr error) + func (c *Client) StopContainer(id string, timeout uint) error + func (c *Client) TagImage(name string, opts TagImageOptions) error + func (c *Client) TopContainer(id string, psArgs string) (TopResult, error) + func (c *Client) UnpauseContainer(id string) error + func (c *Client) UpdateContainer(id string, opts UpdateContainerOptions) error + func (c *Client) UploadToContainer(id string, opts UploadToContainerOptions) error + func (c *Client) Version() (*Env, error) + func (c *Client) WaitContainer(id string) (int, error) + type CloseWaiter interface + Wait func() error + type CommitContainerOptions struct + Author string + Container string + Message string + Repository string + Run *Config + Tag string + type Config struct + AttachStderr bool + AttachStdin bool + AttachStdout bool + CPUSet string + CPUShares int64 + Cmd []string + DNS []string + Domainname string + Entrypoint []string + Env []string + ExposedPorts map[Port]struct{} + Hostname string + Image string + KernelMemory int64 + Labels map[string]string + MacAddress string + Memory int64 + MemoryReservation int64 + MemorySwap int64 + Mounts []Mount + NetworkDisabled bool + OnBuild []string + OpenStdin bool + PidsLimit int64 + PortSpecs []string + SecurityOpts []string + StdinOnce bool + StopSignal string + Tty bool + User string + VolumeDriver string + Volumes map[string]struct{} + VolumesFrom string + WorkingDir string + type Container struct + AppArmorProfile string + Args []string + Config *Config + Created time.Time + Driver string + ExecIDs []string + GraphDriver *GraphDriver + HostConfig *HostConfig + HostnamePath string + HostsPath string + ID string + Image string + LogPath string + Mounts []Mount + Name string + NetworkSettings *NetworkSettings + Node *SwarmNode + Path string + ResolvConfPath string + RestartCount int + State State + SysInitPath string + Volumes map[string]string + VolumesRW map[string]bool + type ContainerAlreadyRunning struct + ID string + func (err *ContainerAlreadyRunning) Error() string + type ContainerNetwork struct + EndpointID string + Gateway string + GlobalIPv6Address string + GlobalIPv6PrefixLen int + IPAddress string + IPPrefixLen int + IPv6Gateway string + MacAddress string + NetworkID string + type ContainerNotRunning struct + ID string + func (err *ContainerNotRunning) Error() string + type CopyFromContainerOptions struct + Container string + OutputStream io.Writer + Resource string + type CreateContainerOptions struct + Config *Config + HostConfig *HostConfig + Name string + type CreateExecOptions struct + AttachStderr bool + AttachStdin bool + AttachStdout bool + Cmd []string + Container string + Tty bool + User string + type CreateNetworkOptions struct + CheckDuplicate bool + Driver string + EnableIPv6 bool + IPAM IPAMOptions + Internal bool + Name string + Options map[string]interface{} + type CreateVolumeOptions struct + Driver string + DriverOpts map[string]string + Name string + type Device struct + CgroupPermissions string + PathInContainer string + PathOnHost string + type DockerInfo struct + Architecture string + BridgeNfIP6tables bool + BridgeNfIptables bool + CPUCfsPeriod bool + CPUCfsQuota bool + CPUSet bool + CPUShares bool + CgroupDriver string + ClusterAdvertise string + ClusterStore string + Containers int + ContainersPaused int + ContainersRunning int + ContainersStopped int + Debug bool + DockerRootDir string + Driver string + DriverStatus [][2]string + ExecutionDriver string + ExperimentalBuild bool + HTTPProxy string + HTTPSProxy string + ID string + IPv4Forwarding bool + Images int + IndexServerAddress string + KernelMemory bool + KernelVersion string + Labels []string + LoggingDriver string + MemTotal int64 + MemoryLimit bool + NCPU int + NEventsListener int + NFd int + NGoroutines int + Name string + NoProxy string + OSType string + OomKillDisable bool + OperatingSystem string + Plugins PluginsInfo + ServerVersion string + SwapLimit bool + SystemStatus [][2]string + SystemTime string + type DownloadFromContainerOptions struct + InactivityTimeout time.Duration + OutputStream io.Writer + Path string + type Endpoint struct + ID string + IPv4Address string + IPv6Address string + MacAddress string + Name string + type EndpointConfig struct + Aliases []string + IPAMConfig *EndpointIPAMConfig + Links []string + type EndpointIPAMConfig struct + IPv4Address string + IPv6Address string + type Env []string + func (env *Env) Decode(src io.Reader) error + func (env *Env) Exists(key string) bool + func (env *Env) Get(key string) (value string) + func (env *Env) GetBool(key string) (value bool) + func (env *Env) GetInt(key string) int + func (env *Env) GetInt64(key string) int64 + func (env *Env) GetJSON(key string, iface interface{}) error + func (env *Env) GetList(key string) []string + func (env *Env) Map() map[string]string + func (env *Env) Set(key, value string) + func (env *Env) SetAuto(key string, value interface{}) + func (env *Env) SetBool(key string, value bool) + func (env *Env) SetInt(key string, value int) + func (env *Env) SetInt64(key string, value int64) + func (env *Env) SetJSON(key string, value interface{}) error + func (env *Env) SetList(key string, value []string) error + type Error struct + Message string + Status int + func (e *Error) Error() string + type Exec struct + ID string + type ExecInspect struct + Container Container + ExitCode int + ID string + OpenStderr bool + OpenStdin bool + OpenStdout bool + ProcessConfig ExecProcessConfig + Running bool + type ExecProcessConfig struct + Arguments []string + EntryPoint string + Privileged bool + Tty bool + User string + type ExportContainerOptions struct + ID string + InactivityTimeout time.Duration + OutputStream io.Writer + type ExportImageOptions struct + InactivityTimeout time.Duration + Name string + OutputStream io.Writer + type ExportImagesOptions struct + InactivityTimeout time.Duration + Names []string + OutputStream io.Writer + type GraphDriver struct + Data map[string]string + Name string + type HostConfig struct + Binds []string + BlkioDeviceReadBps []BlockLimit + BlkioDeviceReadIOps []BlockLimit + BlkioDeviceWriteBps []BlockLimit + BlkioDeviceWriteIOps []BlockLimit + BlkioWeight int64 + BlkioWeightDevice []BlockWeight + CPUPeriod int64 + CPUQuota int64 + CPUSet string + CPUSetCPUs string + CPUSetMEMs string + CPUShares int64 + CapAdd []string + CapDrop []string + CgroupParent string + ContainerIDFile string + DNS []string + DNSOptions []string + DNSSearch []string + Devices []Device + ExtraHosts []string + GroupAdd []string + IpcMode string + Links []string + LogConfig LogConfig + LxcConf []KeyValuePair + Memory int64 + MemorySwap int64 + MemorySwappiness int64 + NetworkMode string + OOMKillDisable bool + OomScoreAdj int + PidMode string + PortBindings map[Port][]PortBinding + Privileged bool + PublishAllPorts bool + ReadonlyRootfs bool + RestartPolicy RestartPolicy + SecurityOpt []string + ShmSize int64 + UTSMode string + Ulimits []ULimit + UsernsMode string + VolumeDriver string + VolumesFrom []string + type IPAMConfig struct + AuxAddress map[string]string + Gateway string + IPRange string + Subnet string + type IPAMOptions struct + Config []IPAMConfig + Driver string + type Image struct + Architecture string + Author string + Comment string + Config *Config + Container string + ContainerConfig Config + Created time.Time + DockerVersion string + ID string + Parent string + RepoDigests []string + RepoTags []string + RootFS *RootFS + Size int64 + VirtualSize int64 + type ImageHistory struct + Created int64 + CreatedBy string + ID string + Size int64 + Tags []string + type ImagePre012 struct + Architecture string + Author string + Comment string + Config *Config + Container string + ContainerConfig Config + Created time.Time + DockerVersion string + ID string + Parent string + Size int64 + type ImportImageOptions struct + InactivityTimeout time.Duration + InputStream io.Reader + OutputStream io.Writer + RawJSONStream bool + Repository string + Source string + Tag string + type KeyValuePair struct + Key string + Value string + type KillContainerOptions struct + ID string + Signal Signal + type ListContainersOptions struct + All bool + Before string + Filters map[string][]string + Limit int + Since string + Size bool + type ListImagesOptions struct + All bool + Digests bool + Filter string + Filters map[string][]string + type ListVolumesOptions struct + Filters map[string][]string + type LoadImageOptions struct + InputStream io.Reader + type LogConfig struct + Config map[string]string + Type string + type LogsOptions struct + Container string + ErrorStream io.Writer + Follow bool + InactivityTimeout time.Duration + OutputStream io.Writer + RawTerminal bool + Since int64 + Stderr bool + Stdout bool + Tail string + Timestamps bool + type Mount struct + Destination string + Driver string + Mode string + Name string + RW bool + Source string + type Network struct + Containers map[string]Endpoint + Driver string + EnableIPv6 bool + ID string + IPAM IPAMOptions + Internal bool + Name string + Options map[string]string + Scope string + type NetworkConnectionOptions struct + Container string + EndpointConfig *EndpointConfig + Force bool + type NetworkFilterOpts map[string]map[string]bool + type NetworkList struct + Networks map[string]ContainerNetwork + type NetworkSettings struct + Bridge string + EndpointID string + Gateway string + GlobalIPv6Address string + GlobalIPv6PrefixLen int + IPAddress string + IPPrefixLen int + IPv6Gateway string + LinkLocalIPv6Address string + LinkLocalIPv6PrefixLen int + MacAddress string + NetworkID string + Networks map[string]ContainerNetwork + PortMapping map[string]PortMapping + Ports map[Port][]PortBinding + SandboxKey string + SecondaryIPAddresses []string + SecondaryIPv6Addresses []string + func (settings *NetworkSettings) PortMappingAPI() []APIPort + type NetworkStats struct + RxBytes uint64 + RxDropped uint64 + RxErrors uint64 + RxPackets uint64 + TxBytes uint64 + TxDropped uint64 + TxErrors uint64 + TxPackets uint64 + type NoSuchContainer struct + Err error + ID string + func (err *NoSuchContainer) Error() string + type NoSuchExec struct + ID string + func (err *NoSuchExec) Error() string + type NoSuchNetwork struct + ID string + func (err *NoSuchNetwork) Error() string + type NoSuchNetworkOrContainer struct + ContainerID string + NetworkID string + func (err *NoSuchNetworkOrContainer) Error() string + type PluginsInfo struct + Authorization []string + Network []string + Volume []string + type Port string + func (p Port) Port() string + func (p Port) Proto() string + type PortBinding struct + HostIP string + HostPort string + type PortMapping map[string]string + type PullImageOptions struct + InactivityTimeout time.Duration + OutputStream io.Writer + RawJSONStream bool + Registry string + Repository string + Tag string + type PushImageOptions struct + InactivityTimeout time.Duration + Name string + OutputStream io.Writer + RawJSONStream bool + Registry string + Tag string + type RemoveContainerOptions struct + Force bool + ID string + RemoveVolumes bool + type RemoveImageOptions struct + Force bool + NoPrune bool + type RenameContainerOptions struct + ID string + Name string + type RestartPolicy struct + MaximumRetryCount int + Name string + func AlwaysRestart() RestartPolicy + func NeverRestart() RestartPolicy + func RestartOnFailure(maxRetry int) RestartPolicy + type RootFS struct + Layers []string + Type string + type Signal int + type StartExecOptions struct + Detach bool + ErrorStream io.Writer + InputStream io.Reader + OutputStream io.Writer + RawTerminal bool + Success chan struct{} + Tty bool + type State struct + Dead bool + Error string + ExitCode int + FinishedAt time.Time + OOMKilled bool + Paused bool + Pid int + RemovalInProgress bool + Restarting bool + Running bool + StartedAt time.Time + Status string + func (s *State) StateString() string + func (s *State) String() string + type Stats struct + BlkioStats struct{ ... } + CPUStats CPUStats + MemoryStats struct{ ... } + Network NetworkStats + Networks map[string]NetworkStats + PidsStats struct{ ... } + PreCPUStats CPUStats + Read time.Time + type StatsOptions struct + Done <-chan bool + ID string + InactivityTimeout time.Duration + Stats chan<- *Stats + Stream bool + Timeout time.Duration + type SwarmNode struct + Addr string + CPUs int64 + ID string + IP string + Labels map[string]string + Memory int64 + Name string + type TagImageOptions struct + Force bool + Repo string + Tag string + type TopResult struct + Processes [][]string + Titles []string + type ULimit struct + Hard int64 + Name string + Soft int64 + type UpdateContainerOptions struct + BlkioWeight int + CPUPeriod int + CPUQuota int + CPUShares int + CpusetCpus string + CpusetMems string + KernelMemory int + Memory int + MemoryReservation int + MemorySwap int + RestartPolicy RestartPolicy + type UploadToContainerOptions struct + InputStream io.Reader + NoOverwriteDirNonDir bool + Path string + type Volume struct + Driver string + Labels map[string]string + Mountpoint string + Name string
Go to main page