The Moby Project - a collaborative project for the container ecosystem to assemble container-based systems
Find a file
John Howard 85ad4b16c1 Windows: Experimental: Allow containerd for runtime
Signed-off-by: John Howard <jhoward@microsoft.com>

This is the first step in refactoring moby (dockerd) to use containerd on Windows.
Similar to the current model in Linux, this adds the option to enable it for runtime.
It does not switch the graphdriver to containerd snapshotters.

 - Refactors libcontainerd to a series of subpackages so that either a
  "local" containerd (1) or a "remote" (2) containerd can be loaded as opposed
  to conditional compile as "local" for Windows and "remote" for Linux.

 - Updates libcontainerd such that Windows has an option to allow the use of a
   "remote" containerd. Here, it communicates over a named pipe using GRPC.
   This is currently guarded behind the experimental flag, an environment variable,
   and the providing of a pipename to connect to containerd.

 - Infrastructure pieces such as under pkg/system to have helper functions for
   determining whether containerd is being used.

(1) "local" containerd is what the daemon on Windows has used since inception.
It's not really containerd at all - it's simply local invocation of HCS APIs
directly in-process from the daemon through the Microsoft/hcsshim library.

(2) "remote" containerd is what docker on Linux uses for it's runtime. It means
that there is a separate containerd service running, and docker communicates over
GRPC to it.

To try this out, you will need to start with something like the following:

Window 1:
	containerd --log-level debug

Window 2:
	$env:DOCKER_WINDOWS_CONTAINERD=1
	dockerd --experimental -D --containerd \\.\pipe\containerd-containerd

You will need the following binary from github.com/containerd/containerd in your path:
 - containerd.exe

You will need the following binaries from github.com/Microsoft/hcsshim in your path:
 - runhcs.exe
 - containerd-shim-runhcs-v1.exe

For LCOW, it will require and initrd.img and kernel in `C:\Program Files\Linux Containers`.
This is no different to the current requirements. However, you may need updated binaries,
particularly initrd.img built from Microsoft/opengcs as (at the time of writing), Linuxkit
binaries are somewhat out of date.

Note that containerd and hcsshim for HCS v2 APIs do not yet support all the required
functionality needed for docker. This will come in time - this is a baby (although large)
step to migrating Docker on Windows to containerd.

Note that the HCS v2 APIs are only called on RS5+ builds. RS1..RS4 will still use
HCS v1 APIs as the v2 APIs were not fully developed enough on these builds to be usable.
This abstraction is done in HCSShim. (Referring specifically to runtime)

Note the LCOW graphdriver still uses HCS v1 APIs regardless.

