daemon

package
v1.7.0-rc3-ros-1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 15, 2015 License: Apache-2.0 Imports: 92 Imported by: 0

README

This directory contains code pertaining to running containers and storing images

Code pertaining to running containers:

  • execdriver
  • networkdriver

Code pertaining to storing images:

  • graphdriver

Documentation

Index

Constants

View Source
const DefaultPathEnv = "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"

Variables

View Source
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.")
)

Functions

func GetFullContainerName

func GetFullContainerName(name string) (string, error)

Types

type CommonConfig

type CommonConfig struct {
	AutoRestart    bool
	Context        map[string][]string
	CorsHeaders    string
	DisableNetwork bool
	Dns            []string
	DnsSearch      []string
	EnableCors     bool
	ExecDriver     string
	ExecOptions    []string
	ExecRoot       string
	GraphDriver    string
	GraphOptions   []string
	Labels         []string
	LogConfig      runconfig.LogConfig
	Mtu            int
	Pidfile        string
	Root           string
	TrustKeyPath   string
}

CommonConfig defines the configuration of a docker daemon which are common across platforms.

type CommonContainer

type CommonContainer struct {
	StreamConfig

	*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          *network.Settings
	ResolvConfPath           string
	HostnamePath             string
	HostsPath                string
	LogPath                  string
	Name                     string
	Driver                   string
	ExecDriver               string
	MountLabel, ProcessLabel string
	RestartCount             int
	UpdateDns                bool

	MountPoints map[string]*mountPoint
	Volumes     map[string]string // Deprecated since 1.7, kept for backwards compatibility
	VolumesRW   map[string]bool   // Deprecated since 1.7, kept for backwards compatibility
	// contains filtered or unexported fields
}

CommonContainer holds the settings for a container which are applicable across all platforms supported by the daemon.

type Config

type Config struct {
	CommonConfig

	// Bridge holds bridge network specific configuration.
	Bridge               bridgeConfig
	EnableSelinuxSupport bool
	SocketGroup          string
	Ulimits              map[string]*ulimit.Ulimit
}

