Redirected from 
README
¶
containerd is an industry-standard container runtime with an emphasis on simplicity, robustness, and portability. It is available as a daemon for Linux and Windows, which can manage the complete container lifecycle of its host system: image transfer and storage, container execution and supervision, low-level storage and network attachments, etc.
containerd is a member of CNCF with 'graduated' status.
containerd is designed to be embedded into a larger system, rather than being used directly by developers or end-users.
Announcements
containerd v2.0 is now released!
Now Recruiting
We are a large inclusive OSS project that is welcoming help of any kind shape or form:
- Documentation help is needed to make the product easier to consume and extend.
- We need OSS community outreach/organizing help to get the word out; manage and create messaging and educational content; and help with social media, community forums/groups, and google groups.
- We are actively inviting new security advisors to join the team.
- New subprojects are being created, core and non-core that could use additional development help.
- Each of the containerd projects has a list of issues currently being worked on or that need help resolving.
- If the issue has not already been assigned to someone or has not made recent progress, and you are interested, please inquire.
- If you are interested in starting with a smaller/beginner-level issue, look for issues with an
exp/beginnertag, for example containerd/containerd beginner issues.
Getting Started
See our documentation on containerd.io:
To get started contributing to containerd, see CONTRIBUTING.
If you are interested in trying out containerd see our example at Getting Started.
Nightly builds
There are nightly builds available for download here.
Binaries are generated from main branch every night for Linux and Windows.
Please be aware: nightly builds might have critical bugs, it's not recommended for use in production and no support provided.
Kubernetes (k8s) CI Dashboard Group
The k8s CI dashboard group for containerd contains test results regarding the health of kubernetes when run against main and a number of containerd release branches.
Runtime Requirements
Runtime requirements for containerd are very minimal. Most interactions with
the Linux and Windows container feature sets are handled via runc and/or
OS-specific libraries (e.g. hcsshim for Microsoft).
The current required version of runc is described in RUNC.md.
There are specific features used by containerd core code and snapshotters that will require a minimum kernel version on Linux. With the understood caveat of distro kernel versioning, a reasonable starting point for Linux is a minimum 4.x kernel version.
The overlay filesystem snapshotter, used by default, uses features that were finalized in the 4.x kernel series. If you choose to use btrfs, there may be more flexibility in kernel version (minimum recommended is 3.18), but will require the btrfs kernel module and btrfs tools to be installed on your Linux distribution.
To use Linux checkpoint and restore features, you will need criu installed on
your system. See more details in Checkpoint and Restore.
Build requirements for developers are listed in BUILDING.
Supported Registries
Any registry which is compliant with the OCI Distribution Specification is supported by containerd.
For configuring registries, see registry host configuration documentation
Features
For a detailed overview of containerd's core concepts and the features it supports, please refer to the FEATURES.MD document.
Releases and API Stability
Please see RELEASES.md for details on versioning and stability of containerd components.
Downloadable 64-bit Intel/AMD binaries of all official releases are available on our releases page.
For other architectures and distribution support, you will find that many Linux distributions package their own containerd and provide it across several architectures, such as Canonical's Ubuntu packaging.
Enabling command auto-completion
Starting with containerd 1.4, the urfave client feature for auto-creation of bash and zsh
autocompletion data is enabled. To use the autocomplete feature in a bash shell for example, source
the autocomplete/ctr file in your .bashrc, or manually like:
$ source ./contrib/autocomplete/ctr
Distribution of ctr autocomplete for bash and zsh
For bash, copy the contrib/autocomplete/ctr script into
/etc/bash_completion.d/ and rename it to ctr. The zsh_autocomplete
file is also available and can be used similarly for zsh users.
Provide documentation to users to source this file into their shell if
you don't place the autocomplete file in a location where it is automatically
loaded for the user's shell environment.
CRI
cri is a containerd plugin implementation of the Kubernetes container runtime interface (CRI). With it, you are able to use containerd as the container runtime for a Kubernetes cluster.
CRI Status
cri is a native plugin of containerd. Since containerd 1.1, the cri plugin is built into the release binaries and enabled by default.
The cri plugin has reached GA status, representing that it is:
- Feature complete
- Works with Kubernetes 1.10 and above
- Passes all CRI validation tests.
- Passes all node e2e tests.
- Passes all e2e tests.
See results on the containerd k8s test dashboard
Validating Your cri Setup
A Kubernetes incubator project, cri-tools, includes programs for exercising CRI implementations. More importantly, cri-tools includes the program critest which is used for running CRI Validation Testing.
CRI Guides
- Installing with Ansible and Kubeadm
- For Non-Ansible Users, Preforming a Custom Installation Using the Release Tarball and Kubeadm
- CRI Plugin Testing Guide
- Debugging Pods, Containers, and Images with
crictl - Configuring
criPlugins - Configuring containerd
Communication
For async communication and long-running discussions please use issues and pull requests on the GitHub repo. This will be the best place to discuss design and implementation.
For sync communication catch us in the #containerd and #containerd-dev Slack channels on Cloud Native Computing Foundation's (CNCF) Slack - cloud-native.slack.com. Everyone is welcome to join and chat. Get Invite to CNCF Slack.
Join our next community meeting hosted on Zoom. The schedule is posted on the CNCF Calendar (search 'containerd' to filter).
Security audit
Security audits for the containerd project are hosted on our website. Please see the security page at containerd.io for more information.
Reporting security issues
Please follow the instructions at containerd/project
Licenses
The containerd codebase is released under the Apache 2.0 license. The README.md file and files in the "docs" folder are licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at http://creativecommons.org/licenses/by/4.0/.
Project details
containerd is the primary open source project within the broader containerd GitHub organization.
However, all projects within the repo have common maintainership, governance, and contributing
guidelines which are stored in a project repository commonly for all containerd projects.
Please find all these core project documents, including the:
information in our containerd/project repository.
Adoption
Interested to see who is using containerd? Are you using containerd in a project? Please add yourself via pull request to our ADOPTERS.md file.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
containerd
command
|
|
|
containerd-shim-runc-v2
command
|
|
|
containerd-stress
command
|
|
|
containerd/server/config
config is the global configuration for containerd
|
config is the global configuration for containerd |
|
ctr
command
|
|
|
gen-manpages
command
|
|
|
go-buildtag
command
|
|
|
protoc-gen-go-fieldpath
command
|
|
|
contrib
|
|
|
checkpoint
command
|
|
|
core
|
|
|
images/archive
Package archive provides a Docker and OCI compatible importer
|
Package archive provides a Docker and OCI compatible importer |
|
images/converter
Package converter provides image converter
|
Package converter provides image converter |
|
metadata
Package metadata stores all labels and object specific metadata by namespace.
|
Package metadata stores all labels and object specific metadata by namespace. |
|
mount/manager
Package manager is used to manage mounts in a bolt database, normally backed by a tempfs.
|
Package manager is used to manage mounts in a bolt database, normally backed by a tempfs. |
|
remotes/docker/config
Package config contains utilities for helping configure the Docker resolver
|
Package config contains utilities for helping configure the Docker resolver |
|
runtime/restart
Package restart enables containers to have labels added and monitored to keep the container's task running if it is killed.
|
Package restart enables containers to have labels added and monitored to keep the container's task running if it is killed. |
|
runtime/v2/example/cmd
command
|
|
|
snapshots/storage
Package storage provides a metadata storage implementation for snapshot drivers.
|
Package storage provides a metadata storage implementation for snapshot drivers. |
|
Package defaults provides several common defaults for interacting with containerd.
|
Package defaults provides several common defaults for interacting with containerd. |
|
failpoint/cmd/cni-bridge-fp
command
|
|
|
failpoint/cmd/loopback-v2
command
|
|
|
failpoint/cmd/runc-fp
command
|
|
|
images/volume-ownership/tools
command
|
|
|
remote
Package remote contains gRPC implementation of internalapi.RuntimeService and internalapi.ImageManagerService.
|
Package remote contains gRPC implementation of internalapi.RuntimeService and internalapi.ImageManagerService. |
|
internal
|
|
|
cleanup
Package cleanup provides utilies to help cleanup.
|
Package cleanup provides utilies to help cleanup. |
|
cri/bandwidth
Package bandwidth provides utilities for bandwidth shaping
|
Package bandwidth provides utilities for bandwidth shaping |
|
cri/executil
Package exec provides an injectable interface and implementations for running commands.
|
Package exec provides an injectable interface and implementations for running commands. |
|
cri/resourcequantity
Package resourcequantity has tools for converting resource quantities to and from strings.
|
Package resourcequantity has tools for converting resource quantities to and from strings. |
|
cri/setutils
Package setutils has generic set and specified sets.
|
Package setutils has generic set and specified sets. |
|
cri/streamingserver
Package streamingserver contains server functions related the cri streaming api.
|
Package streamingserver contains server functions related the cri streaming api. |
|
cri/streamingserver/portforward
Package portforward contains server-side logic for handling port forwarding requests.
|
Package portforward contains server-side logic for handling port forwarding requests. |
|
cri/streamingserver/remotecommand
Package remotecommand contains functions related to executing commands in and attaching to pods.
|
Package remotecommand contains functions related to executing commands in and attaching to pods. |
|
cri/streamingserver/v1
Package v1 contains types/constants for core types used by the streaming server command functions.
|
Package v1 contains types/constants for core types used by the streaming server command functions. |
|
failpoint
Package failpoint provides the code point in the path, which can be controlled by user's variable.
|
Package failpoint provides the code point in the path, which can be controlled by user's variable. |
|
kmutex
Package kmutex provides synchronization primitives to lock/unlock resource by unique key.
|
Package kmutex provides synchronization primitives to lock/unlock resource by unique key. |
|
lazyregexp
Package lazyregexp is a thin wrapper over regexp, allowing the use of global regexp variables without forcing them to be compiled at init.
|
Package lazyregexp is a thin wrapper over regexp, allowing the use of global regexp variables without forcing them to be compiled at init. |
|
randutil
Package randutil provides utilities for cyrpto/rand.
|
Package randutil provides utilities for cyrpto/rand. |
|
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. |
|
pkg
|
|
|
atomicfile
Package atomicfile provides a mechanism (on Unix-like platforms) to present a consistent view of a file to separate processes even while the file is being written.
|
Package atomicfile provides a mechanism (on Unix-like platforms) to present a consistent view of a file to separate processes even while the file is being written. |
|
cap
Package cap provides Linux capability utility
|
Package cap provides Linux capability utility |
|
epoch
Package epoch provides SOURCE_DATE_EPOCH utilities.
|
Package epoch provides SOURCE_DATE_EPOCH utilities. |
|
fifosync
Package fifosync provides a pattern on Unix-like operating systems for synchronizing across processes using Unix FIFOs (named pipes).
|
Package fifosync provides a pattern on Unix-like operating systems for synchronizing across processes using Unix FIFOs (named pipes). |
|
filters
Package filters defines a syntax and parser that can be used for the filtration of items across the containerd API.
|
Package filters defines a syntax and parser that can be used for the filtration of items across the containerd API. |
|
gc
Package gc experiments with providing central gc tooling to ensure deterministic resource removal within containerd.
|
Package gc experiments with providing central gc tooling to ensure deterministic resource removal within containerd. |
|
identifiers
Package identifiers provides common validation for identifiers and keys across containerd.
|
Package identifiers provides common validation for identifiers and keys across containerd. |
|
progress
Package progress assists in displaying human readable progress information.
|
Package progress assists in displaying human readable progress information. |
|
protobuf/proto
Package proto provides convenient aliases that make google.golang.org/protobuf migration easier.
|
Package proto provides convenient aliases that make google.golang.org/protobuf migration easier. |
|
protobuf/types
Package types provides convenient aliases that make google.golang.org/protobuf migration easier.
|
Package types provides convenient aliases that make google.golang.org/protobuf migration easier. |
|
plugins package stores all the plugin types used by containerd internally.
|
plugins package stores all the plugin types used by containerd internally. |