Note also that this does not migrate docker to use containerd snapshotters
rather than graphdrivers. This needs to be done in conjunction with Linux also
doing the same switch.
2019-03-12 18:41:55 -07:00
.github Remove myself from codeowners 😅 2019-01-10 17:32:26 +01:00
api Add new PidsLimit options to API version history 2019-02-24 14:27:30 +01:00
builder Convert parse errors to more informative format 2019-01-14 20:01:00 -06:00
cli allow running dockerd in an unprivileged user namespace (rootless mode) 2019-02-04 00:24:27 +09:00
client Add HEAD support for /_ping endpoint 2019-01-31 18:18:24 +01:00
cmd/dockerd Windows: Experimental: Allow containerd for runtime 2019-03-12 18:41:55 -07:00
container Add pids-limit support in docker update 2019-02-21 14:17:38 -08:00
contrib allow running dockerd in an unprivileged user namespace (rootless mode) 2019-02-04 00:24:27 +09:00
daemon Windows: Experimental: Allow containerd for runtime 2019-03-12 18:41:55 -07:00
distribution Update containerd client to 1.2.4 2019-02-14 04:47:27 +01:00
dockerversion Remove version-checks for containerd and runc 2018-10-04 23:17:13 +02:00
docs Add new PidsLimit options to API version history 2019-02-24 14:27:30 +01:00
errdefs Make errdefs helpers idempotent 2019-01-03 11:16:01 +01:00
hack fix hack/dockerfile/install/containerd.installer test statement 2019-02-26 18:19:04 +08:00
image delete unnecessary blank lines 2018-12-11 09:07:37 +08:00
integration Merge pull request #38428 from thaJeztah/only_create_new_daemon_if_needed 2019-02-25 22:20:05 -08:00
integration-cli Windows:Disable 2 restart test when Hyper-V 2019-02-22 11:15:51 -08:00
internal Testing: create new daemon (only) if needed 2019-02-23 13:32:59 +01:00
layer layer/layer_store: ensure NewInputTarStream resources are released 2018-12-21 09:30:09 +01:00
libcontainerd Windows: Experimental: Allow containerd for runtime 2019-03-12 18:41:55 -07:00
oci Capabilities refactor 2019-01-22 21:50:41 +02:00
opts allow running dockerd in an unprivileged user namespace (rootless mode) 2019-02-04 00:24:27 +09:00
pkg Windows: Experimental: Allow containerd for runtime 2019-03-12 18:41:55 -07:00
plugin Windows: Experimental: Allow containerd for runtime 2019-03-12 18:41:55 -07:00
profiles seccomp: review update 2019-02-05 12:02:41 -08:00
project REVIEWING.md: Fix status 4 merge label 2019-01-23 02:23:30 +01:00
reference Merge pull request #37781 from mtrmac/reference-race-upstream 2018-10-18 12:35:57 -07:00
registry registry: use len(via)!=0 instead of via!=nil 2018-12-11 16:37:16 +03:00
reports Fix typos 2018-05-16 09:15:43 +08:00
restartmanager Add canonical import comment 2018-02-05 16:51:57 -05:00
rootless allow running dockerd in an unprivileged user namespace (rootless mode) 2019-02-04 00:24:27 +09:00
runconfig Format code with gofmt -s from go-1.11beta1 2018-09-06 15:24:16 -07:00
vendor Vendor sirupsen/logrus@v1.3.0 2019-03-12 18:41:55 -07:00
volume Use assert.NilError() instead of assert.Assert() 2019-01-21 13:16:02 +01:00
.DEREK.yml .DEREK.yml: add myself 2019-01-10 16:40:29 -08:00
.dockerignore [EXPERIMENTAL] Integration Test on Swarm 2017-02-28 02:10:09 +00:00
.gitignore Add code coverage report and codecov config 2018-01-16 16:50:56 -05:00
.mailmap Update authors and mailmap 2018-09-07 23:43:34 +08:00
AUTHORS Update authors and mailmap 2018-09-07 23:43:34 +08:00
CHANGELOG.md Fix some typos 2018-09-07 13:13:47 +08:00
codecov.yml Add code coverage report and codecov config 2018-01-16 16:50:56 -05:00
CONTRIBUTING.md Fix link anchors in CONTRIBUTING.md 2018-06-13 21:58:48 +09:00
Dockerfile hack: restore bundling vpnkit on amd64 2019-02-05 18:21:30 -08:00
Dockerfile.e2e Bump Golang 1.11.5 (CVE-2019-6486) 2019-01-24 00:49:27 +01:00
Dockerfile.simple Bump Golang 1.11.5 (CVE-2019-6486) 2019-01-24 00:49:27 +01:00
Dockerfile.windows Bump Golang 1.11.5 (CVE-2019-6486) 2019-01-24 00:49:27 +01:00
LICENSE Update LICENSE 2018-09-12 14:27:53 +01:00
MAINTAINERS Remove "docs maintainers" section 2019-01-23 16:58:58 +01:00
Makefile hack: no need to git fetch in CI 2019-02-05 02:54:50 +00:00
NOTICE Update LICENSE date 2017-02-15 17:34:33 +01:00
poule.yml Poule:Add Windows RS5 2018-10-08 15:38:27 -07:00
README.md Add "Lego set" back in README.md 2017-10-10 14:10:39 +00:00
ROADMAP.md Fix some typos in ROADMAP.md 2019-01-25 14:27:13 +08:00
TESTING.md Merge pull request #37249 from AntaresS/add-test-guidline 2018-06-25 20:44:42 +02:00
vendor.conf Vendor sirupsen/logrus@v1.3.0 2019-03-12 18:41:55 -07:00
VENDORING.md fix the bare url and the Summary of http://semver.org 2017-01-17 16:20:11 +08:00

The Moby Project

Moby Project logo

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 system, 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, and are not intended for customers who want enterprise or commercial support; Docker EE is the appropriate product 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.