daemon

package
v17.10.0-ce-rc1+incomp... Latest Latest
Warning

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

 Go to latest Published: Mar 23, 2020 License: Apache-2.0 Imports: 160 Imported by: 1

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

This section is empty.

Variables

View Source 
var (
	// DefaultRuntimeBinary is the default runtime to be used by
	// containerd if none is specified
	DefaultRuntimeBinary = "docker-runc"
)
View Source 
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.

View Source 
var (
	// ErrRootFSReadOnly is returned when a container
	// rootfs is marked readonly.
	ErrRootFSReadOnly = errors.New("container rootfs is marked read-only")
)
View Source 
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

func CreateDaemonRoot added in v1.13.0 

func CreateDaemonRoot(config *config.Config) error

CreateDaemonRoot creates the root for the daemon

func ModifyRootKeyLimit added in v1.12.0 

func ModifyRootKeyLimit() error

ModifyRootKeyLimit checks to see if the root key limit is set to at least 1000000 and changes it to that limit along with the maxbytes allocated to the keys at a 25 to 1 multiplier.

func UsingSystemd added in v1.11.0 

func UsingSystemd(config *config.Config) bool

UsingSystemd returns true if cli option includes native.cgroupdriver=systemd

func VerifyCgroupDriver added in v1.11.0 

func VerifyCgroupDriver(config *config.Config) error

VerifyCgroupDriver validates native.cgroupdriver

Types

type Cluster added in v1.13.0 

type Cluster interface {
	ClusterStatus
	NetworkManager
	SendClusterEvent(event lncluster.ConfigEventType)
}

Cluster is the interface for github.com/docker/docker/daemon/cluster.(*Cluster).

type ClusterStatus 

type ClusterStatus interface {
	IsAgent() bool
	IsManager() bool
}

ClusterStatus interface provides information about the Swarm status of the Cluster

type Daemon 

type Daemon struct {
	ID string

	RegistryService registry.Service
	EventsService   *events.Events

	PluginStore *plugin.Store // todo: remove
	// contains filtered or unexported fields
}

Daemon holds information about the Docker daemon.

func NewDaemon 

func NewDaemon(config *config.Config, registryService registry.Service, containerdRemote libcontainerd.Remote, pluginStore *plugin.Store) (daemon *Daemon, err error)

NewDaemon sets up everything for the daemon to be able to service requests from the webserver.

func (*Daemon) ActivateContainerServiceBinding added in v1.13.0 

func (daemon *Daemon) ActivateContainerServiceBinding(containerName string) error

ActivateContainerServiceBinding puts this container into load balancer active rotation and DNS response

func (*Daemon) AuthenticateToRegistry added in v1.9.0 

func (daemon *Daemon) AuthenticateToRegistry(ctx context.Context, authConfig *types.AuthConfig) (string, string, error)

AuthenticateToRegistry checks the validity of credentials in authConfig

func (*Daemon) CheckpointCreate added in v1.13.0 

func (daemon *Daemon) CheckpointCreate(name string, config types.CheckpointCreateOptions) error

CheckpointCreate checkpoints the process running in a container with CRIU

func (*Daemon) CheckpointDelete added in v1.13.0 

func (daemon *Daemon) CheckpointDelete(name string, config types.CheckpointDeleteOptions) error

CheckpointDelete deletes the specified checkpoint

func (*Daemon) CheckpointList added in v1.13.0 

func (daemon *Daemon) CheckpointList(name string, config types.CheckpointListOptions) ([]types.Checkpoint, error)

CheckpointList lists all checkpoints of the specified container

func (*Daemon) Cleanup added in v1.10.0 

func (daemon *Daemon) Cleanup(container *container.Container)

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 

func (daemon *Daemon) Commit(name string, c *backend.ContainerCommitConfig) (string, 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) ConnectContainerToNetwork added in v1.10.0 

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 added in v1.10.0 

