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 ¶
- Variables
- func CreateDaemonRoot(config *config.Config) error
- func ModifyRootKeyLimit() error
- func UsingSystemd(config *config.Config) bool
- func VerifyCgroupDriver(config *config.Config) error
- type Cluster
- type ClusterStatus
- type Daemon
- func (daemon *Daemon) ActivateContainerServiceBinding(containerName string) error
- func (daemon *Daemon) AuthenticateToRegistry(ctx context.Context, authConfig *types.AuthConfig) (string, string, error)
- func (daemon *Daemon) CheckpointCreate(name string, config types.CheckpointCreateOptions) error
- func (daemon *Daemon) CheckpointDelete(name string, config types.CheckpointDeleteOptions) error
- func (daemon *Daemon) CheckpointList(name string, config types.CheckpointListOptions) ([]types.Checkpoint, error)
- func (daemon *Daemon) Cleanup(container *container.Container)
- func (daemon *Daemon) Commit(name string, c *backend.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) ContainerAttach(prefixOrName string, c *backend.ContainerAttachConfig) error
- func (daemon *Daemon) ContainerAttachRaw(prefixOrName string, stdin io.ReadCloser, stdout, stderr io.Writer, ...) 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) (containertypes.ContainerCreateCreatedBody, error)
- func (daemon *Daemon) ContainerCreateWorkdir(cID string) error
- func (d *Daemon) ContainerExecCreate(name string, config *types.ExecConfig) (string, error)
- func (daemon *Daemon) ContainerExecInspect(id string) (*backend.ExecInspect, error)
- func (daemon *Daemon) ContainerExecResize(name string, height, width int) error
- func (d *Daemon) ContainerExecStart(ctx context.Context, name string, stdin io.ReadCloser, stdout io.Writer, ...) (err error)
- func (daemon *Daemon) ContainerExport(name string, out io.Writer) error
- func (daemon *Daemon) ContainerExtractToDir(name, path string, copyUIDGID, noOverwriteDirNonDir bool, content io.Reader) error
- func (daemon *Daemon) ContainerInspect(name string, size bool, version string) (interface{}, error)
- func (daemon *Daemon) ContainerInspectCurrent(name string, size bool) (*types.ContainerJSON, error)
- func (daemon *Daemon) ContainerKill(name string, sig uint64) error
- func (daemon *Daemon) ContainerLogs(ctx context.Context, containerName string, config *types.ContainerLogsOptions) (<-chan *backend.LogMessage, 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, checkpoint string, ...) error
- func (daemon *Daemon) ContainerStatPath(name string, path string) (stat *types.ContainerPathStat, err error)
- func (daemon *Daemon) ContainerStats(ctx context.Context, prefixOrName string, config *backend.ContainerStatsConfig) error
- func (daemon *Daemon) ContainerStop(name string, seconds *int) error
- func (daemon *Daemon) ContainerTop(name string, psArgs string) (*container.ContainerTopOKBody, error)
- func (daemon *Daemon) ContainerUnpause(name string) error
- func (daemon *Daemon) ContainerUpdate(name string, hostConfig *container.HostConfig) (container.ContainerUpdateOKBody, error)
- func (daemon *Daemon) ContainerUpdateCmdOnBuild(cID string, cmd []string) error
- func (daemon *Daemon) ContainerWait(name string, timeout time.Duration) (int, error)
- func (daemon *Daemon) ContainerWaitWithContext(ctx context.Context, name string) error
- func (daemon *Daemon) Containers(config *types.ContainerListOptions) ([]*types.Container, error)
- func (daemon *Daemon) ContainersPrune(pruneFilters filters.Args) (*types.ContainersPruneReport, error)
- func (daemon *Daemon) CopyOnBuild(cID string, destPath string, src builder.FileInfo, decompress bool) error
- func (daemon *Daemon) CreateManagedContainer(params types.ContainerCreateConfig) (containertypes.ContainerCreateCreatedBody, error)
- func (daemon *Daemon) CreateManagedNetwork(create clustertypes.NetworkCreateRequest) error
- func (daemon *Daemon) CreateNetwork(create types.NetworkCreateRequest) (*types.NetworkCreateResponse, error)
- func (daemon *Daemon) DaemonJoinsCluster(clusterProvider cluster.Provider)
- func (daemon *Daemon) DaemonLeavesCluster()
- func (daemon *Daemon) DeactivateContainerServiceBinding(containerName string) error
- func (daemon *Daemon) DeleteManagedNetwork(networkID string) error
- func (daemon *Daemon) DeleteNetwork(networkID string) error
- func (daemon *Daemon) DisconnectContainerFromNetwork(containerName string, networkName string, force bool) error
- func (daemon *Daemon) DisconnectFromNetwork(container *container.Container, networkName string, force bool) error
- func (d *Daemon) ExecExists(name string) (bool, error)
- func (daemon *Daemon) Exists(id string) bool
- func (daemon *Daemon) ExportImage(names []string, outStream io.Writer) error
- func (daemon *Daemon) FillPlatformInfo(v *types.Info, sysInfo *sysinfo.SysInfo)
- func (daemon *Daemon) FindNetwork(idName string) (libnetwork.Network, error)
- func (daemon *Daemon) ForceEndpointDelete(name string, networkName string) error
- func (daemon *Daemon) GetByName(name string) (*container.Container, error)
- func (daemon *Daemon) GetCluster() Cluster
- func (daemon *Daemon) GetContainer(prefixOrName string) (*container.Container, error)
- func (daemon *Daemon) GetContainerStats(container *container.Container) (*types.StatsJSON, error)
- func (daemon *Daemon) GetImage(refOrID string) (*image.Image, error)
- func (daemon *Daemon) GetImageID(refOrID string) (image.ID, error)
- func (daemon *Daemon) GetImageOnBuild(name string) (builder.Image, error)
- func (daemon *Daemon) GetNetworkByID(partialID string) (libnetwork.Network, error)
- func (daemon *Daemon) GetNetworkByName(name string) (libnetwork.Network, error)
- func (daemon *Daemon) GetNetworkDriverList() []string
- func (daemon *Daemon) GetNetworks() []libnetwork.Network
- func (daemon *Daemon) GetNetworksByID(partialID string) []libnetwork.Network
- func (daemon *Daemon) GetRemappedUIDGID() (int, int)
- func (daemon *Daemon) GetRepository(ctx context.Context, ref reference.NamedTagged, authConfig *types.AuthConfig) (dist.Repository, bool, error)
- func (daemon *Daemon) GetUIDGIDMaps() ([]idtools.IDMap, []idtools.IDMap)
- func (daemon *Daemon) GraphDriverName() string
- func (daemon *Daemon) HasExperimental() bool
- func (daemon *Daemon) ImageDelete(imageRef string, force, prune bool) ([]types.ImageDeleteResponseItem, error)
- func (daemon *Daemon) ImageHistory(name string) ([]*image.HistoryResponseItem, error)
- func (daemon *Daemon) Images(imageFilters filters.Args, all bool, withExtraAttrs bool) ([]*types.ImageSummary, error)
- func (daemon *Daemon) ImagesPrune(pruneFilters filters.Args) (*types.ImagesPruneReport, error)
- func (daemon *Daemon) ImportImage(src string, repository, tag string, msg string, inConfig io.ReadCloser, ...) error
- func (daemon *Daemon) IsPaused(id string) bool
- func (daemon *Daemon) IsShuttingDown() bool
- func (daemon *Daemon) IsSwarmCompatible() error
- func (daemon *Daemon) Kill(container *container.Container) error
- func (daemon *Daemon) List() []*container.Container
- func (daemon *Daemon) LoadImage(inTar io.ReadCloser, outStream io.Writer, quiet bool) error
- func (daemon *Daemon) LogContainerEvent(container *container.Container, action string)
- func (daemon *Daemon) LogContainerEventWithAttributes(container *container.Container, action string, attributes map[string]string)
- func (daemon *Daemon) LogDaemonEventWithAttributes(action string, attributes map[string]string)
- func (daemon *Daemon) LogImageEvent(imageID, refName, action string)
- func (daemon *Daemon) LogImageEventWithAttributes(imageID, refName, action string, attributes map[string]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) LogPluginEvent(pluginID, refName, action string)
- func (daemon *Daemon) LogPluginEventWithAttributes(pluginID, refName, 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) MakeImageCache(sourceRefs []string) builder.ImageCache
- func (daemon *Daemon) Map() map[image.ID]*image.Image
- func (daemon *Daemon) Mount(container *container.Container) error
- func (daemon *Daemon) MountImage(name string) (string, func() error, error)
- func (daemon *Daemon) NetworkControllerEnabled() bool
- func (daemon *Daemon) NetworksPrune(pruneFilters filters.Args) (*types.NetworksPruneReport, error)
- func (daemon *Daemon) PluginGetter() *plugin.Store
- func (daemon *Daemon) PluginManager() *plugin.Manager
- func (daemon *Daemon) PullImage(ctx context.Context, image, tag string, metaHeaders map[string][]string, ...) error
- func (daemon *Daemon) PullOnBuild(ctx context.Context, name string, authConfigs map[string]types.AuthConfig, ...) (builder.Image, error)
- func (daemon *Daemon) PushImage(ctx context.Context, image, tag string, metaHeaders map[string][]string, ...) error
- func (daemon *Daemon) Register(c *container.Container)
- func (daemon *Daemon) ReleaseIngress() (<-chan struct{}, error)
- func (daemon *Daemon) Reload(conf *config.Config) (err error)
- func (daemon *Daemon) RestartSwarmContainers()
- func (daemon *Daemon) SearchRegistryForImages(ctx context.Context, filtersArgs string, term string, limit int, ...) (*registrytypes.SearchResults, error)
- func (daemon *Daemon) SetCluster(cluster Cluster)
- func (daemon *Daemon) SetContainerSecretReferences(name string, refs []*swarmtypes.SecretReference) error
- func (daemon *Daemon) SetContainerSecretStore(name string, store exec.SecretGetter) error
- func (daemon *Daemon) SetNetworkBootstrapKeys(keys []*networktypes.EncryptionKey) error
- func (daemon *Daemon) SetupIngress(create clustertypes.NetworkCreateRequest, nodeIP string) (<-chan struct{}, error)
- func (daemon *Daemon) Shutdown() error
- func (daemon *Daemon) ShutdownTimeout() int
- func (daemon *Daemon) SquashImage(id, parent string) (string, error)
- func (daemon *Daemon) Start(container *container.Container) error
- func (daemon *Daemon) StateChanged(id string, e libcontainerd.StateInfo) error
- func (daemon *Daemon) Subnets() ([]net.IPNet, []net.IPNet)
- func (daemon *Daemon) SubscribeToEvents(since, until time.Time, filter filters.Args) ([]events.Message, chan interface{})
- func (daemon *Daemon) SystemDiskUsage() (*types.DiskUsage, error)
- func (daemon *Daemon) SystemInfo() (*types.Info, error)
- func (daemon *Daemon) SystemVersion() types.Version
- func (daemon *Daemon) TagImage(imageName, repository, tag string) error
- func (daemon *Daemon) TagImageWithReference(imageID image.ID, newTag reference.Named) error
- func (daemon *Daemon) Unmount(container *container.Container) error
- func (daemon *Daemon) UnsubscribeFromEvents(listener chan interface{})
- func (daemon *Daemon) UpdateAttachment(networkName, networkID, containerID string, config *network.NetworkingConfig) error
- func (daemon *Daemon) UpdateContainerServiceConfig(containerName string, serviceConfig *clustertypes.ServiceConfig) error
- func (daemon *Daemon) VolumeCreate(name, driverName string, opts, labels map[string]string) (*types.Volume, error)
- func (daemon *Daemon) VolumeInspect(name string) (*types.Volume, error)
- func (daemon *Daemon) VolumeRm(name string, force bool) error
- func (daemon *Daemon) Volumes(filter string) ([]*types.Volume, []string, error)
- func (daemon *Daemon) VolumesPrune(pruneFilters filters.Args) (*types.VolumesPruneReport, error)
- func (daemon *Daemon) WaitForDetachment(ctx context.Context, networkName, networkID, taskID, containerID string) error
- type ErrImageDoesNotExist
- type NetworkManager
Constants ¶
This section is empty.
Variables ¶
var ( // DefaultRuntimeBinary is the default runtime to be used by // containerd if none is specified DefaultRuntimeBinary = "docker-runc" )
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 ¶
func CreateDaemonRoot ¶
CreateDaemonRoot creates the root for the daemon
func ModifyRootKeyLimit ¶
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 ¶
UsingSystemd returns true if cli option includes native.cgroupdriver=systemd
func VerifyCgroupDriver ¶
VerifyCgroupDriver validates native.cgroupdriver
Types ¶
type Cluster ¶
type Cluster interface { ClusterStatus NetworkManager }
Cluster is the interface for github.com/docker/docker/daemon/cluster.(*Cluster).
type ClusterStatus ¶
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 ¶
ActivateContainerServiceBinding puts this container into load balancer active rotation and DNS response
func (*Daemon) AuthenticateToRegistry ¶
func (daemon *Daemon) AuthenticateToRegistry(ctx context.Context, authConfig *types.AuthConfig) (string, string, error)
AuthenticateToRegistry checks the validity of credentials in authConfig
func (*Daemon) CheckpointCreate ¶
func (daemon *Daemon) CheckpointCreate(name string, config types.CheckpointCreateOptions) error
CheckpointCreate checkpoints the process running in a container with CRIU
func (*Daemon) CheckpointDelete ¶
func (daemon *Daemon) CheckpointDelete(name string, config types.CheckpointDeleteOptions) error
CheckpointDelete deletes the specified checkpoint
func (*Daemon) CheckpointList ¶
func (daemon *Daemon) CheckpointList(name string, config types.CheckpointListOptions) ([]types.Checkpoint, error)
CheckpointList lists all checkpoints of the specified container
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) ContainerAttach ¶
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 ¶
func (daemon *Daemon) ContainerAttachRaw(prefixOrName string, stdin io.ReadCloser, stdout, stderr io.Writer, doStream bool) error
ContainerAttachRaw attaches the provided streams to the container's stdio
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) (containertypes.ContainerCreateCreatedBody, error)
ContainerCreate creates a regular container
func (*Daemon) ContainerCreateWorkdir ¶
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 ¶
ContainerExecCreate sets up an exec in a running container.
func (*Daemon) ContainerExecInspect ¶
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 ¶
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(ctx context.Context, name string, stdin io.ReadCloser, 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 ¶
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, 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 ¶
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 ¶
ContainerInspectCurrent returns low-level information about a container in a most recent api version.
func (*Daemon) ContainerKill ¶
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 ¶
func (daemon *Daemon) ContainerLogs(ctx context.Context, containerName string, config *types.ContainerLogsOptions) (<-chan *backend.LogMessage, 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 ¶
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, checkpoint string, checkpointDir string) 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(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 ¶
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 ¶
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 ¶
ContainerUnpause unpauses a container
func (*Daemon) ContainerUpdate ¶
func (daemon *Daemon) ContainerUpdate(name string, hostConfig *container.HostConfig) (container.ContainerUpdateOKBody, error)
ContainerUpdate updates configuration of the container
func (*Daemon) ContainerUpdateCmdOnBuild ¶
ContainerUpdateCmdOnBuild updates Path and Args for the container with ID cID.
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) ContainerWaitWithContext ¶
ContainerWaitWithContext returns a channel where exit code is sent when container stops. Channel can be cancelled with a context.
func (*Daemon) Containers ¶
Containers returns the list of containers to show given the user's filtering.
func (*Daemon) ContainersPrune ¶
func (daemon *Daemon) ContainersPrune(pruneFilters filters.Args) (*types.ContainersPruneReport, error)
ContainersPrune removes unused containers
func (*Daemon) CopyOnBuild ¶
func (daemon *Daemon) CopyOnBuild(cID string, destPath string, src builder.FileInfo, decompress bool) error
CopyOnBuild copies/extracts a source FileInfo to a destination path inside a container specified by a container object. TODO: make sure callers don't unnecessarily convert destPath with filepath.FromSlash (Copy does it already). CopyOnBuild should take in abstract paths (with slashes) and the implementation should convert it to OS-specific paths.
func (*Daemon) CreateManagedContainer ¶
func (daemon *Daemon) CreateManagedContainer(params types.ContainerCreateConfig) (containertypes.ContainerCreateCreatedBody, error)
CreateManagedContainer creates a container that is managed by a Service
func (*Daemon) CreateManagedNetwork ¶
func (daemon *Daemon) CreateManagedNetwork(create clustertypes.NetworkCreateRequest) error
CreateManagedNetwork creates an agent network.
func (*Daemon) CreateNetwork ¶
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 ¶
DaemonJoinsCluster informs the daemon has joined the cluster and provides the handler to query the cluster component
func (*Daemon) DaemonLeavesCluster ¶
func (daemon *Daemon) DaemonLeavesCluster()
DaemonLeavesCluster informs the daemon has left the cluster
func (*Daemon) DeactivateContainerServiceBinding ¶
DeactivateContainerServiceBinding removes this container from load balancer active rotation, and DNS response
func (*Daemon) DeleteManagedNetwork ¶
DeleteManagedNetwork deletes an agent network.
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, 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 ¶
func (daemon *Daemon) DisconnectFromNetwork(container *container.Container, networkName string, force bool) error
DisconnectFromNetwork disconnects container from network n.
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) 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) FillPlatformInfo ¶
FillPlatformInfo fills the platform related info.
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 ¶
ForceEndpointDelete deletes an endpoint from a network forcefully
func (*Daemon) GetCluster ¶
GetCluster returns the cluster
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 ¶
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) GetImageOnBuild ¶
GetImageOnBuild looks up a Docker image referenced by `name`.
func (*Daemon) GetNetworkByID ¶
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 ¶
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 ¶
GetNetworkDriverList returns the list of plugins drivers registered for network.
func (*Daemon) GetNetworks ¶
func (daemon *Daemon) GetNetworks() []libnetwork.Network
GetNetworks returns a list of all networks
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) GetRepository ¶
func (daemon *Daemon) GetRepository(ctx context.Context, ref reference.NamedTagged, authConfig *types.AuthConfig) (dist.Repository, bool, error)
GetRepository returns a repository from the registry.
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) HasExperimental ¶
HasExperimental returns whether the experimental features of the daemon are enabled or not
func (*Daemon) ImageDelete ¶
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 ¶
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 ¶
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 ¶
ImagesPrune removes unused images
func (*Daemon) ImportImage ¶
func (daemon *Daemon) ImportImage(src string, repository, 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) IsShuttingDown ¶
IsShuttingDown tells whether the daemon is shutting down or not
func (*Daemon) IsSwarmCompatible ¶
IsSwarmCompatible verifies if the current daemon configuration is compatible with the swarm mode
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 with only the default attributes.
func (*Daemon) LogContainerEventWithAttributes ¶
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 ¶
LogDaemonEventWithAttributes generates an event related to the daemon itself with specific given attributes.
func (*Daemon) LogImageEvent ¶
LogImageEvent generates an event related to an image with only the default attributes.
func (*Daemon) LogImageEventWithAttributes ¶
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 ¶
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) LogPluginEvent ¶
LogPluginEvent generates an event related to a plugin with only the default attributes.
func (*Daemon) LogPluginEventWithAttributes ¶
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 ¶
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) MakeImageCache ¶
func (daemon *Daemon) MakeImageCache(sourceRefs []string) builder.ImageCache
MakeImageCache creates a stateful image cache.
func (*Daemon) MountImage ¶
MountImage returns mounted path with rootfs of an image.
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) NetworksPrune ¶
NetworksPrune removes unused networks
func (*Daemon) PluginGetter ¶
PluginGetter returns current pluginStore associated with the daemon
func (*Daemon) PluginManager ¶
PluginManager returns current pluginManager associated with the daemon
func (*Daemon) PullImage ¶
func (daemon *Daemon) PullImage(ctx context.Context, image, tag 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) PullOnBuild ¶
func (daemon *Daemon) PullOnBuild(ctx context.Context, name string, authConfigs map[string]types.AuthConfig, output io.Writer) (builder.Image, error)
PullOnBuild tells Docker to pull image referenced by `name`.
func (*Daemon) PushImage ¶
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) ReleaseIngress ¶
ReleaseIngress releases the ingress networking. The function returns a channel which will signal the caller when the programming is completed.
func (*Daemon) Reload ¶
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 ¶
func (daemon *Daemon) RestartSwarmContainers()
RestartSwarmContainers restarts any autostart container which has a swarm endpoint.
func (*Daemon) SearchRegistryForImages ¶
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 ¶
SetCluster sets the cluster
func (*Daemon) SetContainerSecretReferences ¶
func (daemon *Daemon) SetContainerSecretReferences(name string, refs []*swarmtypes.SecretReference) error
SetContainerSecretReferences sets the container secret references needed
func (*Daemon) SetContainerSecretStore ¶
func (daemon *Daemon) SetContainerSecretStore(name string, store exec.SecretGetter) error
SetContainerSecretStore sets the secret store backend for the container
func (*Daemon) SetNetworkBootstrapKeys ¶
func (daemon *Daemon) SetNetworkBootstrapKeys(keys []*networktypes.EncryptionKey) error
SetNetworkBootstrapKeys sets the bootstrap keys.
func (*Daemon) SetupIngress ¶
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) ShutdownTimeout ¶
ShutdownTimeout returns the shutdown timeout based on the max stopTimeout of the containers, and is limited by daemon's ShutdownTimeout.
func (*Daemon) SquashImage ¶
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 ¶
func (daemon *Daemon) StateChanged(id string, e libcontainerd.StateInfo) error
StateChanged updates daemon state changes from containerd
func (*Daemon) Subnets ¶
Subnets return the IPv4 and IPv6 subnets of networks that are manager by Docker.
func (*Daemon) SubscribeToEvents ¶
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 ¶
SystemDiskUsage returns information about the daemon data disk usage
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 the tag specified by newTag, pointing to the image named imageName (alternatively, imageName can also be an image ID).
func (*Daemon) TagImageWithReference ¶
TagImageWithReference adds the given reference to the image ID provided.
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) UpdateAttachment ¶
func (daemon *Daemon) UpdateAttachment(networkName, networkID, containerID string, config *network.NetworkingConfig) error
UpdateAttachment notifies the attacher about the attachment config.
func (*Daemon) UpdateContainerServiceConfig ¶
func (daemon *Daemon) UpdateContainerServiceConfig(containerName string, serviceConfig *clustertypes.ServiceConfig) error
UpdateContainerServiceConfig updates a service configuration.
func (*Daemon) VolumeCreate ¶
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 ¶
VolumeInspect looks up a volume by name. An error is returned if the volume cannot be found.
func (*Daemon) VolumeRm ¶
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 ¶
Volumes lists known volumes, using the filter to restrict the range of volumes returned.
func (*Daemon) VolumesPrune ¶
VolumesPrune removes unused local volumes
type ErrImageDoesNotExist ¶
type ErrImageDoesNotExist struct {
// contains filtered or unexported fields
}
ErrImageDoesNotExist is error returned when no image can be found for a reference.
func (ErrImageDoesNotExist) Error ¶
func (e ErrImageDoesNotExist) Error() string
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 ¶
- apparmor_default.go
- archive.go
- archive_tarcopyoptions.go
- archive_tarcopyoptions_unix.go
- archive_unix.go
- attach.go
- auth.go
- bindmount_unix.go
- cache.go
- changes.go
- checkpoint.go
- cluster.go
- commit.go
- container.go
- container_linux.go
- container_operations.go
- container_operations_unix.go
- create.go
- create_unix.go
- daemon.go
- daemon_experimental.go
- daemon_linux.go
- daemon_unix.go
- debugtrap.go
- debugtrap_unix.go
- delete.go
- disk_usage.go
- errors.go
- events.go
- exec.go
- exec_linux.go
- export.go
- getsize_unix.go
- health.go
- image.go
- image_delete.go
- image_exporter.go
- image_history.go
- image_inspect.go
- image_pull.go
- image_push.go
- image_tag.go
- images.go
- import.go
- info.go
- info_unix.go
- inspect.go
- inspect_unix.go
- keys.go
- kill.go
- links.go
- list.go
- list_unix.go
- logdrivers_linux.go
- logs.go
- metrics.go
- monitor.go
- monitor_linux.go
- mounts.go
- names.go
- network.go
- oci_linux.go
- pause.go
- prune.go
- reload.go
- rename.go
- resize.go
- restart.go
- search.go
- seccomp_disabled.go
- secrets.go
- secrets_linux.go
- selinux_linux.go
- start.go
- start_unix.go
- stats.go
- stats_collector.go
- stats_unix.go
- stop.go
- top_unix.go
- unpause.go
- update.go
- update_linux.go
- volumes.go
- volumes_unix.go
- wait.go
- workdir.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 |
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. |
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. |
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. |
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. |