Documentation
¶
Index ¶
- Variables
- func TweakCapabilities(basics, adds, drops []string) ([]string, error)
- type Command
- type Context
- type Driver
- type ExitStatus
- type Info
- type Ipc
- type Mount
- type Network
- type NetworkInterface
- type Pid
- type Pipes
- type ProcessConfig
- type ResourceStats
- type Resources
- type StartCallback
- type StdConsole
- type Terminal
- type TtyTerminal
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrNotRunning = errors.New("Container is not running") 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 TweakCapabilities ¶ added in v1.2.0
Types ¶
type Command ¶
type Command struct {
ID string `json:"id"`
Rootfs string `json:"rootfs"` // root fs of the container
ReadonlyRootfs bool `json:"readonly_rootfs"`
InitPath string `json:"initpath"` // dockerinit
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
Network *Network `json:"network"`
Ipc *Ipc `json:"ipc"`
Pid *Pid `json:"pid"`
Resources *Resources `json:"resources"`
Mounts []Mount `json:"mounts"`
AllowedDevices []*devices.Device `json:"allowed_devices"`
AutoCreatedDevices []*devices.Device `json:"autocreated_devices"`
CapAdd []string `json:"cap_add"`
CapDrop []string `json:"cap_drop"`
ContainerPid int `json:"container_pid"` // the pid for the process inside a container
ProcessConfig ProcessConfig `json:"process_config"` // Describes the init process of the container.
ProcessLabel string `json:"process_label"`
MountLabel string `json:"mount_label"`
LxcConfig []string `json:"lxc_config"`
AppArmorProfile string `json:"apparmor_profile"`
}
Process wrapps an os/exec.Cmd to add more metadata
type Driver ¶
type Driver interface {
Run(c *Command, pipes *Pipes, startCallback StartCallback) (ExitStatus, error) // Run executes the process and blocks until the process exits and returns the exit code
// Exec executes the process in an existing container, blocks until the process exits and returns the exit code
Exec(c *Command, processConfig *ProcessConfig, pipes *Pipes, startCallback StartCallback) (int, error)
Kill(c *Command, sig int) error
Pause(c *Command) error
Unpause(c *Command) 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
Clean(id string) error // clean all traces of container exec
Stats(id string) (*ResourceStats, error) // Get resource stats for a running container
}
type ExitStatus ¶ added in v1.4.0
type ExitStatus struct {
// The exit code with which the container exited.
ExitCode int
// Whether the container encountered an OOM.
OOMKilled bool
}
ExitStatus provides exit reasons for a container.
type Info ¶
type Info interface {
IsRunning() bool
}
Driver specific information based on processes registered with the driver
type Ipc ¶ added in v1.4.0
type Ipc struct {
ContainerID string `json:"container_id"` // id of the container to join ipc.
HostIpc bool `json:"host_ipc"`
}
IPC settings of the container
type Network ¶
type Network struct {
Interface *NetworkInterface `json:"interface"` // if interface is nil then networking is disabled
Mtu int `json:"mtu"`
ContainerID string `json:"container_id"` // id of the container to join network.
HostNetworking bool `json:"host_networking"`
}
Network settings of the container
type NetworkInterface ¶
type NetworkInterface struct {
Gateway string `json:"gateway"`
IPAddress string `json:"ip"`
IPPrefixLen int `json:"ip_prefix_len"`
MacAddress string `json:"mac"`
Bridge string `json:"bridge"`
GlobalIPv6Address string `json:"global_ipv6"`
LinkLocalIPv6Address string `json:"link_local_ipv6"`
GlobalIPv6PrefixLen int `json:"global_ipv6_prefix_len"`
IPv6Gateway string `json:"ipv6_gateway"`
}
type Pid ¶ added in v1.5.0
type Pid struct {
HostPid bool `json:"host_pid"`
}
PID settings of the container
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 ProcessConfig ¶ added in v1.3.0
type ProcessConfig struct {
exec.Cmd `json:"-"`
Privileged bool `json:"privileged"`
User string `json:"user"`
Tty bool `json:"tty"`
Entrypoint string `json:"entrypoint"`
Arguments []string `json:"arguments"`
Terminal Terminal `json:"-"` // standard or tty terminal
Console string `json:"-"` // dev/console path
}
Describes a process that will be run inside a container.
type ResourceStats ¶ added in v1.5.0
type ResourceStats struct {
*libcontainer.ContainerStats
Read time.Time `json:"read"`
MemoryLimit int64 `json:"memory_limit"`
SystemUsage uint64 `json:"system_usage"`
}
type StartCallback ¶
type StartCallback func(*ProcessConfig, int)
type StdConsole ¶
type StdConsole struct {
}
func NewStdConsole ¶
func NewStdConsole(processConfig *ProcessConfig, 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 TtyTerminal ¶
Click to show internal directories.
Click to hide internal directories.