func (daemon *Daemon) ConnectToNetwork(container *container.Container, idOrName string, endpointConfig *networktypes.EndpointSettings) error

ConnectToNetwork connects a container to a network

func (*Daemon) ContainerArchivePath added in v1.8.0 

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) ContainerAttach added in v1.2.0 

func (daemon *Daemon) ContainerAttach(prefixOrName string, c *backend.ContainerAttachConfig) error

ContainerAttach attaches to logs according to the config passed in. See ContainerAttachConfig.

func (*Daemon) ContainerAttachRaw added in v1.11.0 

func (daemon *Daemon) ContainerAttachRaw(prefixOrName string, stdin io.ReadCloser, stdout, stderr io.Writer, doStream bool, attached chan struct{}) error

ContainerAttachRaw attaches the provided streams to the container's stdio

func (*Daemon) ContainerChanges added in v1.2.0 

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

ContainerChanges returns a list of container fs changes

func (*Daemon) ContainerCopy added in v1.2.0 

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

ContainerCopy performs a deprecated operation of archiving the resource at the specified path in the container identified by the given name.

func (*Daemon) ContainerCreate added in v1.2.0 

func (daemon *Daemon) ContainerCreate(params types.ContainerCreateConfig) (containertypes.ContainerCreateCreatedBody, error)

ContainerCreate creates a regular container

func (*Daemon) ContainerCreateWorkdir added in v1.13.0 

func (daemon *Daemon) ContainerCreateWorkdir(cID string) error

ContainerCreateWorkdir creates the working directory. This solves the issue arising from https://github.com/docker/docker/issues/27545, which was initially fixed by https://github.com/docker/docker/pull/27884. But that fix was too expensive in terms of performance on Windows. Instead, https://github.com/docker/docker/pull/28514 introduces this new functionality where the builder calls into the backend here to create the working directory.

func (*Daemon) ContainerExecCreate added in v1.3.0 

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

ContainerExecCreate sets up an exec in a running container.

func (*Daemon) ContainerExecInspect added in v1.4.0 

func (daemon *Daemon) ContainerExecInspect(id string) (*backend.ExecInspect, error)

ContainerExecInspect returns low-level information about the exec command. An error is returned if the exec cannot be found.

func (*Daemon) ContainerExecResize added in v1.3.0 

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

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 added in v1.3.0 

func (d *Daemon) ContainerExecStart(ctx context.Context, name string, stdin io.Reader, stdout io.Writer, stderr io.Writer) (err error)

ContainerExecStart starts a previously set up exec instance. The std streams are set up. If ctx is cancelled, the process is terminated.

func (*Daemon) ContainerExport added in v1.2.0 

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

ContainerExport writes the contents of the container to the given writer. An error is returned if the container cannot be found.

func (*Daemon) ContainerExtractToDir added in v1.8.0 

