docker

package

Go to main page

Versions in this module

v1

v1.3.0-alpha.2

Jun 21, 2016

v1.3.0-alpha.1

May 25, 2016

v1.0.7

Oct 29, 2015

Changes in this version

+ var ErrCannotParseDockercfg = errors.New("Failed to read authentication from dockercfg")

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

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

+ var ErrNoSuchVolume = errors.New("no such volume")

+ var ErrVolumeInUse = errors.New("volume in use and cannot be removed")

type APIContainers

+ Labels map[string]string

type APIImages

+ Labels map[string]string

+ type AuthConfigurations119 map[string]AuthConfiguration

type BuildImageOptions

+ Ulimits []ULimit

+ type CPUStats struct

+ CPUUsage struct{ ... }

+ SystemCPUUsage uint64

+ ThrottlingData struct{ ... }

type Client

+ Dialer *net.Dialer

+ func NewClientFromEnv() (*Client, error)

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

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

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

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

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

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

+ func (c *Client) DownloadFromContainer(id string, opts DownloadFromContainerOptions) error

+ func (c *Client) Endpoint() string

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

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

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

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

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

+ func (c *Client) UploadToContainer(id string, opts UploadToContainerOptions) error

type Config

+ Mounts []Mount

+ VolumeDriver string

type Container

+ LogPath string

+ Mounts []Mount

+ RestartCount int

type CreateExecOptions

+ User string

+ type CreateNetworkOptions struct

+ Name string

+ NetworkType string

+ Options map[string]interface{}

+ type CreateVolumeOptions struct

+ Driver string

+ DriverOpts map[string]string

+ Name string

+ type DownloadFromContainerOptions struct

+ OutputStream io.Writer

+ Path string

+ type Endpoint struct

+ ID string

+ Name string

+ Network string

type HostConfig

+ BlkioWeight int64

+ CPUPeriod int64

+ CPUQuota int64

+ CPUSetCPUs string

+ CPUSetMEMs string

+ GroupAdd []string

+ MemorySwappiness int64

+ OOMKillDisable bool

+ UTSMode string

+ Ulimits []ULimit

type Image

+ VirtualSize int64

type ImportImageOptions

+ RawJSONStream bool

+ type ListVolumesOptions struct

+ Filters map[string][]string

type LogsOptions

+ Since int64

+ type Mount struct

+ Destination string

+ Mode string

+ RW bool

+ Source string

+ type Network struct

+ Endpoints []*Endpoint

+ ID string

+ Name string

+ Type string

type NetworkSettings

+ EndpointID string

+ GlobalIPv6Address string

+ GlobalIPv6PrefixLen int

+ IPv6Gateway string

+ LinkLocalIPv6Address string

+ LinkLocalIPv6PrefixLen int

+ MacAddress string

+ NetworkID string

+ SandboxKey string

+ SecondaryIPAddresses []string

+ SecondaryIPv6Addresses []string

+ type NoSuchNetwork struct

+ ID string

+ func (err *NoSuchNetwork) Error() string

type Stats

+ PreCPUStats CPUStats

type StatsOptions

+ Done <-chan bool

+ Stream bool

+ Timeout time.Duration

+ type ULimit struct

+ Hard int64

+ Name string

+ Soft int64

+ type UploadToContainerOptions struct

+ InputStream io.Reader

+ NoOverwriteDirNonDir bool

+ Path string

+ type Volume struct

+ Driver string

+ Mountpoint string

+ Name string

v1.0.0

Jun 18, 2015

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 ErrConnectionRefused = errors.New("cannot connect to Docker endpoint")

+ 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 ErrNoListeners = errors.New("no listeners present to receive event")

+ var ErrNoSuchImage = errors.New("no such image")

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

+ type APIContainers struct

+ Command string

+ Created int64

+ ID string

+ Image string

+ Names []string

+ Ports []APIPort

+ SizeRootFs int64

+ SizeRw int64

+ Status string

+ type APIEvents struct

+ From string

+ ID string

+ Status string

+ Time int64

+ type APIImageSearch struct

+ Description string

+ IsAutomated bool

+ IsOfficial bool

+ Name string

+ StarCount int

+ type APIImages struct

+ Created int64

+ ID string

+ ParentID string

+ RepoDigests []string

+ RepoTags []string

+ Size int64

+ VirtualSize int64

+ 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 BlkioStatsEntry struct

+ Major uint64

+ Minor uint64

+ Op string

+ Value uint64

+ type BuildImageOptions struct

+ Auth AuthConfiguration

+ AuthConfigs AuthConfigurations

+ CPUSetCPUs string

+ CPUShares int64

