Documentation ¶
Overview ¶
Package daemon exposes the functions that occur on the host server that the Docker daemon is running.
In implementing the various functions of the daemon, there is often a method-specific struct for configuring the runtime behavior.
Index ¶
- Constants
- Variables
- func ReloadConfiguration(configFile string, flags *flag.FlagSet, reload func(*Config))
- type CommonConfig
- type CommonTLSOptions
- type Config
- type ContainerAttachWithLogsConfig
- type ContainerLogsConfig
- type ContainerStatsConfig
- type ContainerWsAttachWithLogsConfig
- type ContainersConfig
- type Daemon
- func (daemon *Daemon) AuthenticateToRegistry(authConfig *types.AuthConfig) (string, error)
- func (daemon *Daemon) Cleanup(container *container.Container)
- func (daemon *Daemon) Commit(name string, c *types.ContainerCommitConfig) (string, error)
- func (daemon *Daemon) ConnectContainerToNetwork(containerName, networkName string, endpointConfig *network.EndpointSettings) error
- func (daemon *Daemon) ConnectToNetwork(container *container.Container, idOrName string, ...) error
- func (daemon *Daemon) ContainerArchivePath(name string, path string) (content io.ReadCloser, stat *types.ContainerPathStat, err error)
- func (daemon *Daemon) ContainerAttachWithLogs(prefixOrName string, c *ContainerAttachWithLogsConfig) error
- func (daemon *Daemon) ContainerChanges(name string) ([]archive.Change, error)
- func (daemon *Daemon) ContainerCopy(name string, res string) (io.ReadCloser, error)
- func (daemon *Daemon) ContainerCreate(params types.ContainerCreateConfig) (types.ContainerCreateResponse, error)
- func (d *Daemon) ContainerExecCreate(config *types.ExecConfig) (string, error)
- func (daemon *Daemon) ContainerExecInspect(id string) (*exec.Config, error)
- func (daemon *Daemon) ContainerExecResize(name string, height, width int) error
- func (d *Daemon) ContainerExecStart(name string, stdin io.ReadCloser, stdout io.Writer, stderr io.Writer) error
- func (daemon *Daemon) ContainerExport(name string, out io.Writer) error
- func (daemon *Daemon) ContainerExtractToDir(name, path string, noOverwriteDirNonDir bool, content io.Reader) error
- func (daemon *Daemon) ContainerInspect(name string, size bool, version version.Version) (interface{}, error)
- func (daemon *Daemon) ContainerKill(name string, sig uint64) error
- func (daemon *Daemon) ContainerLogs(containerName string, config *ContainerLogsConfig) error
- func (daemon *Daemon) ContainerPause(name string) error
- func (daemon *Daemon) ContainerRename(oldName, newName string) error
- func (daemon *Daemon) ContainerResize(name string, height, width int) error
- func (daemon *Daemon) ContainerRestart(name string, seconds int) error
- func (daemon *Daemon) ContainerRm(name string, config *types.ContainerRmConfig) error
- func (daemon *Daemon) ContainerStart(name string, hostConfig *containertypes.HostConfig) error
- func (daemon *Daemon) ContainerStatPath(name string, path string) (stat *types.ContainerPathStat, err error)
- func (daemon *Daemon) ContainerStats(prefixOrName string, config *ContainerStatsConfig) error
- func (daemon *Daemon) ContainerStop(name string, seconds int) error
- func (daemon *Daemon) ContainerTop(name string, psArgs string) (*types.ContainerProcessList, error)
- func (daemon *Daemon) ContainerUnpause(name string) error
- func (daemon *Daemon) ContainerUpdate(name string, hostConfig *container.HostConfig) ([]string, error)
- func (daemon *Daemon) ContainerWait(name string, timeout time.Duration) (int, error)
- func (daemon *Daemon) ContainerWsAttachWithLogs(prefixOrName string, c *ContainerWsAttachWithLogsConfig) error
- func (daemon *Daemon) Containers(config *ContainersConfig) ([]*types.Container, error)
- func (daemon *Daemon) CreateNetwork(name, driver string, ipam network.IPAM, options map[string]string, ...) (libnetwork.Network, error)
- func (daemon *Daemon) DeleteNetwork(networkID string) error
- func (daemon *Daemon) DisconnectContainerFromNetwork(containerName string, network libnetwork.Network, force bool) error
- func (daemon *Daemon) DisconnectFromNetwork(container *container.Container, n libnetwork.Network, force bool) error
- func (d *Daemon) Exec(c *container.Container, execConfig *exec.Config, pipes *execdriver.Pipes, ...) (int, error)
- func (d *Daemon) ExecExists(name string) (bool, error)
- func (daemon *Daemon) ExecutionDriver() execdriver.Driver
- func (daemon *Daemon) Exists(id string) bool
- func (daemon *Daemon) ExportImage(names []string, outStream io.Writer) error
- func (daemon *Daemon) FindNetwork(idName string) (libnetwork.Network, error)
- func (daemon *Daemon) ForceEndpointDelete(name string, n libnetwork.Network) error
- func (daemon *Daemon) GetAllNetworks() []libnetwork.Network
- func (daemon *Daemon) GetByName(name string) (*container.Container, error)
- func (daemon *Daemon) GetContainer(prefixOrName string) (*container.Container, error)
- func (daemon *Daemon) GetContainerStats(container *container.Container) (*execdriver.ResourceStats, error)
- func (daemon *Daemon) GetImage(refOrID string) (*image.Image, error)
- func (daemon *Daemon) GetImageID(refOrID string) (image.ID, error)
- func (daemon *Daemon) GetLabels(id string) map[string]string
- func (daemon *Daemon) GetNetwork(idName string, by int) (libnetwork.Network, error)
- func (daemon *Daemon) GetNetworkDriverList() map[string]bool
- func (daemon *Daemon) GetNetworksByID(partialID string) []libnetwork.Network
- func (daemon *Daemon) GetRemappedUIDGID() (int, int)
- func (daemon *Daemon) GetUIDGIDMaps() ([]idtools.IDMap, []idtools.IDMap)
- func (daemon *Daemon) GraphDriverName() string
- func (daemon *Daemon) ImageDelete(imageRef string, force, prune bool) ([]types.ImageDelete, error)
- func (daemon *Daemon) ImageGetCached(imgID image.ID, config *containertypes.Config) (*image.Image, error)
- func (daemon *Daemon) ImageHistory(name string) ([]*types.ImageHistory, error)
- func (daemon *Daemon) Images(filterArgs, filter string, all bool) ([]*types.Image, error)
- func (daemon *Daemon) ImportImage(src string, newRef reference.Named, msg string, inConfig io.ReadCloser, ...) error
- func (daemon *Daemon) IsPaused(id string) bool
- func (daemon *Daemon) IsShuttingDown() bool
- func (daemon *Daemon) Kill(container *container.Container) error
- func (daemon *Daemon) List() []*container.Container
- func (daemon *Daemon) LoadImage(inTar io.ReadCloser, outStream io.Writer) error
- func (daemon *Daemon) LogContainerEvent(container *container.Container, action string)
- func (daemon *Daemon) LogImageEvent(imageID, refName, action string)
- func (daemon *Daemon) LogNetworkEvent(nw libnetwork.Network, action string)
- func (daemon *Daemon) LogNetworkEventWithAttributes(nw libnetwork.Network, action string, attributes map[string]string)
- func (daemon *Daemon) LogVolumeEvent(volumeID, action string, attributes map[string]string)
- func (daemon *Daemon) LookupImage(name string) (*types.ImageInspect, error)
- func (daemon *Daemon) Map() map[image.ID]*image.Image
- func (daemon *Daemon) Mount(container *container.Container) error
- func (daemon *Daemon) NetworkControllerEnabled() bool
- func (daemon *Daemon) PullImage(ref reference.Named, metaHeaders map[string][]string, ...) error
- func (daemon *Daemon) PushImage(ref reference.Named, metaHeaders map[string][]string, ...) error
- func (daemon *Daemon) Register(container *container.Container) error
- func (daemon *Daemon) Reload(config *Config) error
- func (daemon *Daemon) Run(c *container.Container, pipes *execdriver.Pipes, ...) (execdriver.ExitStatus, error)
- func (daemon *Daemon) SearchRegistryForImages(term string, authConfig *types.AuthConfig, headers map[string][]string) (*registrytypes.SearchResults, error)
- func (daemon *Daemon) Shutdown() error
- func (daemon *Daemon) Start(container *container.Container) error
- func (daemon *Daemon) StartLogging(container *container.Container) error
- func (daemon *Daemon) SubscribeToEvents(since, sinceNano int64, filter filters.Args) ([]eventtypes.Message, chan interface{})
- func (daemon *Daemon) SystemInfo() (*types.Info, error)
- func (daemon *Daemon) SystemVersion() types.Version
- func (daemon *Daemon) TagImage(newTag reference.Named, imageName string) error
- func (daemon *Daemon) Unmount(container *container.Container)
- func (daemon *Daemon) UnsubscribeFromEvents(listener chan interface{})
- func (daemon *Daemon) VolumeCreate(name, driverName string, opts map[string]string) (*types.Volume, error)
- func (daemon *Daemon) VolumeInspect(name string) (*types.Volume, error)
- func (daemon *Daemon) VolumeRm(name string) error
- func (daemon *Daemon) Volumes(filter string) ([]*types.Volume, []string, error)
- type ErrImageDoesNotExist
- type History
- type LogConfig
Constants ¶
const ( // NetworkByID represents a constant to find a network by its ID NetworkByID = iota + 1 // NetworkByName represents a constant to find a network by its Name NetworkByName )
Variables ¶
var ErrExtractPointNotDirectory = errors.New("extraction point is not a directory")
ErrExtractPointNotDirectory is used to convey that the operation to extract a tar archive to a directory in a container has failed because the specified path does not refer to a directory.
var ( // ErrRootFSReadOnly is returned when a container // rootfs is marked readonly. ErrRootFSReadOnly = errors.New("container rootfs is marked read-only") )
var ( // ErrVolumeReadonly is used to signal an error when trying to copy data into // a volume mount that is not writable. ErrVolumeReadonly = errors.New("mounted volume is marked read-only") )
Functions ¶
Types ¶
type CommonConfig ¶
type CommonConfig struct { AuthorizationPlugins []string `json:"authorization-plugins,omitempty"` // AuthorizationPlugins holds list of authorization plugins AutoRestart bool `json:"-"` Bridge bridgeConfig `json:"-"` // Bridge holds bridge network specific configuration. Context map[string][]string `json:"-"` DisableBridge bool `json:"-"` DNS []string `json:"dns,omitempty"` DNSOptions []string `json:"dns-opts,omitempty"` DNSSearch []string `json:"dns-search,omitempty"` ExecOptions []string `json:"exec-opts,omitempty"` ExecRoot string `json:"exec-root,omitempty"` GraphDriver string `json:"storage-driver,omitempty"` GraphOptions []string `json:"storage-opts,omitempty"` Labels []string `json:"labels,omitempty"` LogConfig LogConfig `json:"log-config,omitempty"` Mtu int `json:"mtu,omitempty"` Pidfile string `json:"pidfile,omitempty"` Root string `json:"graph,omitempty"` TrustKeyPath string `json:"-"` // ClusterStore is the storage backend used for the cluster information. It is used by both // multihost networking (to store networks and endpoints information) and by the node discovery // mechanism. ClusterStore string `json:"cluster-store,omitempty"` // ClusterOpts is used to pass options to the discovery package for tuning libkv settings, such // as TLS configuration settings. ClusterOpts map[string]string `json:"cluster-store-opts,omitempty"` // ClusterAdvertise is the network endpoint that the Engine advertises for the purpose of node // discovery. This should be a 'host:port' combination on which that daemon instance is // reachable by other hosts. ClusterAdvertise string `json:"cluster-advertise,omitempty"` Debug bool `json:"debug,omitempty"` Hosts []string `json:"hosts,omitempty"` LogLevel string `json:"log-level,omitempty"` TLS bool `json:"tls,omitempty"` TLSVerify bool `json:"tls-verify,omitempty"` TLSOptions CommonTLSOptions `json:"tls-opts,omitempty"` // contains filtered or unexported fields }
CommonConfig defines the configuration of a docker daemon which are common across platforms. It includes json tags to deserialize configuration from a file using the same names that the flags in the command line uses.
type CommonTLSOptions ¶
type CommonTLSOptions struct { CAFile string `json:"tlscacert,omitempty"` CertFile string `json:"tlscert,omitempty"` KeyFile string `json:"tlskey,omitempty"` }
CommonTLSOptions defines TLS configuration for the daemon server. It includes json tags to deserialize configuration from a file using the same names that the flags in the command line uses.
type Config ¶
type Config struct { CommonConfig CorsHeaders string `json:"api-cors-headers,omitempty"` EnableCors bool `json:"api-enable-cors,omitempty"` EnableSelinuxSupport bool `json:"selinux-enabled,omitempty"` RemappedRoot string `json:"userns-remap,omitempty"` SocketGroup string `json:"group,omitempty"` CgroupParent string `json:"cgroup-parent,omitempty"` Ulimits map[string]*units.Ulimit `json:"default-ulimits,omitempty"` }
Config defines the configuration of a docker daemon. It includes json tags to deserialize configuration from a file using the same names that the flags in the command line uses.
func MergeDaemonConfigurations ¶
func MergeDaemonConfigurations(flagsConfig *Config, flags *flag.FlagSet, configFile string) (*Config, error)
MergeDaemonConfigurations reads a configuration file, loads the file configuration in an isolated structure, and merges the configuration provided from flags on top if there are no conflicts.
func (*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 ¶
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 ContainerAttachWithLogsConfig ¶
type ContainerAttachWithLogsConfig struct { Hijacker http.Hijacker Upgrade bool UseStdin bool UseStdout bool UseStderr bool Logs bool Stream bool DetachKeys []byte }
ContainerAttachWithLogsConfig holds the streams to use when connecting to a container to view logs.
type ContainerLogsConfig ¶
type ContainerLogsConfig struct { // if true stream log output Follow bool // if true include timestamps for each line of log output Timestamps bool // return that many lines of log output from the end Tail string // filter logs by returning on those entries after this time Since time.Time // whether or not to show stdout and stderr as well as log entries. UseStdout, UseStderr bool OutStream io.Writer Stop <-chan bool }
ContainerLogsConfig holds configs for logging operations. Exists for users of the daemon to to pass it a logging configuration.
type ContainerStatsConfig ¶
type ContainerStatsConfig struct { Stream bool OutStream io.Writer Stop <-chan bool Version version.Version }
ContainerStatsConfig holds information for configuring the runtime behavior of a daemon.ContainerStats() call.
type ContainerWsAttachWithLogsConfig ¶
type ContainerWsAttachWithLogsConfig struct { InStream io.ReadCloser OutStream, ErrStream io.Writer Logs, Stream bool DetachKeys []byte }
ContainerWsAttachWithLogsConfig attach with websockets, since all stream data is delegated to the websocket to handle there.
type ContainersConfig ¶
type ContainersConfig struct { // if true show all containers, otherwise only running containers. All bool // show all containers created after this container id Since string // show all containers created before this container id Before string // number of containers to return at most Limit int // if true include the sizes of the containers Size bool // return only containers that match filters Filters string }
ContainersConfig is the filtering specified by the user to iterate over containers.
type Daemon ¶
type Daemon struct { ID string RegistryService *registry.Service EventsService *events.Events // contains filtered or unexported fields }
Daemon holds information about the Docker daemon.
func NewDaemon ¶
NewDaemon sets up everything for the daemon to be able to service requests from the webserver.
func (*Daemon) AuthenticateToRegistry ¶
func (daemon *Daemon) AuthenticateToRegistry(authConfig *types.AuthConfig) (string, error)
AuthenticateToRegistry checks the validity of credentials in authConfig
func (*Daemon) Cleanup ¶
Cleanup releases any network resources allocated to the container along with any rules around how containers are linked together. It also unmounts the container's root filesystem.
func (*Daemon) Commit ¶
Commit creates a new filesystem image from the current state of a container. The image can optionally be tagged into a repository.
func (*Daemon) ConnectContainerToNetwork ¶
func (daemon *Daemon) ConnectContainerToNetwork(containerName, networkName string, endpointConfig *network.EndpointSettings) error
ConnectContainerToNetwork connects the given container to the given network. If either cannot be found, an err is returned. If the network cannot be set up, an err is returned.
func (*Daemon) ConnectToNetwork ¶
func (daemon *Daemon) ConnectToNetwork(container *container.Container, idOrName string, endpointConfig *networktypes.EndpointSettings) error
ConnectToNetwork connects a container to a network
func (*Daemon) ContainerArchivePath ¶
func (daemon *Daemon) ContainerArchivePath(name string, path string) (content io.ReadCloser, stat *types.ContainerPathStat, err error)
ContainerArchivePath creates an archive of the filesystem resource at the specified path in the container identified by the given name. Returns a tar archive of the resource and whether it was a directory or a single file.
func (*Daemon) ContainerAttachWithLogs ¶
func (daemon *Daemon) ContainerAttachWithLogs(prefixOrName string, c *ContainerAttachWithLogsConfig) error
ContainerAttachWithLogs attaches to logs according to the config passed in. See ContainerAttachWithLogsConfig.
func (*Daemon) ContainerChanges ¶
ContainerChanges returns a list of container fs changes
func (*Daemon) ContainerCopy ¶
ContainerCopy performs a deprecated operation of archiving the resource at the specified path in the container identified by the given name.
func (*Daemon) ContainerCreate ¶
func (daemon *Daemon) ContainerCreate(params types.ContainerCreateConfig) (types.ContainerCreateResponse, error)
ContainerCreate creates a container.
func (*Daemon) ContainerExecCreate ¶
func (d *Daemon) ContainerExecCreate(config *types.ExecConfig) (string, error)
ContainerExecCreate sets up an exec in a running container.
func (*Daemon) ContainerExecInspect ¶
ContainerExecInspect returns low-level information about the exec command. An error is returned if the exec cannot be found.
func (*Daemon) ContainerExecResize ¶
ContainerExecResize changes the size of the TTY of the process running in the exec with the given name to the given height and width.
func (*Daemon) ContainerExecStart ¶
func (d *Daemon) ContainerExecStart(name string, stdin io.ReadCloser, stdout io.Writer, stderr io.Writer) error
ContainerExecStart starts a previously set up exec instance. The std streams are set up.
func (*Daemon) ContainerExport ¶
ContainerExport writes the contents of the container to the given writer. An error is returned if the container cannot be found.
func (*Daemon) ContainerExtractToDir ¶
func (daemon *Daemon) ContainerExtractToDir(name, path string, noOverwriteDirNonDir bool, content io.Reader) error
ContainerExtractToDir extracts the given archive to the specified location in the filesystem of the container identified by the given name. The given path must be of a directory in the container. If it is not, the error will be ErrExtractPointNotDirectory. If noOverwriteDirNonDir is true then it will be an error if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa.
func (*Daemon) ContainerInspect ¶
func (daemon *Daemon) ContainerInspect(name string, size bool, version version.Version) (interface{}, error)
ContainerInspect returns low-level information about a container. Returns an error if the container cannot be found, or if there is an error getting the data.
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) ContainerLogs ¶
func (daemon *Daemon) ContainerLogs(containerName string, config *ContainerLogsConfig) error
ContainerLogs hooks up a container's stdout and stderr streams configured with the given struct.
func (*Daemon) ContainerPause ¶
ContainerPause pauses a container
func (*Daemon) ContainerRename ¶
ContainerRename changes the name of a container, using the oldName to find the container. An error is returned if newName is already reserved.
func (*Daemon) ContainerResize ¶
ContainerResize changes the size of the TTY of the process running in the container with the given name to the given height and width.
func (*Daemon) ContainerRestart ¶
ContainerRestart stops and starts a container. It attempts to gracefully stop the container within the given timeout, forcefully stopping it if the timeout is exceeded. If given a negative timeout, ContainerRestart will wait forever until a graceful stop. Returns an error if the container cannot be found, or if there is an underlying error at any stage of the restart.
func (*Daemon) ContainerRm ¶
func (daemon *Daemon) ContainerRm(name string, config *types.ContainerRmConfig) error
ContainerRm removes the container id from the filesystem. An error is returned if the container is not found, or if the remove fails. If the remove succeeds, the container name is released, and network links are removed.
func (*Daemon) ContainerStart ¶
func (daemon *Daemon) ContainerStart(name string, hostConfig *containertypes.HostConfig) error
ContainerStart starts a container.
func (*Daemon) ContainerStatPath ¶
func (daemon *Daemon) ContainerStatPath(name string, path string) (stat *types.ContainerPathStat, err error)
ContainerStatPath stats the filesystem resource at the specified path in the container identified by the given name.
func (*Daemon) ContainerStats ¶
func (daemon *Daemon) ContainerStats(prefixOrName string, config *ContainerStatsConfig) error
ContainerStats writes information about the container to the stream given in the config object.
func (*Daemon) ContainerStop ¶
ContainerStop looks for the given container and terminates it, waiting the given number of seconds before forcefully killing the container. If a negative number of seconds is given, ContainerStop will wait for a graceful termination. An error is returned if the container is not found, is already stopped, or if there is a problem stopping the container.
func (*Daemon) ContainerTop ¶
ContainerTop lists the processes running inside of the given container by calling ps with the given args, or with the flags "-ef" if no args are given. An error is returned if the container is not found, or is not running, or if there are any problems running ps, or parsing the output.
func (*Daemon) ContainerUnpause ¶
ContainerUnpause unpauses a container
func (*Daemon) ContainerUpdate ¶
func (daemon *Daemon) ContainerUpdate(name string, hostConfig *container.HostConfig) ([]string, error)
ContainerUpdate updates resources of the container
func (*Daemon) ContainerWait ¶
ContainerWait stops processing until the given container is stopped. If the container is not found, an error is returned. On a successful stop, the exit code of the container is returned. On a timeout, an error is returned. If you want to wait forever, supply a negative duration for the timeout.
func (*Daemon) ContainerWsAttachWithLogs ¶
func (daemon *Daemon) ContainerWsAttachWithLogs(prefixOrName string, c *ContainerWsAttachWithLogsConfig) error
ContainerWsAttachWithLogs websocket connection
func (*Daemon) Containers ¶
func (daemon *Daemon) Containers(config *ContainersConfig) ([]*types.Container, error)
Containers returns the list of containers to show given the user's filtering.
func (*Daemon) CreateNetwork ¶
func (daemon *Daemon) CreateNetwork(name, driver string, ipam network.IPAM, options map[string]string, internal bool) (libnetwork.Network, error)
CreateNetwork creates a network with the given name, driver and other optional parameters
func (*Daemon) DeleteNetwork ¶
DeleteNetwork destroys a network unless it's one of docker's predefined networks.
func (*Daemon) DisconnectContainerFromNetwork ¶
func (daemon *Daemon) DisconnectContainerFromNetwork(containerName string, network libnetwork.Network, force bool) error
DisconnectContainerFromNetwork disconnects the given container from the given network. If either cannot be found, an err is returned.
func (*Daemon) DisconnectFromNetwork ¶
func (daemon *Daemon) DisconnectFromNetwork(container *container.Container, n libnetwork.Network, force bool) error
DisconnectFromNetwork disconnects container from network n.
func (*Daemon) Exec ¶
func (d *Daemon) Exec(c *container.Container, execConfig *exec.Config, pipes *execdriver.Pipes, startCallback execdriver.DriverCallback) (int, error)
Exec calls the underlying exec driver to run
func (*Daemon) ExecExists ¶
ExecExists looks up the exec instance and returns a bool if it exists or not. It will also return the error produced by `getConfig`
func (*Daemon) ExecutionDriver ¶
func (daemon *Daemon) ExecutionDriver() execdriver.Driver
ExecutionDriver returns the currently used driver for creating and starting execs in a container.
func (*Daemon) Exists ¶
Exists returns a true if a container of the specified ID or name exists, false otherwise.
func (*Daemon) ExportImage ¶
ExportImage exports a list of images to the given output stream. The exported images are archived into a tar when written to the output stream. All images with the given tag and all versions containing the same tag are exported. names is the set of tags to export, and outStream is the writer which the images are written to.
func (*Daemon) FindNetwork ¶
func (daemon *Daemon) FindNetwork(idName string) (libnetwork.Network, error)
FindNetwork function finds a network for a given string that can represent network name or id
func (*Daemon) ForceEndpointDelete ¶
func (daemon *Daemon) ForceEndpointDelete(name string, n libnetwork.Network) error
ForceEndpointDelete deletes an endpoing from a network forcefully
func (*Daemon) GetAllNetworks ¶
func (daemon *Daemon) GetAllNetworks() []libnetwork.Network
GetAllNetworks returns a list containing all networks
func (*Daemon) GetContainer ¶
GetContainer 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) GetContainerStats ¶
func (daemon *Daemon) GetContainerStats(container *container.Container) (*execdriver.ResourceStats, error)
GetContainerStats collects all the stats published by a container
func (*Daemon) GetImage ¶
GetImage returns an image corresponding to the image referred to by refOrID.
func (*Daemon) GetImageID ¶
GetImageID returns an image ID corresponding to the image referred to by refOrID.
func (*Daemon) GetNetwork ¶
GetNetwork function returns a network for a given string that represents the network and a hint to indicate if the string is an Id or Name of the network
func (*Daemon) GetNetworkDriverList ¶
GetNetworkDriverList returns the list of plugins drivers registered for network.
func (*Daemon) GetNetworksByID ¶
func (daemon *Daemon) GetNetworksByID(partialID string) []libnetwork.Network
GetNetworksByID returns a list of networks whose ID partially matches zero or more networks
func (*Daemon) GetRemappedUIDGID ¶
GetRemappedUIDGID returns the current daemon's uid and gid values if user namespaces are in use for this daemon instance. If not this function will return "real" root values of 0, 0.
func (*Daemon) GetUIDGIDMaps ¶
GetUIDGIDMaps returns the current daemon's user namespace settings for the full uid and gid maps which will be applied to containers started in this instance.
func (*Daemon) GraphDriverName ¶
GraphDriverName returns the name of the graph driver used by the layer.Store
func (*Daemon) ImageDelete ¶
ImageDelete deletes the image referenced by the given imageRef from this daemon. The given imageRef can be an image ID, ID prefix, or a repository reference (with an optional tag or digest, defaulting to the tag name "latest"). There is differing behavior depending on whether the given imageRef is a repository reference or not.
If the given imageRef is a repository reference then that repository reference will be removed. However, if there exists any containers which were created using the same image reference then the repository reference cannot be removed unless either there are other repository references to the same image or force is true. Following removal of the repository reference, the referenced image itself will attempt to be deleted as described below but quietly, meaning any image delete conflicts will cause the image to not be deleted and the conflict will not be reported.
There may be conflicts preventing deletion of an image and these conflicts are divided into two categories grouped by their severity:
Hard Conflict:
- a pull or build using the image.
- any descendent image.
- any running container using the image.
Soft Conflict:
- any stopped container using the image.
- any repository tag or digest references to the image.
The image cannot be removed if there are any hard conflicts and can be removed if there are soft conflicts only if force is true.
If prune is true, ancestor images will each attempt to be deleted quietly, meaning any delete conflicts will cause the image to not be deleted and the conflict will not be reported.
FIXME: remove ImageDelete's dependency on Daemon, then move to the graph package. This would require that we no longer need the daemon to determine whether images are being used by a stopped or running container.
func (*Daemon) ImageGetCached ¶
func (daemon *Daemon) ImageGetCached(imgID image.ID, config *containertypes.Config) (*image.Image, error)
ImageGetCached returns the earliest created image that is a child of the image with imgID, that had the same config when it was created. nil is returned if a child cannot be found. An error is returned if the parent image cannot be found.
func (*Daemon) ImageHistory ¶
func (daemon *Daemon) ImageHistory(name string) ([]*types.ImageHistory, error)
ImageHistory returns a slice of ImageHistory structures for the specified image name by walking the image lineage.
func (*Daemon) Images ¶
Images returns a filtered list of images. filterArgs is a JSON-encoded set of filter arguments which will be interpreted by api/types/filters. filter is a shell glob string applied to repository names. The argument named all controls whether all images in the graph are filtered, or just the heads.
func (*Daemon) ImportImage ¶
func (daemon *Daemon) ImportImage(src string, newRef reference.Named, msg string, inConfig io.ReadCloser, outStream io.Writer, config *container.Config) error
ImportImage imports an image, getting the archived layer data either from inConfig (if src is "-"), or from a URI specified in src. Progress output is written to outStream. Repository and tag names can optionally be given in the repo and tag arguments, respectively.
func (*Daemon) IsShuttingDown ¶
IsShuttingDown tells whether the daemon is shutting down or not
func (*Daemon) LoadImage ¶
LoadImage uploads a set of images into the repository. This is the complement of ImageExport. The input stream is an uncompressed tar ball containing images and metadata.
func (*Daemon) LogContainerEvent ¶
LogContainerEvent generates an event related to a container.
func (*Daemon) LogImageEvent ¶
LogImageEvent generates an event related to a container.
func (*Daemon) LogNetworkEvent ¶
func (daemon *Daemon) LogNetworkEvent(nw libnetwork.Network, action string)
LogNetworkEvent generates an event related to a network with only the default attributes.
func (*Daemon) LogNetworkEventWithAttributes ¶
func (daemon *Daemon) LogNetworkEventWithAttributes(nw libnetwork.Network, action string, attributes map[string]string)
LogNetworkEventWithAttributes generates an event related to a network with specific given attributes.
func (*Daemon) LogVolumeEvent ¶
LogVolumeEvent generates an event related to a volume.
func (*Daemon) LookupImage ¶
func (daemon *Daemon) LookupImage(name string) (*types.ImageInspect, error)
LookupImage looks up an image by name and returns it as an ImageInspect structure.
func (*Daemon) NetworkControllerEnabled ¶
NetworkControllerEnabled checks if the networking stack is enabled. This feature depends on OS primitives and it's disabled in systems like Windows.
func (*Daemon) PullImage ¶
func (daemon *Daemon) PullImage(ref reference.Named, metaHeaders map[string][]string, authConfig *types.AuthConfig, outStream io.Writer) error
PullImage initiates a pull operation. image is the repository name to pull, and tag may be either empty, or indicate a specific tag to pull.
func (*Daemon) PushImage ¶
func (daemon *Daemon) PushImage(ref reference.Named, metaHeaders map[string][]string, authConfig *types.AuthConfig, outStream io.Writer) error
PushImage initiates a push operation on the repository named localName.
func (*Daemon) Reload ¶
Reload reads configuration changes and modifies the daemon according to those changes. This are the settings that Reload changes: - Daemon labels. - Cluster discovery (reconfigure and restart).
func (*Daemon) Run ¶
func (daemon *Daemon) Run(c *container.Container, pipes *execdriver.Pipes, startCallback execdriver.DriverCallback) (execdriver.ExitStatus, error)
Run uses the execution driver to run a given container
func (*Daemon) SearchRegistryForImages ¶
func (daemon *Daemon) SearchRegistryForImages(term string, authConfig *types.AuthConfig, headers map[string][]string) (*registrytypes.SearchResults, error)
SearchRegistryForImages queries the registry for images matching term. authConfig is used to login.
func (*Daemon) StartLogging ¶
StartLogging initializes and starts the container logging stream.
func (*Daemon) SubscribeToEvents ¶
func (daemon *Daemon) SubscribeToEvents(since, sinceNano int64, filter filters.Args) ([]eventtypes.Message, chan interface{})
SubscribeToEvents returns the currently record of events, a channel to stream new events from, and a function to cancel the stream of events.
func (*Daemon) SystemInfo ¶
SystemInfo returns information about the host server the daemon is running on.
func (*Daemon) SystemVersion ¶
SystemVersion returns version information about the daemon.
func (*Daemon) TagImage ¶
TagImage creates a tag in the repository reponame, pointing to the image named imageName.
func (*Daemon) UnsubscribeFromEvents ¶
func (daemon *Daemon) UnsubscribeFromEvents(listener chan interface{})
UnsubscribeFromEvents stops the event subscription for a client by closing the channel where the daemon sends events to.
func (*Daemon) VolumeCreate ¶
func (daemon *Daemon) VolumeCreate(name, driverName string, opts map[string]string) (*types.Volume, error)
VolumeCreate creates a volume with the specified name, driver, and opts This is called directly from the remote API
func (*Daemon) VolumeInspect ¶
VolumeInspect looks up a volume by name. An error is returned if the volume cannot be found.
type ErrImageDoesNotExist ¶
type ErrImageDoesNotExist struct {
RefOrID string
}
ErrImageDoesNotExist is error returned when no image can be found for a reference.
func (ErrImageDoesNotExist) Error ¶
func (e ErrImageDoesNotExist) Error() string
type History ¶
History is a convenience type for storing a list of containers, ordered by creation date.
type LogConfig ¶
type LogConfig struct { Type string `json:"log-driver,omitempty"` Config map[string]string `json:"log-opts,omitempty"` }
LogConfig represents the default log configuration. It includes json tags to deserialize configuration from a file using the same names that the flags in the command line uses.
Source Files ¶
- archive.go
- archive_unix.go
- attach.go
- changes.go
- commit.go
- config.go
- config_stub.go
- config_unix.go
- container_operations.go
- container_operations_unix.go
- create.go
- create_unix.go
- daemon.go
- daemon_linux.go
- daemon_stub.go
- daemon_unix.go
- debugtrap_unix.go
- delete.go
- discovery.go
- errors.go
- events.go
- exec.go
- exec_unix.go
- export.go
- history.go
- image_delete.go
- images.go
- import.go
- info.go
- inspect.go
- inspect_unix.go
- kill.go
- links.go
- list.go
- list_unix.go
- logdrivers_linux.go
- logs.go
- mounts.go
- network.go
- pause.go
- rename.go
- resize.go
- restart.go
- selinux_linux.go
- start.go
- stats.go
- stats_collector_unix.go
- stats_linux.go
- stop.go
- top_unix.go
- unpause.go
- update.go
- volumes.go
- volumes_unix.go
- wait.go
Directories ¶
Path | Synopsis |
---|---|
Package logger defines interfaces that logger drivers implement to log messages.
|
Package logger defines interfaces that logger drivers implement to log messages. |
awslogs
Package awslogs provides the logdriver for forwarding container logs to Amazon CloudWatch Logs
|
Package awslogs provides the logdriver for forwarding container logs to Amazon CloudWatch Logs |
fluentd
Package fluentd provides the log driver for forwarding server logs to fluentd endpoints.
|
Package fluentd provides the log driver for forwarding server logs to fluentd endpoints. |
gelf
Package gelf provides the log driver for forwarding server logs to endpoints that support the Graylog Extended Log Format.
|
Package gelf provides the log driver for forwarding server logs to endpoints that support the Graylog Extended Log Format. |
journald
Package journald provides the log driver for forwarding server logs to endpoints that receive the systemd format.
|
Package journald provides the log driver for forwarding server logs to endpoints that receive the systemd format. |
jsonfilelog
Package jsonfilelog provides the default Logger implementation for Docker logging.
|
Package jsonfilelog provides the default Logger implementation for Docker logging. |
splunk
Package splunk provides the log driver for forwarding server logs to Splunk HTTP Event Collector endpoint.
|
Package splunk provides the log driver for forwarding server logs to Splunk HTTP Event Collector endpoint. |
syslog
Package syslog provides the logdriver for forwarding server logs to syslog endpoints.
|
Package syslog provides the logdriver for forwarding server logs to syslog endpoints. |