func (daemon *Daemon) ContainerExtractToDir(name, path string, copyUIDGID, 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 added in v0.12.0 

func (daemon *Daemon) ContainerInspect(name string, size bool, version string) (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) ContainerInspectCurrent added in v1.12.0 

func (daemon *Daemon) ContainerInspectCurrent(name string, size bool) (*types.ContainerJSON, error)

ContainerInspectCurrent returns low-level information about a container in a most recent api version.

func (*Daemon) ContainerKill added in v1.2.0 

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

ContainerKill sends 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 added in v1.2.0 

func (daemon *Daemon) ContainerLogs(ctx context.Context, containerName string, config *types.ContainerLogsOptions) (<-chan *backend.LogMessage, bool, error)

ContainerLogs copies the container's log channel to the channel provided in the config. If ContainerLogs returns an error, no messages have been copied. and the channel will be closed without data.

if it returns nil, the config channel will be active and return log messages until it runs out or the context is canceled.

func (*Daemon) ContainerPause added in v1.2.0 

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

ContainerPause pauses a container

func (*Daemon) ContainerRename added in v1.5.0 

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

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 added in v1.2.0 

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

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 added in v1.2.0 

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

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 added in v1.3.0 

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 added in v1.2.0 

func (daemon *Daemon) ContainerStart(name string, hostConfig *containertypes.HostConfig, checkpoint string, checkpointDir string) error

ContainerStart starts a container.

func (*Daemon) ContainerStatPath added in v1.8.0 

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 added in v1.5.0 

func (daemon *Daemon) ContainerStats(ctx context.Context, prefixOrName string, config *backend.ContainerStatsConfig) error

ContainerStats writes information about the container to the stream given in the config object.

func (*Daemon) ContainerStop added in v1.2.0 

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

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 added in v1.2.0 

func (daemon *Daemon) ContainerTop(name string, psArgs string) (*container.ContainerTopOKBody, error)

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 added in v1.2.0 

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

ContainerUnpause unpauses a container

func (*Daemon) ContainerUpdate added in v1.10.0 

func (daemon *Daemon) ContainerUpdate(name string, hostConfig *container.HostConfig) (container.ContainerUpdateOKBody, error)

ContainerUpdate updates configuration of the container

func (*Daemon) ContainerWait added in v1.2.0 

func (daemon *Daemon) ContainerWait(ctx context.Context, name string, condition container.WaitCondition) (<-chan container.StateStatus, error)

ContainerWait waits until the given container is in a certain state indicated by the given condition. If the container is not found, a nil channel and non-nil error is returned immediately. If the container is found, a status result will be sent on the returned channel once the wait condition is met or if an error occurs waiting for the container (such as a context timeout or cancellation). On a successful wait, the exit code of the container is returned in the status with a non-nil Err() value.

func (*Daemon) Containers added in v1.2.0 

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

Containers returns the list of containers to show given the user's filtering.

func (*Daemon) ContainersPrune added in v1.13.0 

func (daemon *Daemon) ContainersPrune(ctx context.Context, pruneFilters filters.Args) (*types.ContainersPruneReport, error)

ContainersPrune removes unused containers

func (*Daemon) CreateImage 

func (daemon *Daemon) CreateImage(config []byte, parent string, platform string) (builder.Image, error)

CreateImage creates a new image by adding a config and ID to the image store. This is similar to LoadImage() except that it receives JSON encoded bytes of an image instead of a tar archive.

func (*Daemon) CreateManagedContainer added in v1.12.0 

func (daemon *Daemon) CreateManagedContainer(params types.ContainerCreateConfig) (containertypes.ContainerCreateCreatedBody, error)

CreateManagedContainer creates a container that is managed by a Service

func (*Daemon) CreateManagedNetwork added in v1.12.0 

func (daemon *Daemon) CreateManagedNetwork(create clustertypes.NetworkCreateRequest) error

CreateManagedNetwork creates an agent network.

func (*Daemon) CreateNetwork added in v1.9.0 

func (daemon *Daemon) CreateNetwork(create types.NetworkCreateRequest) (*types.NetworkCreateResponse, error)

CreateNetwork creates a network with the given name, driver and other optional parameters

func (*Daemon) DaemonJoinsCluster added in v1.13.1 

func (daemon *Daemon) DaemonJoinsCluster(clusterProvider cluster.Provider)

DaemonJoinsCluster informs the daemon has joined the cluster and provides the handler to query the cluster component

func (*Daemon) DaemonLeavesCluster added in v1.13.1 

func (daemon *Daemon) DaemonLeavesCluster()

DaemonLeavesCluster informs the daemon has left the cluster

func (*Daemon) DeactivateContainerServiceBinding added in v1.13.0 

func (daemon *Daemon) DeactivateContainerServiceBinding(containerName string) error

DeactivateContainerServiceBinding removes this container from load balancer active rotation, and DNS response

func (*Daemon) DeleteManagedNetwork added in v1.12.0 

func (daemon *Daemon) DeleteManagedNetwork(networkID string) error

DeleteManagedNetwork deletes an agent network.

func (*Daemon) DeleteNetwork added in v1.10.0 

func (daemon *Daemon) DeleteNetwork(networkID string) error

DeleteNetwork destroys a network unless it's one of docker's predefined networks.

func (*Daemon) DisconnectContainerFromNetwork added in v1.10.0 

func (daemon *Daemon) DisconnectContainerFromNetwork(containerName string, networkName string, force bool) error

DisconnectContainerFromNetwork disconnects the given container from the given network. If either cannot be found, an err is returned.

func (*Daemon) DisconnectFromNetwork added in v1.10.0 

func (daemon *Daemon) DisconnectFromNetwork(container *container.Container, networkName string, force bool) error

DisconnectFromNetwork disconnects container from network n.

func (*Daemon) ExecExists added in v1.9.0 

func (d *Daemon) ExecExists(name string) (bool, error)

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) 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) ExportImage added in v1.9.0 

