README
¶
Docker CE
⚠ This repository is now deprecated and will be archived (Docker CE itself is NOT deprecated) ⚠
Starting with the Docker 20.10 release, packages for the Docker Engine and Docker CLI are built directly from their respective source repositories instead of from this repository.
Practically this means:
- This repository is no longer the “source of truth” for Docker CE builds.
- The commit SHA and tag for Docker CLI build will come from the docker/cli repository and the commit SHA and tag for the Docker Engine will come from the moby/moby repository.
- Release branches for the Engine, CLI, and packaging will be maintained on their respective repositories.
- Updates will stop being made to this repository and it will be archived in the future.
- Changelog is now Release Notes.
- The
masterbranch of this repository will be emptied when the repository is archived.
Description
This repository hosts open source components of Docker CE products. The
master branch serves to unify the upstream components on a regular
basis. Long-lived release branches host the code that goes into a product
version for the lifetime of the product.
This repository is solely maintained by Docker, Inc.
Issues
There are separate issue-tracking repos for the end user Docker CE products specialized for a platform. Find your issue or file a new issue for the platform you are using:
- https://github.com/docker/for-linux
- https://github.com/docker/for-mac
- https://github.com/docker/for-win
Submitting pull requests
This repository does not accept PRs for files under the components directory directly. To contribute to the files under the components directory, see CONTRIBUTING.md .
Unifying upstream sources
The master branch is a combination of components adapted from
different upstream git repos into a unified directory structure using the
moby-components
tool.
You can view the upstream git repos in the components.conf file. Each component is isolated into its own directory under the components directory.
The tool will import each component git history within the appropriate path.
For example, this shows a commit
is imported into the component engine from
moby/moby@a27b4b8
into the components/engine directory.
commit 5c70746915d4589a692cbe50a43cf619ed0b7152
Author: Andrea Luzzardi <aluzzardi@gmail.com>
Date: Sat Jan 19 00:13:39 2013
Initial commit
Upstream-commit: a27b4b8cb8e838d03a99b6d2b30f76bdaf2f9e5d
Component: engine
components/engine/container.go | 203 ++++++++++++++++++++++++++++...
components/engine/container_test.go | 186 ++++++++++++++++++++++++++++...
components/engine/docker.go | 112 ++++++++++++++++++++++++++++...
components/engine/docker_test.go | 175 ++++++++++++++++++++++++++++...
components/engine/filesystem.go | 52 ++++++++++++++++++++++++++++...
components/engine/filesystem_test.go | 35 +++++++++++++++++++++++++++
components/engine/lxc_template.go | 94 ++++++++++++++++++++++++++++...
components/engine/state.go | 48 ++++++++++++++++++++++++++++...
components/engine/utils.go | 115 ++++++++++++++++++++++++++++...
components/engine/utils_test.go | 126 ++++++++++++++++++++++++++++...
10 files changed, 1146 insertions(+)
Updates to master branch
Main development of new features should be directed towards the upstream
git repos. The master branch of this repo will periodically pull in new
changes from upstream to provide a point for integration.
Branching for release
When a release is started for Docker CE, a new branch will be created
from master. Branch names will be YY.MM to represent the time-based
release version of the product, e.g. 17.06.
Adding fixes to release branch
Note: every commit of a fix should affect files only within one component directory.
Fix available upstream
A PR cherry-picking the necessary commits should be created against the release branch. If the the cherry-pick cannot be applied cleanly, the logic of the fix should be ported manually.
No fix yet
First create the PR with the fix for the release branch. Once the fix has been merged, be sure to port the fix to the respective upstream git repo.
Release tags
There will be a git tag for each release candidate (RC) and general availability (GA) release. The tag will only point to commits on release branches.
Directories
¶
| Path | Synopsis |
|---|---|
|
components
|
|
|
cli/cli/connhelper
Package connhelper provides helpers for connecting to a remote daemon host with custom logic.
|
Package connhelper provides helpers for connecting to a remote daemon host with custom logic. |
|
cli/cli/connhelper/commandconn
Package commandconn provides a net.Conn implementation that can be used for proxying (or emulating) stream via a custom command.
|
Package commandconn provides a net.Conn implementation that can be used for proxying (or emulating) stream via a custom command. |
|
cli/cli/connhelper/ssh
Package ssh provides the connection helper for ssh:// URL.
|
Package ssh provides the connection helper for ssh:// URL. |
|
cli/cli/context/store
Package store provides a generic way to store credentials to connect to virtually any kind of remote system.
|
Package store provides a generic way to store credentials to connect to virtually any kind of remote system. |
|
cli/cli/winresources
Package winresources is used to embed Windows resources into docker.exe.
|
Package winresources is used to embed Windows resources into docker.exe. |
|
cli/internal/test
Package test is a test-only package that can be used by other cli package to write unit test.
|
Package test is a test-only package that can be used by other cli package to write unit test. |
|
cli/internal/test/builders
Package builders helps you create struct for your unit test while keeping them expressive.
|
Package builders helps you create struct for your unit test while keeping them expressive. |
|
cli/kubernetes/compose
Package compose is the internal version of the API.
|
Package compose is the internal version of the API. |
|
cli/kubernetes/compose/v1beta1
Package v1beta1 is the first version of the Stack spec, containing only a compose file
|
Package v1beta1 is the first version of the Stack spec, containing only a compose file |
|
cli/kubernetes/compose/v1beta2
Package v1beta2 is the second version of the stack, containing a structured spec
|
Package v1beta2 is the second version of the stack, containing a structured spec |
|
cli/service/logs
Package logs contains tools for parsing docker log lines.
|
Package logs contains tools for parsing docker log lines. |
|
engine/api/types
Package types is used for API stability in the types and response to the consumers of the API stats endpoint.
|
Package types is used for API stability in the types and response to the consumers of the API stats endpoint. |
|
engine/api/types/backend
Package backend includes types to send information to server backends.
|
Package backend includes types to send information to server backends. |
|
engine/api/types/filters
Package filters provides tools for encoding a mapping of keys to a set of multiple values.
|
Package filters provides tools for encoding a mapping of keys to a set of multiple values. |
|
engine/api/types/plugins/logdriver
Package logdriver is a generated protocol buffer package.
|
Package logdriver is a generated protocol buffer package. |
|
engine/api/types/swarm/runtime
Package runtime is a generated protocol buffer package.
|
Package runtime is a generated protocol buffer package. |
|
engine/api/types/versions/v1p19
Package v1p19 provides specific API types for the API version 1, patch 19.
|
Package v1p19 provides specific API types for the API version 1, patch 19. |
|
engine/api/types/versions/v1p20
Package v1p20 provides specific API types for the API version 1, patch 20.
|
Package v1p20 provides specific API types for the API version 1, patch 20. |
|
engine/builder
Package builder defines interfaces for any Docker builder to implement.
|
Package builder defines interfaces for any Docker builder to implement. |
|
engine/builder/dockerfile
Package dockerfile is the evaluation step in the Dockerfile parse/evaluate pipeline.
|
Package dockerfile is the evaluation step in the Dockerfile parse/evaluate pipeline. |
|
engine/builder/dockerignore
Package dockerignore is deprecated.
|
Package dockerignore is deprecated. |
|
engine/builder/remotecontext
Package remotecontext is a generated protocol buffer package.
|
Package remotecontext is a generated protocol buffer package. |
|
engine/client
Package client is a Go client for the Docker Engine API.
|
Package client is a Go client for the Docker Engine API. |
|
engine/cmd/docker-proxy
docker-proxy provides a network Proxy interface and implementations for TCP and UDP.
|
docker-proxy provides a network Proxy interface and implementations for TCP and UDP. |
|
engine/daemon
Package daemon exposes the functions that occur on the host server that the Docker daemon is running.
|
Package daemon exposes the functions that occur on the host server that the Docker daemon is running. |
|
engine/daemon/logger
Package logger defines interfaces that logger drivers implement to log messages.
|
Package logger defines interfaces that logger drivers implement to log messages. |
|
engine/daemon/logger/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 |
|
engine/daemon/logger/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". |
|
engine/daemon/logger/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. |
|
engine/daemon/logger/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. |
|
engine/daemon/logger/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. |
|
engine/daemon/logger/jsonfilelog
Package jsonfilelog provides the default Logger implementation for Docker logging.
|
Package jsonfilelog provides the default Logger implementation for Docker logging. |
|
engine/daemon/logger/local
Package local provides a logger implementation that stores logs on disk.
|
Package local provides a logger implementation that stores logs on disk. |
|
engine/daemon/logger/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. |
|
engine/daemon/logger/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. |
|
engine/daemon/logger/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. |
|
engine/dockerversion
Package dockerversion is auto-generated at build-time
|
Package dockerversion is auto-generated at build-time |
|
engine/errdefs
Package errdefs defines a set of error interfaces that packages should use for communicating classes of errors.
|
Package errdefs defines a set of error interfaces that packages should use for communicating classes of errors. |
|
engine/integration
Package integration provides integrations tests for Moby (API).
|
Package integration provides integrations tests for Moby (API). |
|
engine/integration-cli/checker
Package checker provides helpers for gotest.tools/assert.
|
Package checker provides helpers for gotest.tools/assert. |
|
engine/internal/test/suite
Package suite is a simplified version of testify's suite package which has unnecessary dependencies.
|
Package suite is a simplified version of testify's suite package which has unnecessary dependencies. |
|
engine/layer
Package layer is package for managing read-only and read-write mounts on the union file system driver.
|
Package layer is package for managing read-only and read-write mounts on the union file system driver. |
|
engine/libnetwork
Package libnetwork is a generated protocol buffer package.
|
Package libnetwork is a generated protocol buffer package. |
|
engine/libnetwork/bitseq
Package bitseq provides a structure and utilities for representing long bitmask as sequence of run-length encoded blocks.
|
Package bitseq provides a structure and utilities for representing long bitmask as sequence of run-length encoded blocks. |
|
engine/libnetwork/drivers/overlay
Package overlay is a generated protocol buffer package.
|
Package overlay is a generated protocol buffer package. |
|
engine/libnetwork/drivers/overlay/overlayutils
Package overlayutils provides utility functions for overlay networks
|
Package overlayutils provides utility functions for overlay networks |
|
engine/libnetwork/drivers/remote/api
Package api represents all requests and responses suitable for conversation with a remote driver.
|
Package api represents all requests and responses suitable for conversation with a remote driver. |
|
engine/libnetwork/drivers/windows/overlay
Package overlay is a generated protocol buffer package.
|
Package overlay is a generated protocol buffer package. |
|
engine/libnetwork/idm
Package idm manages reservation/release of numerical ids from a configured set of contiguous ids
|
Package idm manages reservation/release of numerical ids from a configured set of contiguous ids |
|
engine/libnetwork/ipamapi
Package ipamapi specifies the contract the IPAM service (built-in or remote) needs to satisfy.
|
Package ipamapi specifies the contract the IPAM service (built-in or remote) needs to satisfy. |
|
engine/libnetwork/ipams/null
Package null implements the null ipam driver.
|
Package null implements the null ipam driver. |
|
engine/libnetwork/ipams/remote/api
Package api defines the data structure to be used in the request/response messages between libnetwork and the remote ipam plugin
|
Package api defines the data structure to be used in the request/response messages between libnetwork and the remote ipam plugin |
|
engine/libnetwork/ipamutils
Package ipamutils provides utility functions for ipam management
|
Package ipamutils provides utility functions for ipam management |
|
engine/libnetwork/networkdb
Package networkdb is a generated protocol buffer package.
|
Package networkdb is a generated protocol buffer package. |
|
engine/libnetwork/options
Package options provides a way to pass unstructured sets of options to a component expecting a strongly-typed configuration structure.
|
Package options provides a way to pass unstructured sets of options to a component expecting a strongly-typed configuration structure. |
|
engine/libnetwork/osl
Package osl describes structures and interfaces which abstract os entities
|
Package osl describes structures and interfaces which abstract os entities |
|
engine/libnetwork/resolvconf
Package resolvconf provides utility code to query and update DNS configuration in /etc/resolv.conf
|
Package resolvconf provides utility code to query and update DNS configuration in /etc/resolv.conf |
|
engine/libnetwork/types
Package types contains types that are common across libnetwork project
|
Package types contains types that are common across libnetwork project |
|
engine/pkg/aaparser
Package aaparser is a convenience package interacting with `apparmor_parser`.
|
Package aaparser is a convenience package interacting with `apparmor_parser`. |
|
engine/pkg/capabilities
Package capabilities allows to generically handle capabilities.
|
Package capabilities allows to generically handle capabilities. |
|
engine/pkg/filenotify
Package filenotify provides a mechanism for watching file(s) for changes.
|
Package filenotify provides a mechanism for watching file(s) for changes. |
|
engine/pkg/locker
Package locker provides a mechanism for creating finer-grained locking to help free up more global locks to handle other tasks.
|
Package locker provides a mechanism for creating finer-grained locking to help free up more global locks to handle other tasks. |
|
engine/pkg/parsers
Package parsers provides helper functions to parse and validate different type of string.
|
Package parsers provides helper functions to parse and validate different type of string. |
|
engine/pkg/parsers/kernel
Package kernel provides helper function to get, parse and compare kernel versions for different platforms.
|
Package kernel provides helper function to get, parse and compare kernel versions for different platforms. |
|
engine/pkg/parsers/operatingsystem
Package operatingsystem provides helper function to get the operating system name for different platforms.
|
Package operatingsystem provides helper function to get the operating system name for different platforms. |
|
engine/pkg/pidfile
Package pidfile provides structure and helper functions to create and remove PID file.
|
Package pidfile provides structure and helper functions to create and remove PID file. |
|
engine/pkg/platform
Package platform provides helper function to get the runtime architecture for different platforms.
|
Package platform provides helper function to get the runtime architecture for different platforms. |
|
engine/pkg/plugins
Package plugins provides structures and helper functions to manage Docker plugins.
|
Package plugins provides structures and helper functions to manage Docker plugins. |
|
engine/pkg/pools
Package pools provides a collection of pools which provide various data types with buffers.
|
Package pools provides a collection of pools which provide various data types with buffers. |
|
engine/pkg/signal
Package signal provides helper functions for dealing with signals across various operating systems.
|
Package signal provides helper functions for dealing with signals across various operating systems. |
|
engine/pkg/streamformatter
Package streamformatter provides helper functions to format a stream.
|
Package streamformatter provides helper functions to format a stream. |
|
engine/pkg/stringid
Package stringid provides helper functions for dealing with string identifiers
|
Package stringid provides helper functions for dealing with string identifiers |
|
engine/pkg/tailfile
Package tailfile provides helper functions to read the nth lines of any ReadSeeker.
|
Package tailfile provides helper functions to read the nth lines of any ReadSeeker. |
|
engine/pkg/tarsum
Package tarsum provides algorithms to perform checksum calculation on filesystem layers.
|
Package tarsum provides algorithms to perform checksum calculation on filesystem layers. |
|
engine/pkg/term
Package term provides structures and helper functions to work with terminal (state, sizes).
|
Package term provides structures and helper functions to work with terminal (state, sizes). |
|
engine/pkg/term/windows
Package windowsconsole implements ANSI-aware input and output streams for use by the Docker Windows client.
|
Package windowsconsole implements ANSI-aware input and output streams for use by the Docker Windows client. |
|
engine/pkg/truncindex
Package truncindex provides a general 'index tree', used by Docker in order to be able to reference containers by only a few unambiguous characters of their id.
|
Package truncindex provides a general 'index tree', used by Docker in order to be able to reference containers by only a few unambiguous characters of their id. |
|
engine/pkg/urlutil
Package urlutil provides helper function to check urls kind.
|
Package urlutil provides helper function to check urls kind. |
|
engine/pkg/useragent
Package useragent provides helper functions to pack version information into a single User-Agent header.
|
Package useragent provides helper functions to pack version information into a single User-Agent header. |
|
engine/registry
Package registry contains client primitives to interact with a remote Docker registry.
|
Package registry contains client primitives to interact with a remote Docker registry. |
|
engine/testutil
Package testutil contains common testing tasks like running dockerd.
|
Package testutil contains common testing tasks like running dockerd. |
|
engine/testutil/daemon
Package daemon launches dockerd for testing purposes.
|
Package daemon launches dockerd for testing purposes. |
|
engine/volume/local
Package local provides the default implementation for volumes.
|
Package local provides the default implementation for volumes. |
Click to show internal directories.
Click to hide internal directories.