The Moby Project - a collaborative project for the container ecosystem to assemble container-based systems
Find a file
Sebastiaan van Stijn 9b2f55bc1c
update containerd binary to v1.5.0
Welcome to the v1.5.0 release of containerd!

The sixth major release of containerd includes many stability improvements
and code organization changes to make contribution easier and make future
features cleaner to develop. This includes bringing CRI development into the
main containerd repository and switching to Go modules. This release also
brings support for the Node Resource Interface (NRI).

Highlights
--------------------------------------------------------------------------------

*Project Organization*

- Merge containerd/cri codebase into containerd/containerd
- Move to Go modules
- Remove selinux build tag
- Add json log format output option for daemon log

*Snapshots*

- Add configurable overlayfs path
- Separate overlay implementation from plugin
- Native snapshotter configuration and plugin separation
- Devmapper snapshotter configuration and plugin separation
- AUFS snapshotter configuration and plugin separation
- ZFS snapshotter configuration and plugin separation
- Pass custom snapshot labels when creating snapshot
- Add platform check for snapshotter support when unpacking
- Handle loopback mounts
- Support userxattr mount option for overlay in user namespace
- ZFS snapshotter implementation of usage

*Distribution*

- Improve registry response errors
- Improve image pull performance over HTTP 1.1
- Registry configuration package
- Add support for layers compressed with zstd
- Allow arm64 to fallback to arm (v8, v7, v6, v5)

*Runtime*

- Add annotations to containerd task update API
- Add logging binary support when terminal is true
- Runtime support on FreeBSD

*Windows*

- Implement windowsDiff.Compare to allow outputting OCI images
- Optimize WCOW snapshotter to commit writable layers as read-only parent layers
- Optimize LCOW snapshotter use of scratch layers

*CRI*

- Add NRI injection points cri#1552
- Add support for registry host directory configuration
- Update privileged containers to use current capabilities instead of known capabilities
- Add pod annotations to CNI call
- Enable ocicrypt by default
- Support PID NamespaceMode_TARGET

Impactful Client Updates
--------------------------------------------------------------------------------

This release has changes which may affect projects which import containerd.

*Switch to Go modules*

containerd and all containerd sub-repositories are now using Go modules. This
should help make importing easier for handling transitive dependencies. As of
this release, containerd still does not guarantee client library compatibility
for 1.x versions, although best effort is made to minimize impact from changes
to exported Go packages.

*CRI plugin moved to main repository*

With the CRI plugin moving into the main repository, imports under github.com/containerd/cri/
can now be found github.com/containerd/containerd/pkg/cri/.
There are no changes required for end users of CRI.

*Library changes*

oci

The WithAllCapabilities has been removed and replaced with WithAllCurrentCapabilities
and WithAllKnownCapabilities. WithAllKnownCapabilities has similar
functionality to the previous WithAllCapabilities with added support for newer
capabilities. WithAllCurrentCapabilities can be used to give privileged
containers the same set of permissions as the calling process, preventing errors
when privileged containers attempt to get more permissions than given to the
caller.

*Configuration changes*

New registry.config_path for CRI plugin

registry.config_path specifies a directory to look for registry hosts
configuration. When resolving an image name during pull operations, the CRI
plugin will look in the <registry.config_path>/<image hostname>/ directory
for host configuration. An optional hosts.toml file in that directory may be
used to configure which hosts will be used for the pull operation as well
host-specific configurations. Updates under that directory do not require
restarting the containerd daemon.

Enable registry.config_path in the containerd configuration file.

    [plugins."io.containerd.grpc.v1.cri".registry]
       config_path = "/etc/containerd/certs.d"
    Configure registry hosts, such as /etc/containerd/certs.d/docker.io/hosts.toml
    for any image under the docker.io namespace (any image on Docker Hub).

    server = "https://registry-1.docker.io"

    [host."https://public-mirror.example.com"]
      capabilities = ["pull"]
    [host."https://docker-mirror.internal"]
      capabilities = ["pull", "resolve"]
      ca = "docker-mirror.crt"

If no hosts.toml configuration exists in the host directory, it will fallback
to check certificate files based on Docker's certificate file
pattern (".crt" files for CA certificates and ".cert"/".key" files for client
certificates).

*Deprecation of registry.mirrors and registry.configs in CRI plugin*

Mirroring and TLS can now be configured using the new registry.config_path
option. Existing configurations may be migrated to new host directory
configuration. These fields are only deprecated with no planned removal,
however, these configurations cannot be used while registry.config_path is
defined.

*Version 1 schema is deprecated*

Version 2 of the containerd configuration toml is recommended format and the
default. Starting this version, a deprecation warning will be logged when
version 1 is used.

To check version, see the version value in the containerd toml configuration.

    version=2

FreeBSD Runtime Support (Experimental)
--------------------------------------------------------------------------------