func (daemon *Daemon) ExportImage(names []string, outStream io.Writer) error

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) FillPlatformInfo added in v1.13.0 

func (daemon *Daemon) FillPlatformInfo(v *types.Info, sysInfo *sysinfo.SysInfo)

FillPlatformInfo fills the platform related info.

func (*Daemon) FindNetwork added in v1.9.0 

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 added in v1.10.0 

func (daemon *Daemon) ForceEndpointDelete(name string, networkName string) error

ForceEndpointDelete deletes an endpoint from a network forcefully

func (*Daemon) GetAttachmentStore 

func (daemon *Daemon) GetAttachmentStore() *network.AttachmentStore

GetAttachmentStore returns current attachment store associated with the daemon

func (*Daemon) GetByName 

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

GetByName returns a container given a name.

func (*Daemon) GetCluster added in v1.13.0 

func (daemon *Daemon) GetCluster() Cluster

GetCluster returns the cluster

func (*Daemon) GetContainer added in v1.10.0 

func (daemon *Daemon) GetContainer(prefixOrName string) (*container.Container, error)

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 added in v1.10.0 

func (daemon *Daemon) GetContainerStats(container *container.Container) (*types.StatsJSON, error)

GetContainerStats collects all the stats published by a container

func (*Daemon) GetImage added in v1.9.0 

func (daemon *Daemon) GetImage(refOrID string) (*image.Image, error)

GetImage returns an image corresponding to the image referred to by refOrID.

func (*Daemon) GetImageAndReleasableLayer 

func (daemon *Daemon) GetImageAndReleasableLayer(ctx context.Context, refOrID string, opts backend.GetImageAndLayerOptions) (builder.Image, builder.ReleaseableLayer, error)

GetImageAndReleasableLayer returns an image and releaseable layer for a reference or ID. Every call to GetImageAndReleasableLayer MUST call releasableLayer.Release() to prevent leaking of layers.

func (*Daemon) GetImageIDAndPlatform 

func (daemon *Daemon) GetImageIDAndPlatform(refOrID string) (image.ID, string, error)

GetImageIDAndPlatform returns an image ID and platform corresponding to the image referred to by refOrID.

func (*Daemon) GetNetworkByID added in v1.11.0 

func (daemon *Daemon) GetNetworkByID(partialID string) (libnetwork.Network, error)

GetNetworkByID function returns a network whose ID begins with the given prefix. It fails with an error if no matching, or more than one matching, networks are found.

func (*Daemon) GetNetworkByName added in v1.11.0 

func (daemon *Daemon) GetNetworkByName(name string) (libnetwork.Network, error)

GetNetworkByName function returns a network for a given network name. If no network name is given, the default network is returned.

func (*Daemon) GetNetworkDriverList added in v1.10.0 

func (daemon *Daemon) GetNetworkDriverList() []string

GetNetworkDriverList returns the list of plugins drivers registered for network.

func (*Daemon) GetNetworks added in v1.12.0 