Config defines 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`

func (*Config) InstallCommonFlags

func (config *Config) InstallCommonFlags()

InstallCommonFlags 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.

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 {
	CommonContainer

	AppArmorProfile string
	// contains filtered or unexported fields
}

func (*Container) AllocateNetwork

func (container *Container) AllocateNetwork() error

func (*Container) Attach

func (c *Container) Attach(stdin io.ReadCloser, stdout io.Writer, stderr io.Writer) chan error

func (*Container) AttachWithLogs

func (c *Container) AttachWithLogs(stdin io.ReadCloser, stdout, stderr io.Writer, logs, stream bool) error

func (*Container) Changes

func (container *Container) Changes() ([]archive.Change, error)

func (*Container) Copy

func (container *Container) Copy(resource string) (io.ReadCloser, error)
func (container *Container) DisableLink(name string)

func (*Container) Exec

func (container *Container) Exec(execConfig *execConfig) error

func (*Container) Export

func (container *Container) Export() (archive.Archive, error)

func (*Container) ExportRw

func (container *Container) ExportRw() (archive.Archive, error)

func (*Container) Exposes

func (container *Container) Exposes(p nat.Port) bool

Returns true if the container exposes a certain port

func (*Container) FromDisk

func (container *Container) FromDisk() error

func (*Container) GetExecIDs

func (container *Container) GetExecIDs() []string

func (*Container) GetImage

func (container *Container) GetImage() (*image.Image, error)

func (*Container) GetMountLabel

func (container *Container) GetMountLabel() string

func (*Container) GetProcessLabel

func (container *Container) GetProcessLabel() string

func (*Container) GetResourcePath

func (container *Container) GetResourcePath(path string) (string, error)

Evaluates `path` in the scope of the container's basefs, with proper path sanitisation. Symlinks are all scoped to the basefs of the container, as though the container's basefs was `/`.

The basefs of a container is the host-facing path which is bind-mounted as `/` inside the container. This method is essentially used to access a particular path inside the container as though you were a process in that container.

NOTE: The returned path is *only* safely scoped inside the container's basefs

if no component of the returned path changes (such as a component
symlinking to a different path) between using this method and using the
path. See symlink.FollowSymlinkInScope for more details.

func (*Container) GetRootResourcePath

func (container *Container) GetRootResourcePath(path string) (string, error)

Evaluates `path` in the scope of the container's root, with proper path sanitisation. Symlinks are all scoped to the root of the container, as though the container's root was `/`.

The root of a container is the host-facing configuration metadata directory. Only use this method to safely access the container's `container.json` or other metadata files. If in doubt, use container.GetResourcePath.

NOTE: The returned path is *only* safely scoped inside the container's root

if no component of the returned path changes (such as a component
symlinking to a different path) between using this method and using the
path. See symlink.FollowSymlinkInScope for more details.

func (*Container) GetSize

func (container *Container) GetSize() (int64, int64)

GetSize, return real size, virtual size

func (*Container) HostConfig

func (container *Container) HostConfig() *runconfig.HostConfig

func (*Container) Kill

func (container *Container) Kill() error

func (*Container) KillSig

func (container *Container) KillSig(sig int) error

func (*Container) LogDriverType

func (c *Container) LogDriverType() string

func (*Container) LogEvent

func (container *Container) LogEvent(action string)

func (*Container) Mount

func (container *Container) Mount() error

func (*Container) Output

func (container *Container) Output() (output []byte, err error)

func (*Container) Pause

func (container *Container) Pause() error

func (*Container) ReleaseNetwork

func (container *Container) ReleaseNetwork()

func (*Container) Resize

func (container *Container) Resize(h, w int) error

func (*Container) Restart

func (container *Container) Restart(seconds int) error

func (*Container) RootfsPath

func (container *Container) RootfsPath() string

This method must be exported to be used from the lxc template This directory is only usable when the container is running

func (*Container) Run

func (container *Container) Run() error

func (*Container) SetHostConfig

func (container *Container) SetHostConfig(hostConfig *runconfig.HostConfig)

func (*Container) Start

func (container *Container) Start() (err error)

func (*Container) Stats

func (container *Container) Stats() (*execdriver.ResourceStats, error)

func (*Container) Stop

func (container *Container) Stop(seconds int) error

func (*Container) ToDisk

func (container *Container) ToDisk() error

func (*Container) Unmount

func (container *Container) Unmount() error

func (*Container) UnmountVolumes

func (container *Container) UnmountVolumes(forceSyscall bool) error

func (*Container) Unpause

func (container *Container) Unpause() error

func (*Container) UpdateNetwork

func (container *Container) UpdateNetwork() error

func (*Container) WriteHostConfig

func (container *Container) WriteHostConfig() error

type ContainerAttachWithLogsConfig

type ContainerAttachWithLogsConfig struct {
	InStream                       io.ReadCloser
	OutStream                      io.Writer
	UseStdin, UseStdout, UseStderr bool
	Logs, Stream                   bool
	Multiplex                      bool
}

type ContainerCommitConfig

type ContainerCommitConfig struct {
	Pause   bool
	Repo    string
	Tag     string
	Author  string
	Comment string
	Changes []string
	Config  *runconfig.Config
}

type ContainerJSONRaw

type ContainerJSONRaw struct {
	*Container
	HostConfig *runconfig.HostConfig

	// Unused fields for backward compatibility with API versions < 1.12.
	Volumes   map[string]string
	VolumesRW map[string]bool
}

type ContainerLogsConfig

type ContainerLogsConfig struct {
	Follow, Timestamps   bool
	Tail                 string
	Since                time.Time
	UseStdout, UseStderr bool
	OutStream            io.Writer
}

type ContainerRmConfig

type ContainerRmConfig struct {
	ForceRemove, RemoveVolume, RemoveLink bool
}

type ContainerWsAttachWithLogsConfig

type ContainerWsAttachWithLogsConfig struct {
	InStream             io.ReadCloser
	OutStream, ErrStream io.Writer
	Logs, Stream         bool
}

type ContainersConfig

type ContainersConfig struct {
	All     bool
	Since   string
	Before  string
	Limit   int
	Size    bool
	Filters string
}

type Daemon

type Daemon struct {
	ID string

	RegistryService *registry.Service
	EventsService   *events.Events
	// contains filtered or unexported fields
}

func NewDaemon

func NewDaemon(config *Config, registryService *registry.Service) (daemon *Daemon, err error)

func (*Daemon) Changes

func (daemon *Daemon) Changes(container *Container) ([]archive.Change, error)

func (*Daemon) Children

func (daemon *Daemon) Children(name string) (map[string]*Container, 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) Config

func (daemon *Daemon) Config() *Config

func (*Daemon) ContainerAttachWithLogs

func (daemon *Daemon) ContainerAttachWithLogs(name string, c *ContainerAttachWithLogsConfig) error

func (*Daemon) ContainerChanges

func (daemon *Daemon) ContainerChanges(name string) ([]archive.Change, error)

ContainerChanges returns a list of container fs changes

func (*Daemon) ContainerCopy

func (daemon *Daemon) ContainerCopy(name string, res string) (io.ReadCloser, error)

func (*Daemon) ContainerCreate

func (daemon *Daemon) ContainerCreate(name string, config *runconfig.Config, hostConfig *runconfig.HostConfig) (string, []string, error)

func (*Daemon) ContainerExecCreate

func (d *Daemon) ContainerExecCreate(config *runconfig.ExecConfig) (string, error)

func (*Daemon) ContainerExecInspect

func (daemon *Daemon) ContainerExecInspect(id string) (*execConfig, error)

func (*Daemon) ContainerExecResize

func (daemon *Daemon) ContainerExecResize(name string, height, width int) error

func (*Daemon) ContainerExecStart

func (d *Daemon) ContainerExecStart(execName string, stdin io.ReadCloser, stdout io.Writer, stderr io.Writer) error

func (*Daemon) ContainerExport

func (daemon *Daemon) ContainerExport(name string, out io.Writer) error

func (*Daemon) ContainerGraph

func (daemon *Daemon) ContainerGraph() *graphdb.Database

func (*Daemon) ContainerInspect

func (daemon *Daemon) ContainerInspect(name string) (*types.ContainerJSON, error)

func (*Daemon) ContainerInspectRaw

func (daemon *Daemon) ContainerInspectRaw(name string) (*types.ContainerJSONRaw, error)

func (*Daemon) ContainerKill

func (daemon *Daemon) ContainerKill(name string, sig uint64) error

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

func (daemon *Daemon) ContainerLogs(name string, config *ContainerLogsConfig) error

func (*Daemon) ContainerPause

func (daemon *Daemon) ContainerPause(name string) error

ContainerPause pauses a container

func (*Daemon) ContainerRename

func (daemon *Daemon) ContainerRename(oldName, newName string) error

func (*Daemon) ContainerResize

func (daemon *Daemon) ContainerResize(name string, height, width int) error

func (*Daemon) ContainerRestart

func (daemon *Daemon) ContainerRestart(name string, seconds int) error

func (*Daemon) ContainerRm

func (daemon *Daemon) ContainerRm(name string, config *ContainerRmConfig) error

func (*Daemon) ContainerStart

func (daemon *Daemon) ContainerStart(name string, hostConfig *runconfig.HostConfig) error

func (*Daemon) ContainerStats

func (daemon *Daemon) ContainerStats(name string, stream bool, out io.Writer) error

func (*Daemon) ContainerStop

func (daemon *Daemon) ContainerStop(name string, seconds int) error

func (*Daemon) ContainerTop

func (daemon *Daemon) ContainerTop(name string, psArgs string) (*types.ContainerProcessList, error)

func (*Daemon) ContainerUnpause

func (daemon *Daemon) ContainerUnpause(name string) error

ContainerUnpause unpauses a container

func (*Daemon) ContainerWait

func (daemon *Daemon) ContainerWait(name string, timeout time.Duration) (int, error)

func (*Daemon) ContainerWsAttachWithLogs

func (daemon *Daemon) ContainerWsAttachWithLogs(name string, c *ContainerWsAttachWithLogsConfig) error

func (*Daemon) Containers

func (daemon *Daemon) Containers(config *ContainersConfig) ([]*types.Container, error)

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) DeleteVolumes

func (daemon *Daemon) DeleteVolumes(c *Container) error

func (*Daemon) Diff

func (daemon *Daemon) Diff(container *Container) (archive.Archive, error)

func (*Daemon) Exec

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

func (daemon *Daemon) Exists(id string) bool

Exists returns a true if a container of the specified ID or name exists, false otherwise.

func (*Daemon) GenerateSecurityOpt

func (daemon *Daemon) GenerateSecurityOpt(ipcMode runconfig.IpcMode, pidMode runconfig.PidMode) ([]string, error)

func (*Daemon) Get

func (daemon *Daemon) Get(prefixOrName string) (*Container, error)

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) GetByName

func (daemon *Daemon) GetByName(name string) (*Container, error)

func (*Daemon) Graph

func (daemon *Daemon) Graph() *graph.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

func (daemon *Daemon) ImageDelete(name string, force, noprune bool) ([]types.ImageDelete, error)

FIXME: remove ImageDelete's dependency on Daemon, then move to graph/

func (*Daemon) ImageGetCached

func (daemon *Daemon) ImageGetCached(imgID string, config *runconfig.Config) (*image.Image, error)

func (*Daemon) Kill

func (daemon *Daemon) Kill(c *Container, sig int) error

func (*Daemon) List

func (daemon *Daemon) List() []*Container

List returns an array of all containers registered in the daemon.

func (*Daemon) Mount

func (daemon *Daemon) Mount(container *Container) error

func (*Daemon) Parents

func (daemon *Daemon) Parents(name string) ([]string, error)

func (*Daemon) Register

func (daemon *Daemon) Register(container *Container) error

Register makes a container object usable by the daemon as <container.ID> This is a wrapper for register

func (daemon *Daemon) RegisterLink(parent, child *Container, alias string) error
func (daemon *Daemon) RegisterLinks(container *Container, hostConfig *runconfig.HostConfig) error

func (*Daemon) Repositories

func (daemon *Daemon) Repositories() *graph.TagStore

func (*Daemon) Run

func (daemon *Daemon) Run(c *Container, pipes *execdriver.Pipes, startCallback execdriver.StartCallback) (execdriver.ExitStatus, error)

func (*Daemon) Shutdown

func (daemon *Daemon) Shutdown() error

func (*Daemon) Stats

func (daemon *Daemon) Stats(c *Container) (*execdriver.ResourceStats, error)

func (*Daemon) SubscribeToContainerStats

func (daemon *Daemon) SubscribeToContainerStats(name string) (chan interface{}, error)

func (*Daemon) SystemConfig

func (daemon *Daemon) SystemConfig() *sysinfo.SysInfo

func (*Daemon) SystemInfo

func (daemon *Daemon) SystemInfo() (*types.Info, error)

func (*Daemon) SystemInitPath

func (daemon *Daemon) SystemInitPath() string

func (*Daemon) Unmount

func (daemon *Daemon) Unmount(container *Container) error

func (*Daemon) UnsubscribeToContainerStats

func (daemon *Daemon) UnsubscribeToContainerStats(name string, ch chan interface{}) error

type History

type History []*Container

History is a convenience type for storing a list of containers, ordered by creation date.

func (*History) Add

func (history *History) Add(container *Container)

func (*History) Len

func (history *History) Len() int

func (*History) Less

func (history *History) Less(i, j int) bool

func (*History) Sort

func (history *History) Sort()

func (*History) Swap

func (history *History) Swap(i, j int)

type State

type State struct {
	sync.Mutex
	Running    bool
	Paused     bool
	Restarting bool
	OOMKilled  bool

	Dead       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 NewState

func NewState() *State

func (*State) GetExitCode

func (s *State) GetExitCode() int

func (*State) GetPid

func (s *State) GetPid() int

func (*State) IsPaused

func (s *State) IsPaused() bool

func (*State) IsRestarting

func (s *State) IsRestarting() bool

func (*State) IsRunning

func (s *State) IsRunning() bool

func (*State) ResetRemovalInProgress

func (s *State) ResetRemovalInProgress()

func (*State) SetDead

func (s *State) SetDead()

func (*State) SetPaused

func (s *State) SetPaused()

func (*State) SetRemovalInProgress

func (s *State) SetRemovalInProgress() error

func (*State) SetRestarting

func (s *State) SetRestarting(exitStatus *execdriver.ExitStatus)

SetRestarting is when docker handles the auto restart of containers when they are in the middle of a stop and being restarted again

func (*State) SetRunning

func (s *State) SetRunning(pid int)

func (*State) SetStopped

func (s *State) SetStopped(exitStatus *execdriver.ExitStatus)

func (*State) SetUnpaused

func (s *State) SetUnpaused()

func (*State) StateString

func (s *State) StateString() string

StateString returns a single string to describe state

func (*State) String

func (s *State) String() string

String returns a human-readable description of the state

func (*State) WaitRunning

func (s *State) WaitRunning(timeout time.Duration) (int, error)

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

func (*State) WaitStop

func (s *State) WaitStop(timeout time.Duration) (int, error)

WaitStop waits until state is stopped. If state already stopped it returns immediately. If you want wait forever you must supply negative timeout. Returns exit code, that was passed to SetStopped

type StreamConfig

type StreamConfig struct {
	// contains filtered or unexported fields
}

func (*StreamConfig) StderrLogPipe

func (streamConfig *StreamConfig) StderrLogPipe() io.ReadCloser

func (*StreamConfig) StderrPipe

func (streamConfig *StreamConfig) StderrPipe() io.ReadCloser

func (*StreamConfig) StdinPipe

func (streamConfig *StreamConfig) StdinPipe() io.WriteCloser

func (*StreamConfig) StdoutLogPipe

func (streamConfig *StreamConfig) StdoutLogPipe() io.ReadCloser

func (*StreamConfig) StdoutPipe

func (streamConfig *StreamConfig) StdoutPipe() io.ReadCloser

Jump to

Keyboard shortcuts

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