This release includes changes that allow containerd to run on FreeBSD with a
compatible runtime, such as runj. This
support should be considered experimental and currently there are no official
binary releases for FreeBSD. The runtimes used by containerd are maintained
separately and have their own stability guarantees. The containerd project
strives to be compatible with any runtime which aims to implement containerd's
shim API and OCI runtime specification.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-05-04 15:45:01 +02:00
.github Remove refs to jhowardmsft from .go code 2019-09-25 10:51:18 -07:00
api Remove more of registry v1 code. 2021-02-23 09:49:46 +01:00
builder builder: produce error when using unsupported Dockerfile option 2021-03-14 14:11:08 +01:00
cli remove uses of deprecated pkg/term 2020-04-21 16:29:27 +02:00
client Update documentation links 2021-02-25 12:11:50 +01:00
cmd/dockerd Use designated test domains (RFC2606) in tests 2021-04-02 14:06:27 +02:00
container replace pkg/symlink with github.com/moby/sys/symlink 2020-11-03 11:17:12 +01:00
contrib Merge pull request #42077 from WhyNotHugo/patch-1 2021-05-03 10:36:03 -07:00
daemon Added missing test cleanup for temporary directory 2021-05-01 15:39:50 +03:00
distribution distribution: fix errors tests 2021-02-23 09:49:49 +01:00
dockerversion Use -X ldflags to set dockerversion package vars 2019-12-02 10:21:41 -08:00
docs Fix typo on the v1.41 changelog 2021-04-07 22:29:07 +02:00
errdefs Implement Unwrap to errors 2020-11-21 16:36:35 +01:00
hack update containerd binary to v1.5.0 2021-05-04 15:45:01 +02:00
image Merge pull request #41884 from rcowsill/41829-load-valid-parent 2021-02-22 22:00:29 +01:00
integration Prepare tests for Windows containerd support 2021-04-22 10:50:00 +03:00
integration-cli Prepare tests for Windows containerd support 2021-04-22 10:50:00 +03:00
internal/test/suite integration-cli: move each test suite to its own TestX testing function 2019-09-18 18:26:36 +00:00
layer fix typo in comments 2021-03-02 23:03:04 +08:00
libcontainerd Prepare tests for Windows containerd support 2021-04-22 10:50:00 +03:00
oci oci.Device() fix FileMode to match runtime spec 2021-02-18 10:48:24 +01:00
opts opts: unify host-options, and use consts 2020-10-31 16:44:21 +01:00
patches Remove blurb about fixed in go1.11 in patch file 2020-04-24 11:23:14 -07:00
pkg pkg/archive temporarily skip some tests on Windowsd V19H1 (1903) and up 2021-04-09 01:07:27 +02:00
plugin Use docker media type for plugin layers 2021-04-05 21:46:53 +00:00
profiles Enable process_vm_readv and process_vm_writev for kernel > 4.8 2021-03-04 17:12:01 +00:00
project vendor: opencontainers/selinux v1.8.0, and remove selinux build-tag and stubs 2020-12-24 00:47:16 +01:00
quota quota: move test helper functions to extra file 2020-10-05 13:28:25 +00:00
reference fix goimports 2020-02-11 22:16:54 +09:00
registry Use designated test domains (RFC2606) in tests 2021-04-02 14:06:27 +02:00
reports Fix typos 2018-05-16 09:15:43 +08:00
restartmanager unconvert: remove unnescessary conversions 2019-09-18 12:57:33 +02:00
rootless Merge pull request #41893 from AkihiroSuda/fix-41457 2021-04-06 14:30:40 +09:00
runconfig pkg/sysinfo: rm duplicates 2020-06-26 16:19:52 -07:00
testutil Merge pull request #41817 from simonferquel/desktop-startup-hang 2020-12-23 23:22:00 -08:00
vendor Update Microsoft/go-winio to version 0.4.19 2021-04-26 10:02:58 -07:00
volume Use real root with 0701 perms 2021-02-02 13:01:25 +01:00
.DEREK.yml Update .DEREK.yml 2019-05-06 13:27:04 -07:00
.dockerignore update .dockerignore to prevent '-unsupported' builds 2020-01-13 12:55:15 +01:00
.gitignore Use -X ldflags to set dockerversion package vars 2019-12-02 10:21:41 -08:00
.mailmap Update authors and mailmap 2020-08-06 01:57:12 +02:00
AUTHORS Update authors and mailmap 2020-08-06 01:57:12 +02: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 Update CONTRIBUTING.md to have an option to keep name anonymous if requested 2019-07-15 16:04:11 +02:00
Dockerfile Dockerfile: update yamllint to v1.26.1 to fix build 2021-04-15 21:30:10 +02:00
Dockerfile.buildx Dockerfile.buildx: update buildx to v0.5.1 2021-01-26 11:37:50 +01:00
Dockerfile.e2e Move use of debian:buster frozen image to debian:bullseye 2020-12-19 17:59:36 +01:00
Dockerfile.simple Dockerfile.simple: Fix compile docker binary error with btrfs 2021-02-03 23:16:15 +00:00
Dockerfile.windows Force Download-File function to use TLS 1.2 2020-09-20 23:18:16 +03:00
Jenkinsfile Jenkinsfile: temporarily use insider build for Windows 2022 (SAC) 2021-04-08 21:25:35 +02:00
LICENSE Update LICENSE 2018-09-12 14:27:53 +01:00
MAINTAINERS Merge pull request #42326 from thaJeztah/jhoward_alumni 2021-04-26 19:22:46 +01:00
Makefile Makefile: remove empty targets, and slight refactor 2020-05-01 16:48:07 +02:00
NOTICE switch kr/pty to creack/pty v1.1.7 2019-07-29 16:59:08 -07:00
poule.yml Poule: remove random assign 2019-09-05 20:57:17 +02: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
SECURITY.md Update SECURITY.md to have an option to keep name anonymous if requested. 2019-06-18 16:37:16 +00:00
TESTING.md TESTING.md: note that integration-cli is deprecated 2020-12-18 07:51:46 +01:00
vendor.conf Update Microsoft/go-winio to version 0.4.19 2021-04-26 10:02:58 -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.