func (daemon *Daemon) GetNetworks() []libnetwork.Network

GetNetworks returns a list of all networks

func (*Daemon) GetNetworksByID added in v1.9.0 

func (daemon *Daemon) GetNetworksByID(partialID string) []libnetwork.Network

GetNetworksByID returns a list of networks whose ID partially matches zero or more networks

func (*Daemon) GetRepository added in v1.13.0 

func (daemon *Daemon) GetRepository(ctx context.Context, ref reference.Named, authConfig *types.AuthConfig) (dist.Repository, bool, error)

GetRepository returns a repository from the registry.

func (*Daemon) GraphDriverName added in v1.10.0 

func (daemon *Daemon) GraphDriverName(platform string) string

GraphDriverName returns the name of the graph driver used by the layer.Store

func (*Daemon) HasExperimental added in v1.13.0 

func (daemon *Daemon) HasExperimental() bool

HasExperimental returns whether the experimental features of the daemon are enabled or not

func (*Daemon) IDMappings 

func (daemon *Daemon) IDMappings() *idtools.IDMappings

IDMappings returns uid/gid mappings for the builder

func (*Daemon) ImageDelete added in v1.2.0 

func (daemon *Daemon) ImageDelete(imageRef string, force, prune bool) ([]types.ImageDeleteResponseItem, error)

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 descendant 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) ImageHistory added in v1.9.0 

func (daemon *Daemon) ImageHistory(name string) ([]*image.HistoryResponseItem, error)

ImageHistory returns a slice of ImageHistory structures for the specified image name by walking the image lineage.

func (*Daemon) Images added in v1.10.0 

func (daemon *Daemon) Images(imageFilters filters.Args, all bool, withExtraAttrs bool) ([]*types.ImageSummary, error)

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) ImagesPrune added in v1.13.0 

func (daemon *Daemon) ImagesPrune(ctx context.Context, pruneFilters filters.Args) (*types.ImagesPruneReport, error)

ImagesPrune removes unused images

func (*Daemon) ImportImage added in v1.9.0 

func (daemon *Daemon) ImportImage(src string, repository, platform string, tag string, msg string, inConfig io.ReadCloser, outStream io.Writer, changes []string) 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) IsPaused added in v1.10.0 

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

IsPaused returns a bool indicating if the specified container is paused.

func (*Daemon) IsShuttingDown added in v1.10.0 

func (daemon *Daemon) IsShuttingDown() bool

IsShuttingDown tells whether the daemon is shutting down or not

func (*Daemon) IsSwarmCompatible added in v1.12.0 

func (daemon *Daemon) IsSwarmCompatible() error

IsSwarmCompatible verifies if the current daemon configuration is compatible with the swarm mode

func (*Daemon) Kill 

func (daemon *Daemon) Kill(container *containerpkg.Container) error

Kill forcefully terminates a container.

func (*Daemon) List 

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

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

func (*Daemon) LoadImage added in v1.9.0 

func (daemon *Daemon) LoadImage(inTar io.ReadCloser, outStream io.Writer, quiet bool) error

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 added in v1.10.0 

func (daemon *Daemon) LogContainerEvent(container *container.Container, action string)

LogContainerEvent generates an event related to a container with only the default attributes.

func (*Daemon) LogContainerEventWithAttributes added in v1.11.0 

func (daemon *Daemon) LogContainerEventWithAttributes(container *container.Container, action string, attributes map[string]string)

LogContainerEventWithAttributes generates an event related to a container with specific given attributes.

func (*Daemon) LogDaemonEventWithAttributes added in v1.12.0 

func (daemon *Daemon) LogDaemonEventWithAttributes(action string, attributes map[string]string)

LogDaemonEventWithAttributes generates an event related to the daemon itself with specific given attributes.

func (*Daemon) LogImageEvent added in v1.10.0 

func (daemon *Daemon) LogImageEvent(imageID, refName, action string)