+ ContextDir string

+ Dockerfile string

+ ForceRmTmpContainer bool

+ InputStream io.Reader

+ Memory int64

+ Memswap int64

+ Name string

+ NoCache bool

+ OutputStream io.Writer

+ Pull bool

+ RawJSONStream bool

+ Remote string

+ RmTmpContainer bool

+ SuppressOutput bool

+ type Change struct

+ Kind ChangeType

+ Path string

+ func (change *Change) String() string

+ type ChangeType int

+ const ChangeAdd

+ const ChangeDelete

+ const ChangeModify

+ type Client struct

+ HTTPClient *http.Client

+ SkipServerVersionCheck bool

+ TLSConfig *tls.Config

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

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

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

+ func NewVersionedTLSClient(endpoint string, cert, key, ca, apiVersionString string) (*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) BuildImage(opts BuildImageOptions) error

+ func (c *Client) CommitContainer(opts CommitContainerOptions) (*Image, 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) ExportContainer(opts ExportContainerOptions) error

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

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

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

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

+ func (c *Client) Info() (*Env, 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) KillContainer(opts KillContainerOptions) error

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

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

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

+ func (c *Client) Logs(opts LogsOptions) 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) 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) StartContainer(id string, hostConfig *HostConfig) error

+ func (c *Client) StartExec(id string, opts StartExecOptions) 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) Version() (*Env, error)

+ func (c *Client) WaitContainer(id string) (int, 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

+ Labels map[string]string

+ MacAddress string

+ Memory int64

+ MemorySwap int64

+ NetworkDisabled bool

+ OnBuild []string

+ OpenStdin bool

+ PortSpecs []string

+ SecurityOpts []string

+ StdinOnce bool

+ Tty bool

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

+ HostConfig *HostConfig

+ HostnamePath string

+ HostsPath string

+ ID string

+ Image string

+ Name string

+ NetworkSettings *NetworkSettings

+ Node *SwarmNode

+ Path string

+ ResolvConfPath string

+ State State

+ SysInitPath string

+ Volumes map[string]string

+ VolumesRW map[string]bool

+ type ContainerAlreadyRunning struct

+ ID string

+ func (err *ContainerAlreadyRunning) Error() 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

+ type Device struct

+ CgroupPermissions string

+ PathInContainer string

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

+ OutputStream io.Writer

+ type ExportImageOptions struct

+ Name string

+ OutputStream io.Writer

+ type ExportImagesOptions struct

+ Names []string

+ OutputStream io.Writer

+ type HostConfig struct

+ Binds []string

+ CPUSet string

+ CPUShares int64

+ CapAdd []string

+ CapDrop []string

+ CgroupParent string

+ ContainerIDFile string

+ DNS []string

+ DNSSearch []string

+ Devices []Device

+ ExtraHosts []string

+ IpcMode string

+ Links []string

+ LogConfig LogConfig

+ LxcConf []KeyValuePair

+ Memory int64

+ MemorySwap int64

+ NetworkMode string

+ PidMode string

+ PortBindings map[Port][]PortBinding

+ Privileged bool

+ PublishAllPorts bool

+ ReadonlyRootfs bool

+ RestartPolicy RestartPolicy

+ SecurityOpt []string

+ VolumesFrom []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

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

+ InputStream io.Reader

+ OutputStream io.Writer

+ 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

+ 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

+ OutputStream io.Writer

+ RawTerminal bool

+ Stderr bool

+ Stdout bool

+ Tail string

+ Timestamps bool

+ type NetworkSettings struct

+ Bridge string

+ Gateway string

+ IPAddress string

+ IPPrefixLen int

+ PortMapping map[string]PortMapping

+ Ports map[Port][]PortBinding

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

+ type NoSuchContainer struct

+ Err error

+ ID string

+ func (err *NoSuchContainer) Error() string

+ type NoSuchExec struct

+ ID string

+ func (err *NoSuchExec) Error() 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

+ OutputStream io.Writer

+ RawJSONStream bool

+ Registry string

+ Repository string

+ Tag string

+ type PushImageOptions struct

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

+ Error string

+ ExitCode int

+ FinishedAt time.Time

+ OOMKilled bool

+ Paused bool

+ Pid int

+ Restarting bool

+ Running bool

+ StartedAt time.Time

+ func (s *State) String() string

+ type Stats struct

+ BlkioStats struct{ ... }

+ CPUStats struct{ ... }

+ MemoryStats struct{ ... }

+ Network struct{ ... }

+ Read time.Time

+ type StatsOptions struct

+ ID string

+ Stats chan<- *Stats

+ 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

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL