Documentation ¶
Index ¶
- Constants
- Variables
- func GetDefaultNetworkMtu() int
- func GetFullContainerName(name string) (string, error)
- type BuildFile
- type Config
- type Container
- 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) 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) GetImage() (*image.Image, error)
- func (container *Container) GetMountLabel() string
- func (container *Container) GetProcessLabel() string
- func (container *Container) GetPtyMaster() (*os.File, 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 (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) Resize(h, w int) error
- func (container *Container) Restart(seconds int) 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) StderrLogPipe() io.ReadCloser
- func (container *Container) StderrPipe() (io.ReadCloser, error)
- func (container *Container) StdinPipe() (io.WriteCloser, error)
- func (container *Container) StdoutLogPipe() io.ReadCloser
- func (container *Container) StdoutPipe() (io.ReadCloser, 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) WriteHostConfig() error
- type Daemon
- func (daemon *Daemon) Attach(container *Container, stdin io.ReadCloser, stdinCloser io.Closer, ...) chan error
- func (daemon *Daemon) Changes(container *Container) ([]archive.Change, error)
- func (daemon *Daemon) Children(name string) (map[string]*Container, error)
- func (daemon *Daemon) CmdBuild(job *engine.Job) engine.Status
- 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 (daemon *Daemon) ContainerDestroy(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) ContainerResize(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerRestart(job *engine.Job) engine.Status
- func (daemon *Daemon) ContainerStart(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, name string) (*Container, []string, error)
- func (daemon *Daemon) DeleteImage(eng *engine.Engine, name string, imgs *engine.Table, ...) error
- func (daemon *Daemon) Destroy(container *Container) error
- func (daemon *Daemon) Diff(container *Container) (archive.Archive, error)
- func (daemon *Daemon) ExecutionDriver() execdriver.Driver
- func (daemon *Daemon) Exists(id string) bool
- func (daemon *Daemon) Get(name string) *Container
- 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) 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) Run(c *Container, pipes *execdriver.Pipes, startCallback execdriver.StartCallback) (int, 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) Volumes() *graph.Graph
- type History
- 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) MarshalJSON() ([]byte, error)
- func (s *State) SetPaused()
- func (s *State) SetRestarting(exitCode int)
- func (s *State) SetRunning(pid int)
- func (s *State) SetStopped(exitCode int)
- func (s *State) SetUnpaused()
- func (s *State) String() string
- func (s *State) WaitRunning(timeout time.Duration) (int, error)
- func (s *State) WaitStop(timeout time.Duration) (int, error)
- type Volume
Constants ¶
const DefaultPathEnv = "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
const (
DisableNetworkBridge = "none"
)
Variables ¶
var ( ErrNotATTY = errors.New("The PTY is not a file") ErrNoTTY = errors.New("No PTY found") ErrContainerStart = errors.New("The container failed to start. Unknown error") ErrContainerStartTimeout = errors.New("The container failed to start due to timed out.") )
var (
DefaultDns = []string{"8.8.8.8", "8.8.4.4"}
)
var (
ErrDockerfileEmpty = errors.New("Dockerfile cannot be empty")
)
Functions ¶
func GetDefaultNetworkMtu ¶
func GetDefaultNetworkMtu() int
func GetFullContainerName ¶
Types ¶
type BuildFile ¶
type BuildFile interface { Build(io.Reader) (string, error) CmdFrom(string) error CmdRun(string) error }
func NewBuildFile ¶
type Config ¶
type Config struct { Pidfile string //Docker Daemon所属进程的PID文件 Root string //Docker 运行时所使用的root路径 AutoRestart bool //如果为true,则支持docker run时的重启 Dns []string //Docker 使用DNS Server DnsSearch []string //Docker使用指定的DNS查找域名 EnableIptables bool //启用Docker的iptables功能 EnableIpForward bool //启用net.ipv4.ip_forward功能 DefaultIp net.IP //绑定容器端口时,使用默认的ip BridgeIface string //添加容器网络至已有的网桥 BridgeIP string //创建网桥的IP地址 InterContainerCommunication bool //是否允许相同host上容器间的通信 GraphDriver string //Docker运行时使用的特定存储驱动 GraphOptions []string //可设置的存储驱动选项 ExecDriver string // Docker运行时使用的特定exec驱动 Mtu int //设置容器网络的MTU DisableNetwork bool //有定义,之后未初始化 EnableSelinuxSupport bool //启用SELinux功能的支持 Context map[string][]string //有定义,之后未初始化 }
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 ¶
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 { sync.Mutex ID string Created time.Time Path string Args []string Config *runconfig.Config State *State Image string NetworkSettings *NetworkSettings ResolvConfPath string HostnamePath string HostsPath string Name string Driver string ExecDriver string MountLabel, ProcessLabel string RestartCount int 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 // contains filtered or unexported fields }
func (*Container) DisableLink ¶
func (*Container) GetMountLabel ¶
func (*Container) GetProcessLabel ¶
func (*Container) HostConfig ¶
func (container *Container) HostConfig() *runconfig.HostConfig
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) StderrLogPipe ¶
func (container *Container) StderrLogPipe() io.ReadCloser
func (*Container) StderrPipe ¶
func (container *Container) StderrPipe() (io.ReadCloser, error)
func (*Container) StdoutLogPipe ¶
func (container *Container) StdoutLogPipe() io.ReadCloser
func (*Container) StdoutPipe ¶
func (container *Container) StdoutPipe() (io.ReadCloser, error)
func (*Container) WriteHostConfig ¶
type Daemon ¶
type Daemon struct {
// contains filtered or unexported fields
}
func NewDaemonFromDirectory ¶
func (*Daemon) Attach ¶
func (daemon *Daemon) Attach(container *Container, stdin io.ReadCloser, stdinCloser io.Closer, stdout io.Writer, stderr io.Writer) chan error
FIXME: this should be private, and every outside subsystem should go through the "container_attach" job. But that would require that job to be properly documented, as well as the relationship betweem Attach and ContainerAttach.
This method is in use by builder/builder.go.
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 ¶
func (*Daemon) ContainerChanges ¶
func (*Daemon) ContainerCommit ¶
func (*Daemon) ContainerCreate ¶
func (*Daemon) ContainerDestroy ¶
FIXME: rename to ContainerRemove for consistency with the CLI command.
func (*Daemon) ContainerExport ¶
func (*Daemon) ContainerGraph ¶
func (*Daemon) ContainerInspect ¶
func (*Daemon) ContainerKill ¶
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) ContainerResize ¶
func (*Daemon) ContainerRestart ¶
func (*Daemon) ContainerUnpause ¶
func (*Daemon) Create ¶
Create creates a new container from the given configuration with a given name.
func (*Daemon) DeleteImage ¶
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) Destroy ¶
Destroy unregisters a container from the daemon and cleanly removes its contents from the filesystem. FIXME: rename to Rm for consistency with the CLI command
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) Get ¶
Get looks for a container by the specified ID or name, and returns it. If the container is not found, or if an error occurs, nil 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) ImageGetCached ¶
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 ¶
func (daemon *Daemon) RegisterLinks(container *Container, hostConfig *runconfig.HostConfig) error
func (*Daemon) Repositories ¶
func (*Daemon) Run ¶
func (daemon *Daemon) Run(c *Container, pipes *execdriver.Pipes, startCallback execdriver.StartCallback) (int, error)
func (*Daemon) SystemConfig ¶
func (*Daemon) SystemInitPath ¶
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 Gateway 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.RWMutex Running bool Paused bool Restarting bool Pid int ExitCode int StartedAt time.Time FinishedAt time.Time // contains filtered or unexported fields }
func (*State) GetExitCode ¶
func (*State) IsRestarting ¶
func (*State) MarshalJSON ¶
MarshalJSON for state is needed to avoid race conditions on inspect
func (*State) SetRestarting ¶
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 (*State) SetUnpaused ¶
func (s *State) SetUnpaused()
func (*State) WaitRunning ¶
WaitRunning waits until state is running. If state already running it returns immediatly. If you want wait forever you must supply negative timeout. Returns pid, that was passed to SetRunning
Source Files ¶
- attach.go
- build.go
- changes.go
- commit.go
- config.go
- container.go
- copy.go
- create.go
- daemon.go
- daemon_aufs.go
- daemon_btrfs.go
- daemon_devicemapper.go
- delete.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
- resize.go
- restart.go
- start.go
- state.go
- stop.go
- top.go
- utils.go
- utils_linux.go
- volumes.go
- wait.go