LogImageEvent generates an event related to an image with only the default attributes.

func (*Daemon) LogImageEventWithAttributes added in v1.11.0 

func (daemon *Daemon) LogImageEventWithAttributes(imageID, refName, action string, attributes map[string]string)

LogImageEventWithAttributes generates an event related to an image with specific given attributes.

func (*Daemon) LogNetworkEvent added in v1.10.0 

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 added in v1.10.0 

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) LogPluginEvent added in v1.12.1 

func (daemon *Daemon) LogPluginEvent(pluginID, refName, action string)

LogPluginEvent generates an event related to a plugin with only the default attributes.

func (*Daemon) LogPluginEventWithAttributes added in v1.12.1 

func (daemon *Daemon) LogPluginEventWithAttributes(pluginID, refName, action string, attributes map[string]string)

LogPluginEventWithAttributes generates an event related to a plugin with specific given attributes.

func (*Daemon) LogVolumeEvent added in v1.10.0 

func (daemon *Daemon) LogVolumeEvent(volumeID, action string, attributes map[string]string)

LogVolumeEvent generates an event related to a volume.

func (*Daemon) LookupImage added in v1.9.0 

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) MakeImageCache added in v1.13.0 

func (daemon *Daemon) MakeImageCache(sourceRefs []string, platform string) builder.ImageCache

MakeImageCache creates a stateful image cache.

func (*Daemon) Map added in v1.10.0 

func (daemon *Daemon) Map() map[image.ID]*image.Image

Map returns a map of all images in the ImageStore

func (*Daemon) Mount 

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

Mount sets container.BaseFS (is it not set coming in? why is it unset?)

func (*Daemon) NetworkControllerEnabled added in v1.9.0 

func (daemon *Daemon) NetworkControllerEnabled() bool

NetworkControllerEnabled checks if the networking stack is enabled. This feature depends on OS primitives and it's disabled in systems like Windows.

func (*Daemon) NetworksPrune added in v1.13.0 

func (daemon *Daemon) NetworksPrune(ctx context.Context, pruneFilters filters.Args) (*types.NetworksPruneReport, error)

NetworksPrune removes unused networks

func (*Daemon) PluginGetter added in v1.13.1 

func (daemon *Daemon) PluginGetter() *plugin.Store

PluginGetter returns current pluginStore associated with the daemon

func (*Daemon) PluginManager added in v1.13.0 

func (daemon *Daemon) PluginManager() *plugin.Manager

PluginManager returns current pluginManager associated with the daemon

func (*Daemon) ProcessClusterNotifications 

func (daemon *Daemon) ProcessClusterNotifications(ctx context.Context, watchStream chan *swarmapi.WatchMessage)

ProcessClusterNotifications gets changes from store and add them to event list

func (*Daemon) PullImage added in v1.9.0 

