Documentation ¶
Index ¶
- Constants
- Variables
- func GetFullContainerName(name string) (string, error)
- type Config
- type Container
- func (container *Container) AllocateNetwork() error
- func (container *Container) Changes() ([]archive.Change, error)
- func (container *Container) Copy(resource string) (io.ReadCloser, error)
- func (container *Container) DisableLink(name string)
- func (container *Container) Exec(execConfig *execConfig) error
- func (container *Container) Export() (archive.Archive, error)
- func (container *Container) ExportRw() (archive.Archive, error)
- func (container *Container) Exposes(p nat.Port) bool
- func (container *Container) FromDisk() error
- func (container *Container) GetExecIDs() []string
- func (container *Container) GetImage() (*image.Image, error)
- func (container *Container) GetMountLabel() string
- func (container *Container) GetProcessLabel() string
- func (container *Container) GetPtyMaster() (libcontainer.Console, error)
- func (container *Container) GetSize() (int64, int64)
- func (container *Container) HostConfig() *runconfig.HostConfig
- func (container *Container) Kill() error
- func (container *Container) KillSig(sig int) error
- func (c *Container) LogDriverType() string
- func (container *Container) LogEvent(action string)
- func (container *Container) Mount() error
- func (container *Container) Output() (output []byte, err error)
- func (container *Container) Pause() error
- func (container *Container) ReadLog(name string) (io.Reader, error)
- func (container *Container) ReleaseNetwork()
- func (container *Container) Resize(h, w int) error
- func (container *Container) Restart(seconds int) error
- func (container *Container) RestoreNetwork() error
- func (container *Container) RootfsPath() string
- func (container *Container) Run() error
- func (container *Container) SetHostConfig(hostConfig *runconfig.HostConfig)
- func (container *Container) Start() (err error)
- func (container *Container) Stats() (*execdriver.ResourceStats, error)
- func (container *Container) Stop(seconds int) error
- func (container *Container) ToDisk() error
- func (container *Container) Unmount() error
- func (container *Container) Unpause() error
- func (container *Container) VolumeMounts() map[string]*Mount
- func (container *Container) VolumePaths() map[string]struct{}
- func (container *Container) WriteHostConfig() error
- type Daemon
- func (daemon *Daemon) Attach(streamConfig *StreamConfig, openStdin, stdinOnce, tty bool, ...) chan error
- func (daemon *Daemon) Changes(container *Container) ([]archive.Change, error)
- func (daemon *Daemon) Children(name string) (map[string]*Container, error)
- func (daemon *Daemon) CmdInfo(job *engine.Job) engine.Status
- func (daemon *Daemon) Commit(container *Container, repository, tag, comment, author string, pause bool, ...) (*image.Image, error)
- func (daemon *Daemon) Config() *Config
- func (daemon *Daemon) ContainerAttach(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerChanges(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerCommit(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerCopy(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerCreate(job *engine.Job) engine.Status
- func (d *Daemon) ContainerExecCreate(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerExecInspect(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerExecResize(job *engine.Job) engine.Status
- func (d *Daemon) ContainerExecStart(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerExport(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerGraph() *graphdb.Database
- func (daemon *Daemon) ContainerInspect(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerKill(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerLogs(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerPause(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerRename(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerResize(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerRestart(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerRm(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerStart(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerStats(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerStop(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerTop(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerUnpause(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerWait(job *engine.Job) engine.Status
- func (daemon *Daemon) Containers(job *engine.Job) engine.Status
- func (daemon *Daemon) Create(config *runconfig.Config, hostConfig *runconfig.HostConfig, name string) (*Container, []string, error)
- func (daemon *Daemon) DeleteImage(eng *engine.Engine, name string, imgs *engine.Table, ...) error
- func (daemon *Daemon) DeleteVolumes(volumeIDs map[string]struct{})
- func (daemon *Daemon) Diff(container *Container) (archive.Archive, error)
- func (d *Daemon) Exec(c *Container, execConfig *execConfig, pipes *execdriver.Pipes, ...) (int, error)
- func (daemon *Daemon) ExecutionDriver() execdriver.Driver
- func (daemon *Daemon) Exists(id string) bool
- func (daemon *Daemon) GenerateSecurityOpt(ipcMode runconfig.IpcMode, pidMode runconfig.PidMode) ([]string, error)
- func (daemon *Daemon) Get(prefixOrName string) (*Container, error)
- func (daemon *Daemon) GetByName(name string) (*Container, error)
- func (daemon *Daemon) Graph() *graph.Graph
- func (daemon *Daemon) GraphDriver() graphdriver.Driver
- func (daemon *Daemon) ImageDelete(job *engine.Job) engine.Status
- func (daemon *Daemon) ImageGetCached(imgID string, config *runconfig.Config) (*image.Image, error)
- func (daemon *Daemon) Install(eng *engine.Engine) error
- func (daemon *Daemon) Kill(c *Container, sig int) error
- func (daemon *Daemon) List() []*Container
- func (daemon *Daemon) LogToDisk(src *broadcastwriter.BroadcastWriter, dst, stream string) error
- func (daemon *Daemon) Mount(container *Container) error
- func (daemon *Daemon) Nuke() error
- func (daemon *Daemon) Parents(name string) ([]string, error)
- func (daemon *Daemon) Pause(c *Container) error
- func (daemon *Daemon) Register(container *Container) error
- func (daemon *Daemon) RegisterLink(parent, child *Container, alias string) error
- func (daemon *Daemon) RegisterLinks(container *Container, hostConfig *runconfig.HostConfig) error
- func (daemon *Daemon) Repositories() *graph.TagStore
- func (daemon *Daemon) Rm(container *Container) error
- func (daemon *Daemon) Run(c *Container, pipes *execdriver.Pipes, startCallback execdriver.StartCallback) (execdriver.ExitStatus, error)
- func (daemon *Daemon) Stats(c *Container) (*execdriver.ResourceStats, error)
- func (daemon *Daemon) SubscribeToContainerStats(name string) (chan interface{}, error)
- func (daemon *Daemon) SystemConfig() *sysinfo.SysInfo
- func (daemon *Daemon) SystemInitPath() string
- func (daemon *Daemon) Unmount(container *Container) error
- func (daemon *Daemon) Unpause(c *Container) error
- func (daemon *Daemon) UnsubscribeToContainerStats(name string, ch chan interface{}) error
- type History
- type Mount
- type NetworkSettings
- type PortMapping
- type State
- func (s *State) GetExitCode() int
- func (s *State) GetPid() int
- func (s *State) IsPaused() bool
- func (s *State) IsRestarting() bool
- func (s *State) IsRunning() bool
- func (s *State) SetPaused()
- func (s *State) SetRestarting(exitStatus *execdriver.ExitStatus)
- func (s *State) SetRunning(pid int)
- func (s *State) SetStopped(exitStatus *execdriver.ExitStatus)
- func (s *State) SetUnpaused()
- func (s *State) StateString() string
- func (s *State) String() string
- func (s *State) WaitRunning(timeout time.Duration) (int, error)
- func (s *State) WaitStop(timeout time.Duration) (int, error)
- type StreamConfig
- func (streamConfig *StreamConfig) StderrLogPipe() io.ReadCloser
- func (streamConfig *StreamConfig) StderrPipe() io.ReadCloser
- func (streamConfig *StreamConfig) StdinPipe() io.WriteCloser
- func (streamConfig *StreamConfig) StdoutLogPipe() io.ReadCloser
- func (streamConfig *StreamConfig) StdoutPipe() io.ReadCloser
Constants ¶
const DefaultPathEnv = "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
Variables ¶
Functions ¶
func GetFullContainerName ¶
Types ¶
type Config ¶ added in v1.2.0
type Config struct { Pidfile string Root string AutoRestart bool Dns []string DnsSearch []string EnableIPv6 bool EnableIptables bool EnableIpForward bool EnableIpMasq bool DefaultIp net.IP BridgeIface string BridgeIP string FixedCIDR string FixedCIDRv6 string InterContainerCommunication bool GraphDriver string GraphOptions []string ExecDriver string Mtu int SocketGroup string EnableCors bool CorsHeaders string DisableNetwork bool EnableSelinuxSupport bool Context map[string][]string TrustKeyPath string Labels []string Ulimits map[string]*ulimit.Ulimit LogConfig runconfig.LogConfig }
Config define the configuration of a docker daemon These are the configuration settings that you pass to the docker daemon when you launch it with say: `docker -d -e lxc` FIXME: separate runtime configuration from http api configuration
func (*Config) InstallFlags ¶ added in v1.2.0
func (config *Config) InstallFlags()
InstallFlags adds command-line options to the top-level flag parser for the current process. Subsequent calls to `flag.Parse` will populate config with values parsed from the command-line.
type Container ¶
type Container struct { *State `json:"State"` // Needed for remote api version <= 1.11 ID string Created time.Time Path string Args []string Config *runconfig.Config ImageID string `json:"Image"` NetworkSettings *NetworkSettings ResolvConfPath string HostnamePath string HostsPath string LogPath string Name string Driver string ExecDriver string StreamConfig MountLabel, ProcessLabel string AppArmorProfile string RestartCount int UpdateDns bool // Maps container paths to volume paths. The key in this is the path to which // the volume is being mounted inside the container. Value is the path of the // volume on disk Volumes map[string]string // Store rw/ro in a separate structure to preserve reverse-compatibility on-disk. // Easier than migrating older container configs :) VolumesRW map[string]bool AppliedVolumesFrom map[string]struct{} // contains filtered or unexported fields }
func (*Container) AllocateNetwork ¶ added in v1.3.0
func (*Container) DisableLink ¶
func (*Container) GetExecIDs ¶ added in v1.5.0
func (*Container) GetMountLabel ¶
func (*Container) GetProcessLabel ¶
func (*Container) GetPtyMaster ¶
func (container *Container) GetPtyMaster() (libcontainer.Console, error)
func (*Container) HostConfig ¶
func (container *Container) HostConfig() *runconfig.HostConfig
func (*Container) LogDriverType ¶
func (*Container) ReleaseNetwork ¶ added in v1.3.0
func (container *Container) ReleaseNetwork()
func (*Container) RestoreNetwork ¶ added in v1.3.0
func (*Container) RootfsPath ¶
This method must be exported to be used from the lxc template This directory is only usable when the container is running
func (*Container) SetHostConfig ¶
func (container *Container) SetHostConfig(hostConfig *runconfig.HostConfig)
func (*Container) Stats ¶ added in v1.5.0
func (container *Container) Stats() (*execdriver.ResourceStats, error)
func (*Container) VolumeMounts ¶ added in v1.3.0
func (*Container) VolumePaths ¶ added in v1.3.0
func (*Container) WriteHostConfig ¶
type Daemon ¶
type Daemon struct { ID string // contains filtered or unexported fields }
func NewDaemonFromDirectory ¶
func (*Daemon) Attach ¶
func (daemon *Daemon) Attach(streamConfig *StreamConfig, openStdin, stdinOnce, tty bool, stdin io.ReadCloser, stdout io.Writer, stderr io.Writer) chan error
func (*Daemon) Commit ¶
func (daemon *Daemon) Commit(container *Container, repository, tag, comment, author string, pause bool, config *runconfig.Config) (*image.Image, error)
Commit creates a new filesystem image from the current state of a container. The image can optionally be tagged into a repository
func (*Daemon) ContainerAttach ¶ added in v1.2.0
func (*Daemon) ContainerChanges ¶ added in v1.2.0
func (*Daemon) ContainerCommit ¶ added in v1.2.0
func (*Daemon) ContainerCopy ¶ added in v1.2.0
func (*Daemon) ContainerCreate ¶ added in v1.2.0
func (*Daemon) ContainerExecCreate ¶ added in v1.3.0
func (*Daemon) ContainerExecInspect ¶ added in v1.4.0
func (*Daemon) ContainerExecResize ¶ added in v1.3.0
func (*Daemon) ContainerExecStart ¶ added in v1.3.0
func (*Daemon) ContainerExport ¶ added in v1.2.0
func (*Daemon) ContainerGraph ¶
func (*Daemon) ContainerInspect ¶ added in v0.12.0
func (*Daemon) ContainerKill ¶ added in v1.2.0
ContainerKill send signal to the container If no signal is given (sig 0), then Kill with SIGKILL and wait for the container to exit. If a signal is given, then just send it to the container and return.
func (*Daemon) ContainerLogs ¶ added in v1.2.0
func (*Daemon) ContainerPause ¶ added in v1.2.0
func (*Daemon) ContainerRename ¶ added in v1.5.0
func (*Daemon) ContainerResize ¶ added in v1.2.0
func (*Daemon) ContainerRestart ¶ added in v1.2.0
func (*Daemon) ContainerRm ¶ added in v1.3.0
func (*Daemon) ContainerStart ¶ added in v1.2.0
func (*Daemon) ContainerStats ¶ added in v1.5.0
func (*Daemon) ContainerStop ¶ added in v1.2.0
func (*Daemon) ContainerTop ¶ added in v1.2.0
func (*Daemon) ContainerUnpause ¶ added in v1.2.0
func (*Daemon) ContainerWait ¶ added in v1.2.0
func (*Daemon) Containers ¶ added in v1.2.0
func (*Daemon) Create ¶
func (daemon *Daemon) Create(config *runconfig.Config, hostConfig *runconfig.HostConfig, name string) (*Container, []string, error)
Create creates a new container from the given configuration with a given name.
func (*Daemon) DeleteImage ¶ added in v1.2.0
func (daemon *Daemon) DeleteImage(eng *engine.Engine, name string, imgs *engine.Table, first, force, noprune bool) error
FIXME: make this private and use the job instead
func (*Daemon) DeleteVolumes ¶ added in v1.3.0
func (*Daemon) Exec ¶ added in v1.3.0
func (d *Daemon) Exec(c *Container, execConfig *execConfig, pipes *execdriver.Pipes, startCallback execdriver.StartCallback) (int, error)
func (*Daemon) ExecutionDriver ¶
func (daemon *Daemon) ExecutionDriver() execdriver.Driver
func (*Daemon) Exists ¶
Exists returns a true if a container of the specified ID or name exists, false otherwise.
func (*Daemon) GenerateSecurityOpt ¶ added in v1.4.0
func (*Daemon) Get ¶
Get looks for a container using the provided information, which could be one of the following inputs from the caller:
- A full container ID, which will exact match a container in daemon's list
- A container name, which will only exact match via the GetByName() function
- A partial container ID prefix (e.g. short ID) of any length that is unique enough to only return a single container object If none of these searches succeed, an error is returned
func (*Daemon) Graph ¶
FIXME: this is a convenience function for integration tests which need direct access to daemon.graph. Once the tests switch to using engine and jobs, this method can go away.
func (*Daemon) GraphDriver ¶
func (daemon *Daemon) GraphDriver() graphdriver.Driver
func (*Daemon) ImageDelete ¶ added in v1.2.0
func (*Daemon) ImageGetCached ¶ added in v1.2.0
func (*Daemon) LogToDisk ¶
func (daemon *Daemon) LogToDisk(src *broadcastwriter.BroadcastWriter, dst, stream string) error
func (*Daemon) Nuke ¶
Nuke kills all containers then removes all content from the content root, including images, volumes and container filesystems. Again: this will remove your entire docker daemon! FIXME: this is deprecated, and only used in legacy tests. Please remove.
func (*Daemon) Register ¶
Register makes a container object usable by the daemon as <container.ID> This is a wrapper for register
func (*Daemon) RegisterLink ¶
func (*Daemon) RegisterLinks ¶ added in v0.12.0
func (daemon *Daemon) RegisterLinks(container *Container, hostConfig *runconfig.HostConfig) error
func (*Daemon) Repositories ¶
func (*Daemon) Rm ¶
Destroy unregisters a container from the daemon and cleanly removes its contents from the filesystem.
func (*Daemon) Run ¶
func (daemon *Daemon) Run(c *Container, pipes *execdriver.Pipes, startCallback execdriver.StartCallback) (execdriver.ExitStatus, error)
func (*Daemon) Stats ¶ added in v1.5.0
func (daemon *Daemon) Stats(c *Container) (*execdriver.ResourceStats, error)
func (*Daemon) SubscribeToContainerStats ¶ added in v1.5.0
func (*Daemon) SystemConfig ¶
func (*Daemon) SystemInitPath ¶
func (*Daemon) UnsubscribeToContainerStats ¶ added in v1.5.0
type History ¶
type History []*Container
History is a convenience type for storing a list of containers, ordered by creation date.
type NetworkSettings ¶
type NetworkSettings struct { IPAddress string IPPrefixLen int MacAddress string LinkLocalIPv6Address string LinkLocalIPv6PrefixLen int GlobalIPv6Address string GlobalIPv6PrefixLen int Gateway string IPv6Gateway string Bridge string PortMapping map[string]PortMapping // Deprecated Ports nat.PortMap }
func (*NetworkSettings) PortMappingAPI ¶
func (settings *NetworkSettings) PortMappingAPI() *engine.Table
type PortMapping ¶
FIXME: move deprecated port stuff to nat to clean up the core.
type State ¶
type State struct { sync.Mutex Running bool Paused bool Restarting bool OOMKilled bool Pid int ExitCode int Error string // contains last known error when starting the container StartedAt time.Time FinishedAt time.Time // contains filtered or unexported fields }
func (*State) GetExitCode ¶
func (*State) IsRestarting ¶ added in v1.2.0
func (*State) SetRestarting ¶ added in v1.2.0
func (s *State) SetRestarting(exitStatus *execdriver.ExitStatus)
SetRestarting is when docker hanldes the auto restart of containers when they are in the middle of a stop and being restarted again
func (*State) SetRunning ¶
func (*State) SetStopped ¶
func (s *State) SetStopped(exitStatus *execdriver.ExitStatus)
func (*State) SetUnpaused ¶ added in v0.12.0
func (s *State) SetUnpaused()
func (*State) StateString ¶ added in v1.3.0
StateString returns a single string to describe state
func (*State) WaitRunning ¶ added in v1.1.0
WaitRunning waits until state is running. If state already running it returns immediately. If you want wait forever you must supply negative timeout. Returns pid, that was passed to SetRunning
type StreamConfig ¶ added in v1.3.0
type StreamConfig struct {
// contains filtered or unexported fields
}
func (*StreamConfig) StderrLogPipe ¶ added in v1.3.0
func (streamConfig *StreamConfig) StderrLogPipe() io.ReadCloser
func (*StreamConfig) StderrPipe ¶ added in v1.3.0
func (streamConfig *StreamConfig) StderrPipe() io.ReadCloser
func (*StreamConfig) StdinPipe ¶ added in v1.3.0
func (streamConfig *StreamConfig) StdinPipe() io.WriteCloser
func (*StreamConfig) StdoutLogPipe ¶ added in v1.3.0
func (streamConfig *StreamConfig) StdoutLogPipe() io.ReadCloser
func (*StreamConfig) StdoutPipe ¶ added in v1.3.0
func (streamConfig *StreamConfig) StdoutPipe() io.ReadCloser
Source Files ¶
- attach.go
- changes.go
- commit.go
- config.go
- container.go
- copy.go
- create.go
- daemon.go
- daemon_aufs.go
- daemon_btrfs.go
- daemon_devicemapper.go
- daemon_overlay.go
- delete.go
- exec.go
- export.go
- history.go
- image_delete.go
- info.go
- inspect.go
- kill.go
- list.go
- logs.go
- monitor.go
- network_settings.go
- pause.go
- rename.go
- resize.go
- restart.go
- start.go
- state.go
- stats.go
- stats_collector.go
- stop.go
- top.go
- utils.go
- utils_linux.go
- volumes.go
- wait.go