Documentation
¶
Index ¶
- Variables
- func RegisterInitFunc(name string, fct InitFunc) error
- func SetTerminal(command *Command, pipes *Pipes) error
- type Command
- type Context
- type Driver
- type Info
- type InitArgs
- type InitFunc
- type Mount
- type Network
- type NetworkInterface
- type Pipes
- type Resources
- type StartCallback
- type StdConsole
- type Terminal
- type TtyConsole
- type TtyTerminal
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrNotRunning = errors.New("Process could not be started") ErrWaitTimeoutReached = errors.New("Wait timeout reached") ErrDriverAlreadyRegistered = errors.New("A driver already registered this docker init function") ErrDriverNotFound = errors.New("The requested docker init has not been found") )
Functions ¶
func RegisterInitFunc ¶
func SetTerminal ¶
Types ¶
type Command ¶
type Command struct {
exec.Cmd `json:"-"`
ID string `json:"id"`
Privileged bool `json:"privileged"`
User string `json:"user"`
Rootfs string `json:"rootfs"` // root fs of the container
InitPath string `json:"initpath"` // dockerinit
Entrypoint string `json:"entrypoint"`
Arguments []string `json:"arguments"`
WorkingDir string `json:"working_dir"`
ConfigPath string `json:"config_path"` // this should be able to be removed when the lxc template is moved into the driver
Tty bool `json:"tty"`
Network *Network `json:"network"`
Config map[string][]string `json:"config"` // generic values that specific drivers can consume
Resources *Resources `json:"resources"`
Mounts []Mount `json:"mounts"`
Terminal Terminal `json:"-"` // standard or tty terminal
Console string `json:"-"` // dev/console path
ContainerPid int `json:"container_pid"` // the pid for the process inside a container
}
Process wrapps an os/exec.Cmd to add more metadata
type Driver ¶
type Driver interface {
Run(c *Command, pipes *Pipes, startCallback StartCallback) (int, error) // Run executes the process and blocks until the process exits and returns the exit code
Kill(c *Command, sig int) error
Name() string // Driver name
Info(id string) Info // "temporary" hack (until we move state from core to plugins)
GetPidsForContainer(id string) ([]int, error) // Returns a list of pids for the given container.
Terminate(c *Command) error // kill it with fire
}
type Info ¶
type Info interface {
IsRunning() bool
}
Driver specific information based on processes registered with the driver
type InitArgs ¶
type InitArgs struct {
User string
Gateway string
Ip string
WorkDir string
Privileged bool
Env []string
Args []string
Mtu int
Driver string
Console string
Pipe int
Root string
}
Args provided to the init function for a driver
type InitFunc ¶
func GetInitFunc ¶
type Network ¶
type Network struct {
Interface *NetworkInterface `json:"interface"` // if interface is nil then networking is disabled
Mtu int `json:"mtu"`
}
Network settings of the container
type NetworkInterface ¶
type Pipes ¶
type Pipes struct {
Stdin io.ReadCloser
Stdout, Stderr io.Writer
}
Pipes is a wrapper around a containers output for stdin, stdout, stderr
type StartCallback ¶
type StartCallback func(*Command)
type StdConsole ¶
type StdConsole struct {
}
func NewStdConsole ¶
func NewStdConsole(command *Command, pipes *Pipes) (*StdConsole, error)
func (*StdConsole) AttachPipes ¶
func (s *StdConsole) AttachPipes(command *exec.Cmd, pipes *Pipes) error
func (*StdConsole) Close ¶
func (s *StdConsole) Close() error
func (*StdConsole) Resize ¶
func (s *StdConsole) Resize(h, w int) error
type Terminal ¶
Terminal in an interface for drivers to implement if they want to support Close and Resize calls from the core
type TtyConsole ¶
func NewTtyConsole ¶
func NewTtyConsole(command *Command, pipes *Pipes) (*TtyConsole, error)
func (*TtyConsole) AttachPipes ¶
func (t *TtyConsole) AttachPipes(command *exec.Cmd, pipes *Pipes) error
func (*TtyConsole) Close ¶
func (t *TtyConsole) Close() error
func (*TtyConsole) Master ¶
func (t *TtyConsole) Master() *os.File
func (*TtyConsole) Resize ¶
func (t *TtyConsole) Resize(h, w int) error
type TtyTerminal ¶
Directories
¶
| Path | Synopsis |
|---|---|
|
These types are wrappers around the libcontainer Terminal interface so that we can resuse the docker implementations where possible.
|
These types are wrappers around the libcontainer Terminal interface so that we can resuse the docker implementations where possible. |
Click to show internal directories.
Click to hide internal directories.