func (daemon *Daemon) PullImage(ctx context.Context, image, tag, platform string, 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 added in v1.9.0 

func (daemon *Daemon) PushImage(ctx context.Context, image, tag string, metaHeaders map[string][]string, authConfig *types.AuthConfig, outStream io.Writer) error

PushImage initiates a push operation on the repository named localName.

func (*Daemon) Register 

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

Register makes a container object usable by the daemon as <container.ID>

func (*Daemon) ReleaseIngress 

func (daemon *Daemon) ReleaseIngress() (<-chan struct{}, error)

ReleaseIngress releases the ingress networking. The function returns a channel which will signal the caller when the programming is completed.

func (*Daemon) Reload added in v1.10.0 

func (daemon *Daemon) Reload(conf *config.Config) (err error)

Reload reads configuration changes and modifies the daemon according to those changes. These are the settings that Reload changes: - Platform runtime - Daemon debug log level - Daemon max concurrent downloads - Daemon max concurrent uploads - Daemon shutdown timeout (in seconds) - Cluster discovery (reconfigure and restart) - Daemon labels - Insecure registries - Registry mirrors - Daemon live restore

func (*Daemon) RestartSwarmContainers added in v1.13.0 

func (daemon *Daemon) RestartSwarmContainers()

RestartSwarmContainers restarts any autostart container which has a swarm endpoint.

func (*Daemon) SearchRegistryForImages added in v1.9.0 

func (daemon *Daemon) SearchRegistryForImages(ctx context.Context, filtersArgs string, term string, limit int,
	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) SetCluster added in v1.13.0 

func (daemon *Daemon) SetCluster(cluster Cluster)

SetCluster sets the cluster

func (*Daemon) SetContainerConfigReferences 

func (daemon *Daemon) SetContainerConfigReferences(name string, refs []*swarmtypes.ConfigReference) error

SetContainerConfigReferences sets the container config references needed

func (*Daemon) SetContainerDependencyStore 

func (daemon *Daemon) SetContainerDependencyStore(name string, store exec.DependencyGetter) error

SetContainerDependencyStore sets the dependency store backend for the container

func (*Daemon) SetContainerSecretReferences added in v1.13.0 

func (daemon *Daemon) SetContainerSecretReferences(name string, refs []*swarmtypes.SecretReference) error

SetContainerSecretReferences sets the container secret references needed

func (*Daemon) SetNetworkBootstrapKeys added in v1.12.0 

func (daemon *Daemon) SetNetworkBootstrapKeys(keys []*networktypes.EncryptionKey) error

SetNetworkBootstrapKeys sets the bootstrap keys.

func (*Daemon) SetupIngress added in v1.12.0 

func (daemon *Daemon) SetupIngress(create clustertypes.NetworkCreateRequest, nodeIP string) (<-chan struct{}, error)

SetupIngress setups ingress networking. The function returns a channel which will signal the caller when the programming is completed.

func (*Daemon) Shutdown added in v1.7.0 

func (daemon *Daemon) Shutdown() error

Shutdown stops the daemon.

func (*Daemon) ShutdownTimeout added in v1.13.0 

func (daemon *Daemon) ShutdownTimeout() int

ShutdownTimeout returns the shutdown timeout based on the max stopTimeout of the containers, and is limited by daemon's ShutdownTimeout.

func (*Daemon) SquashImage added in v1.13.0 

func (daemon *Daemon) SquashImage(id, parent string) (string, error)

SquashImage creates a new image with the diff of the specified image and the specified parent. This new image contains only the layers from it's parent + 1 extra layer which contains the diff of all the layers in between. The existing image(s) is not destroyed. If no parent is specified, a new image with the diff of all the specified image's layers merged into a new layer that has no parents.

func (*Daemon) StateChanged added in v1.11.0 

func (daemon *Daemon) StateChanged(id string, e libcontainerd.StateInfo) error

StateChanged updates daemon state changes from containerd

func (*Daemon) StoreHosts 

func (daemon *Daemon) StoreHosts(hosts []string)

StoreHosts stores the addresses the daemon is listening on

func (*Daemon) Subnets 

func (daemon *Daemon) Subnets() ([]net.IPNet, []net.IPNet)

Subnets return the IPv4 and IPv6 subnets of networks that are manager by Docker.

func (*Daemon) SubscribeToEvents added in v1.10.0 

func (daemon *Daemon) SubscribeToEvents(since, until time.Time, filter filters.Args) ([]events.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) SystemDiskUsage added in v1.13.0 

func (daemon *Daemon) SystemDiskUsage(ctx context.Context) (*types.DiskUsage, error)

SystemDiskUsage returns information about the daemon data disk usage

func (*Daemon) SystemInfo added in v1.7.0 

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

SystemInfo returns information about the host server the daemon is running on.

func (*Daemon) SystemVersion added in v1.10.0 

func (daemon *Daemon) SystemVersion() types.Version

SystemVersion returns version information about the daemon.

func (*Daemon) TagImage added in v1.9.0 

func (daemon *Daemon) TagImage(imageName, repository, tag string) error

TagImage creates the tag specified by newTag, pointing to the image named imageName (alternatively, imageName can also be an image ID).

func (*Daemon) TagImageWithReference added in v1.12.0 

func (daemon *Daemon) TagImageWithReference(imageID image.ID, platform string, newTag reference.Named) error

TagImageWithReference adds the given reference to the image ID provided.

func (*Daemon) Unmount 

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

Unmount unsets the container base filesystem

func (*Daemon) UnsubscribeFromEvents added in v1.10.0 

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) UpdateAttachment added in v1.13.0 

