README
¶
The Moby Project
Moby is an open-source project created by Docker to enable and accelerate software containerization.
It provides a "Lego set" of toolkit components, the framework for assembling them into custom container-based systems, and a place for all container enthusiasts and professionals to experiment and exchange ideas. Components include container build tools, a container registry, orchestration tools, a runtime and more, and these can be used as building blocks in conjunction with other tools and projects.
Principles
Moby is an open project guided by strong principles, aiming to be modular, flexible and without too strong an opinion on user experience. It is open to the community to help set its direction.
- Modular: the project includes lots of components that have well-defined functions and APIs that work together.
- Batteries included but swappable: Moby includes enough components to build fully featured container systems, but its modular architecture ensures that most of the components can be swapped by different implementations.
- Usable security: Moby provides secure defaults without compromising usability.
- Developer focused: The APIs are intended to be functional and useful to build powerful tools. They are not necessarily intended as end user tools but as components aimed at developers. Documentation and UX is aimed at developers not end users.
Audience
The Moby Project is intended for engineers, integrators and enthusiasts looking to modify, hack, fix, experiment, invent and build systems based on containers. It is not for people looking for a commercially supported system, but for people who want to work and learn with open source code.
Relationship with Docker
The components and tools in the Moby Project are initially the open source components that Docker and the community have built for the Docker Project. New projects can be added if they fit with the community goals. Docker is committed to using Moby as the upstream for the Docker Product. However, other projects are also encouraged to use Moby as an upstream, and to reuse the components in diverse ways, and all these uses will be treated in the same way. External maintainers and contributors are welcomed.
The Moby project is not intended as a location for support or feature requests for Docker products, but as a place for contributors to work on open source code, fix bugs, and make the code more useful. The releases are supported by the maintainers, community and users, on a best efforts basis only. For customers who want enterprise or commercial support, Docker Desktop and Mirantis Container Runtime are the appropriate products for these use cases.
Legal
Brought to you courtesy of our legal counsel. For more context, please see the NOTICE document in this repo.
Use and transfer of Moby may be subject to certain restrictions by the United States and other governments.
It is your responsibility to ensure that your use and/or transfer does not violate applicable laws.
For more information, please see https://www.bis.doc.gov
Licensing
Moby is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.
Directories
¶
| Path | Synopsis |
|---|---|
|
types/backend
Package backend includes types to send information to server backends.
|
Package backend includes types to send information to server backends. |
|
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. |
|
Package builder defines interfaces for any Docker builder to implement.
|
Package builder defines interfaces for any Docker builder to implement. |
|
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. |
|
remotecontext/urlutil
Package urlutil provides helper function to check if a given build-context location should be considered a URL or a remote Git repository.
|
Package urlutil provides helper function to check if a given build-context location should be considered a URL or a remote Git repository. |
|
cli
|
|
|
winresources/docker-proxy
Package winresources is used to embed Windows resources into docker-proxy.exe.
|
Package winresources is used to embed Windows resources into docker-proxy.exe. |
|
winresources/dockerd
Package winresources is used to embed Windows resources into dockerd.exe.
|
Package winresources is used to embed Windows resources into dockerd.exe. |
|
Package client is a Go client for the Docker Engine API.
|
Package client is a Go client for the Docker Engine API. |
|
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. |
|
contrib
|
|
|
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. |
|
internal/capabilities
Package capabilities allows to generically handle capabilities.
|
Package capabilities allows to generically handle capabilities. |
|
logger
Package logger defines interfaces that logger drivers implement to log messages.
|
Package logger defines interfaces that logger drivers implement to log messages. |
|
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 |
|
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". |
|
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. |
|
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. |
|
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. |
|
logger/journald/internal/export
Package export implements a serializer for the systemd Journal Export Format as documented at https://systemd.io/JOURNAL_EXPORT_FORMATS/
|
Package export implements a serializer for the systemd Journal Export Format as documented at https://systemd.io/JOURNAL_EXPORT_FORMATS/ |
|
logger/journald/internal/fake
Package fake implements a journal writer for testing which is decoupled from the system's journald.
|
Package fake implements a journal writer for testing which is decoupled from the system's journald. |
|
logger/journald/internal/sdjournal
Package sdjournal provides a Go interface to the systemd journal read API by wrapping the libsystemd C library.
|
Package sdjournal provides a Go interface to the systemd journal read API by wrapping the libsystemd C library. |
|
logger/jsonfilelog
Package jsonfilelog provides the default Logger implementation for Docker logging.
|
Package jsonfilelog provides the default Logger implementation for Docker logging. |
|
logger/local
Package local provides a logger implementation that stores logs on disk.
|
Package local provides a logger implementation that stores logs on disk. |
|
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. |
|
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. |
|
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. |
|
spec/specs-go
Package v1 is deprecated and moved to github.com/moby/docker-image-spec/specs-go
|
Package v1 is deprecated and moved to github.com/moby/docker-image-spec/specs-go |
|
spec/specs-go/v1
Package v1 is deprecated and moved to github.com/moby/docker-image-spec/specs-go/v1
|
Package v1 is deprecated and moved to github.com/moby/docker-image-spec/specs-go/v1 |
|
Package integration provides integrations tests for Moby (API).
|
Package integration provides integrations tests for Moby (API). |
|
integration-cli
|
|
|
checker
Package checker provides helpers for gotest.tools/assert.
|
Package checker provides helpers for gotest.tools/assert. |
|
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. |
|
unix_noeintr
Wrappers for unix syscalls that retry on EINTR TODO: Consider moving (for example to moby/sys) and making the wrappers auto-generated.
|
Wrappers for unix syscalls that retry on EINTR TODO: Consider moving (for example to moby/sys) and making the wrappers auto-generated. |
|
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. |
|
Package libnetwork provides the basic functionality and extension points to create network namespaces and allocate interfaces for containers to use.
|
Package libnetwork provides the basic functionality and extension points to create network namespaces and allocate interfaces for containers to use. |
|
bitmap
Package bitmap provides a datatype for long vectors of bits.
|
Package bitmap provides a datatype for long vectors of bits. |
|
drivers/overlay/overlayutils
Package overlayutils provides utility functions for overlay networks
|
Package overlayutils provides utility functions for overlay networks |
|
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. |
|
drivers/windows/overlay
Package overlay is a generated protocol buffer package.
|
Package overlay is a generated protocol buffer package. |
|
internal/resolvconf
Package resolvconf is used to generate a container's /etc/resolv.conf file.
|
Package resolvconf is used to generate a container's /etc/resolv.conf file. |
|
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. |
|
ipams/null
Package null implements the null ipam driver.
|
Package null implements the null ipam driver. |
|
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 |
|
ipamutils
Package ipamutils provides utility functions for ipam management
|
Package ipamutils provides utility functions for ipam management |
|
ipbits
Package ipbits contains utilities for manipulating [netip.Addr] values as numbers or bitfields.
|
Package ipbits contains utilities for manipulating [netip.Addr] values as numbers or bitfields. |
|
netutils
Package netutils provides network utility functions.
|
Package netutils provides network utility functions. |
|
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. |
|
osl
Package osl describes structures and interfaces which abstract os entities
|
Package osl describes structures and interfaces which abstract os entities |
|
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 |
|
types
Package types contains types that are common across libnetwork project
|
Package types contains types that are common across libnetwork project |
|
pkg
|
|
|
archive
Package archive provides helper functions for dealing with archive files.
|
Package archive provides helper functions for dealing with archive files. |
|
longpath
Package longpath introduces some constants and helper functions for handling long paths in Windows.
|
Package longpath introduces some constants and helper functions for handling long paths in Windows. |
|
meminfo
Package meminfo provides utilites to retrieve memory statistics of the host system.
|
Package meminfo provides utilites to retrieve memory statistics of the host system. |
|
namesgenerator
Package namesgenerator generates random names.
|
Package namesgenerator generates random names. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
plugins
Package plugins provides structures and helper functions to manage Docker plugins.
|
Package plugins provides structures and helper functions to manage Docker plugins. |
|
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. |
|
process
Package process provides a set of basic functions to manage individual processes.
|
Package process provides a set of basic functions to manage individual processes. |
|
reexec
Package reexec facilitates the busybox style reexec of a binary.
|
Package reexec facilitates the busybox style reexec of a binary. |
|
streamformatter
Package streamformatter provides helper functions to format a stream.
|
Package streamformatter provides helper functions to format a stream. |
|
stringid
Package stringid provides helper functions for dealing with string identifiers
|
Package stringid provides helper functions for dealing with string identifiers |
|
sysinfo
Package sysinfo stores information about which features a kernel supports.
|
Package sysinfo stores information about which features a kernel supports. |
|
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. |
|
tarsum
Package tarsum provides algorithms to perform checksum calculation on filesystem layers.
|
Package tarsum provides algorithms to perform checksum calculation on filesystem layers. |
|
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. |
|
profiles
|
|
|
Package registry contains client primitives to interact with a remote Docker registry.
|
Package registry contains client primitives to interact with a remote Docker registry. |
|
Package testutil contains common testing tasks like running dockerd.
|
Package testutil contains common testing tasks like running dockerd. |
|
daemon
Package daemon launches dockerd for testing purposes.
|
Package daemon launches dockerd for testing purposes. |
|
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.