func (daemon *Daemon) UpdateAttachment(networkName, networkID, containerID string, config *network.NetworkingConfig) error

UpdateAttachment notifies the attacher about the attachment config.

func (*Daemon) UpdateContainerServiceConfig added in v1.12.0 

func (daemon *Daemon) UpdateContainerServiceConfig(containerName string, serviceConfig *clustertypes.ServiceConfig) error

UpdateContainerServiceConfig updates a service configuration.

func (*Daemon) VolumeCreate added in v1.9.0 

func (daemon *Daemon) VolumeCreate(name, driverName string, opts, labels map[string]string) (*types.Volume, error)

VolumeCreate creates a volume with the specified name, driver, and opts This is called directly from the Engine API

func (*Daemon) VolumeInspect added in v1.9.0 

func (daemon *Daemon) VolumeInspect(name string) (*types.Volume, error)

VolumeInspect looks up a volume by name. An error is returned if the volume cannot be found.

func (*Daemon) VolumeRm added in v1.9.0 

func (daemon *Daemon) VolumeRm(name string, force bool) error

VolumeRm removes the volume with the given name. If the volume is referenced by a container it is not removed This is called directly from the Engine API

func (*Daemon) Volumes 

func (daemon *Daemon) Volumes(filter string) ([]*types.Volume, []string, error)

Volumes lists known volumes, using the filter to restrict the range of volumes returned.

func (*Daemon) VolumesPrune added in v1.13.0 

func (daemon *Daemon) VolumesPrune(ctx context.Context, pruneFilters filters.Args) (*types.VolumesPruneReport, error)

VolumesPrune removes unused local volumes

func (*Daemon) WaitForDetachment added in v1.13.0 

func (daemon *Daemon) WaitForDetachment(ctx context.Context, networkName, networkID, taskID, containerID string) error

WaitForDetachment makes the cluster manager wait for detachment of the container from the network.

type NetworkManager 

type NetworkManager interface {
	GetNetwork(input string) (apitypes.NetworkResource, error)
	GetNetworks() ([]apitypes.NetworkResource, error)
	RemoveNetwork(input string) error
}

NetworkManager provides methods to manage networks

Source Files

View all Source files

Directories

Path Synopsis
controllers/plugin
convert
executor
executor/container
provider
testutils
aufs
btrfs
devmapper
graphtest
lcow
overlay
overlay2
overlayutils
quota
register
vfs
windows
zfs
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
etwlogs
Package etwlogs provides a log driver for forwarding container logs as ETW events.(ETW stands for Event Tracing for Windows) A client can then create an ETW listener to listen for events that are sent by the ETW provider that we register, using the provider's GUID "a3693192-9ed6-46d2-a981-f8226c8363bd".
 Package etwlogs provides a log driver for forwarding container logs as ETW events.(ETW stands for Event Tracing for Windows) A client can then create an ETW listener to listen for events that are sent by the ETW provider that we register, using the provider's GUID "a3693192-9ed6-46d2-a981-f8226c8363bd".
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.
gcplogs
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.
jsonfilelog/jsonlog
jsonfilelog/multireader
logentries
Package logentries provides the log driver for forwarding server logs to logentries endpoints.
 Package logentries provides the log driver for forwarding server logs to logentries endpoints.
loggerutils
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.
templates

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.