{"id":22066039,"url":"https://github.com/adyanth/containerd-moby","last_synced_at":"2026-05-03T22:32:06.563Z","repository":{"id":104080340,"uuid":"565659917","full_name":"adyanth/containerd-moby","owner":"adyanth","description":null,"archived":false,"fork":false,"pushed_at":"2022-11-15T01:16:59.000Z","size":551,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-13T13:14:12.020Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adyanth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"code-of-conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-11-14T03:25:06.000Z","updated_at":"2022-11-14T03:27:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"d7c36538-b3fd-43a0-99c8-949598774589","html_url":"https://github.com/adyanth/containerd-moby","commit_stats":{"total_commits":1,"total_committers":1,"mean_commits":1.0,"dds":0.0,"last_synced_commit":"45beecc819253c0742b36482c494667fe9c086f1"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/adyanth/containerd-moby","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adyanth%2Fcontainerd-moby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adyanth%2Fcontainerd-moby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adyanth%2Fcontainerd-moby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adyanth%2Fcontainerd-moby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adyanth","download_url":"https://codeload.github.com/adyanth/containerd-moby/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adyanth%2Fcontainerd-moby/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278671793,"owners_count":26025756,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-30T19:23:19.882Z","updated_at":"2025-10-06T20:13:27.287Z","avatar_url":"https://github.com/adyanth.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"![containerd banner light mode](https://raw.githubusercontent.com/cncf/artwork/master/projects/containerd/horizontal/color/containerd-horizontal-color.png#gh-light-mode-only)\n![containerd banner dark mode](https://raw.githubusercontent.com/cncf/artwork/master/projects/containerd/horizontal/white/containerd-horizontal-white.png#gh-dark-mode-only)\n\n[![PkgGoDev](https://pkg.go.dev/badge/github.com/containerd/containerd)](https://pkg.go.dev/github.com/containerd/containerd)\n[![Build Status](https://github.com/containerd/containerd/workflows/CI/badge.svg)](https://github.com/containerd/containerd/actions?query=workflow%3ACI)\n[![Nightlies](https://github.com/containerd/containerd/workflows/Nightly/badge.svg)](https://github.com/containerd/containerd/actions?query=workflow%3ANightly)\n[![Go Report Card](https://goreportcard.com/badge/github.com/containerd/containerd)](https://goreportcard.com/report/github.com/containerd/containerd)\n[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1271/badge)](https://bestpractices.coreinfrastructure.org/projects/1271)\n\ncontainerd 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.\n\ncontainerd is a member of CNCF with ['graduated'](https://landscape.cncf.io/selected=containerd) status.\n\ncontainerd is designed to be embedded into a larger system, rather than being used directly by developers or end-users.\n\n![architecture](design/architecture.png)\n\n## Now Recruiting\n\nWe are a large inclusive OSS project that is welcoming help of any kind shape or form:\n* Documentation help is needed to make the product easier to consume and extend.\n* We need OSS community outreach / organizing help to get the word out; manage\nand create messaging and educational content; and to help with social media, community forums/groups, and google groups.\n* We are actively inviting new [security advisors](https://github.com/containerd/project/blob/main/GOVERNANCE.md#security-advisors) to join the team.\n* New sub-projects are being created, core and non-core that could use additional development help.\n* Each of the [containerd projects](https://github.com/containerd) has a list of issues currently being worked on or that need help resolving.\n  - If the issue has not already been assigned to someone, or has not made recent progress and you are interested, please inquire.\n  - If you are interested in starting with a smaller / beginner level issue, look for issues with an `exp/beginner` tag, for example [containerd/containerd beginner issues.](https://github.com/containerd/containerd/issues?q=is%3Aissue+is%3Aopen+label%3Aexp%2Fbeginner)\n\n## Getting Started\n\nSee our documentation on [containerd.io](https://containerd.io):\n* [for ops and admins](docs/ops.md)\n* [namespaces](docs/namespaces.md)\n* [client options](docs/client-opts.md)\n\nSee how to build containerd from source at [BUILDING](BUILDING.md).\n\nIf you are interested in trying out containerd see our example at [Getting Started](docs/getting-started.md).\n\n## Nightly builds\n\nThere are nightly builds available for download [here](https://github.com/containerd/containerd/actions?query=workflow%3ANightly).\nBinaries are generated from `main` branch every night for `Linux` and `Windows`.\n\nPlease be aware: nightly builds might have critical bugs, it's not recommended for use in production and no support provided.\n\n## Runtime Requirements\n\nRuntime requirements for containerd are very minimal. Most interactions with\nthe Linux and Windows container feature sets are handled via [runc](https://github.com/opencontainers/runc) and/or\nOS-specific libraries (e.g. [hcsshim](https://github.com/Microsoft/hcsshim) for Microsoft).\nThe current required version of `runc` is described in [RUNC.md](docs/RUNC.md).\n\nThere are specific features\nused by containerd core code and snapshotters that will require a minimum kernel\nversion on Linux. With the understood caveat of distro kernel versioning, a\nreasonable starting point for Linux is a minimum 4.x kernel version.\n\nThe overlay filesystem snapshotter, used by default, uses features that were\nfinalized in the 4.x kernel series. If you choose to use btrfs, there may\nbe more flexibility in kernel version (minimum recommended is 3.18), but will\nrequire the btrfs kernel module and btrfs tools to be installed on your Linux\ndistribution.\n\nTo use Linux checkpoint and restore features, you will need `criu` installed on\nyour system. See more details in [Checkpoint and Restore](#checkpoint-and-restore).\n\nBuild requirements for developers are listed in [BUILDING](BUILDING.md).\n\n\n## Supported Registries\n\nAny registry which is compliant with the [OCI Distribution Specification](https://github.com/opencontainers/distribution-spec)\nis supported by containerd.\n\nFor configuring registries, see [registry host configuration documentation](docs/hosts.md)\n\n## Features\n\n### Client\n\ncontainerd offers a full client package to help you integrate containerd into your platform.\n\n```go\n\nimport (\n  \"context\"\n\n  \"github.com/containerd/containerd\"\n  \"github.com/containerd/containerd/cio\"\n  \"github.com/containerd/containerd/namespaces\"\n)\n\n\nfunc main() {\n\tclient, err := containerd.New(\"/run/containerd/containerd.sock\")\n\tdefer client.Close()\n}\n\n```\n\n### Namespaces\n\nNamespaces allow multiple consumers to use the same containerd without conflicting with each other.  It has the benefit of sharing content but still having separation with containers and images.\n\nTo set a namespace for requests to the API:\n\n```go\ncontext = context.Background()\n// create a context for docker\ndocker = namespaces.WithNamespace(context, \"docker\")\n\ncontainerd, err := client.NewContainer(docker, \"id\")\n```\n\nTo set a default namespace on the client:\n\n```go\nclient, err := containerd.New(address, containerd.WithDefaultNamespace(\"docker\"))\n```\n\n### Distribution\n\n```go\n// pull an image\nimage, err := client.Pull(context, \"docker.io/library/redis:latest\")\n\n// push an image\nerr := client.Push(context, \"docker.io/library/redis:latest\", image.Target())\n```\n\n### Containers\n\nIn containerd, a container is a metadata object.  Resources such as an OCI runtime specification, image, root filesystem, and other metadata can be attached to a container.\n\n```go\nredis, err := client.NewContainer(context, \"redis-master\")\ndefer redis.Delete(context)\n```\n\n### OCI Runtime Specification\n\ncontainerd fully supports the OCI runtime specification for running containers.  We have built in functions to help you generate runtime specifications based on images as well as custom parameters.\n\nYou can specify options when creating a container about how to modify the specification.\n\n```go\nredis, err := client.NewContainer(context, \"redis-master\", containerd.WithNewSpec(oci.WithImageConfig(image)))\n```\n\n### Root Filesystems\n\ncontainerd allows you to use overlay or snapshot filesystems with your containers.  It comes with built in support for overlayfs and btrfs.\n\n```go\n// pull an image and unpack it into the configured snapshotter\nimage, err := client.Pull(context, \"docker.io/library/redis:latest\", containerd.WithPullUnpack)\n\n// allocate a new RW root filesystem for a container based on the image\nredis, err := client.NewContainer(context, \"redis-master\",\n\tcontainerd.WithNewSnapshot(\"redis-rootfs\", image),\n\tcontainerd.WithNewSpec(oci.WithImageConfig(image)),\n)\n\n// use a readonly filesystem with multiple containers\nfor i := 0; i \u003c 10; i++ {\n\tid := fmt.Sprintf(\"id-%s\", i)\n\tcontainer, err := client.NewContainer(ctx, id,\n\t\tcontainerd.WithNewSnapshotView(id, image),\n\t\tcontainerd.WithNewSpec(oci.WithImageConfig(image)),\n\t)\n}\n```\n\n### Tasks\n\nTaking a container object and turning it into a runnable process on a system is done by creating a new `Task` from the container.  A task represents the runnable object within containerd.\n\n```go\n// create a new task\ntask, err := redis.NewTask(context, cio.NewCreator(cio.WithStdio))\ndefer task.Delete(context)\n\n// the task is now running and has a pid that can be used to setup networking\n// or other runtime settings outside of containerd\npid := task.Pid()\n\n// start the redis-server process inside the container\nerr := task.Start(context)\n\n// wait for the task to exit and get the exit status\nstatus, err := task.Wait(context)\n```\n\n### Checkpoint and Restore\n\nIf you have [criu](https://criu.org/Main_Page) installed on your machine you can checkpoint and restore containers and their tasks.  This allows you to clone and/or live migrate containers to other machines.\n\n```go\n// checkpoint the task then push it to a registry\ncheckpoint, err := task.Checkpoint(context)\n\nerr := client.Push(context, \"myregistry/checkpoints/redis:master\", checkpoint)\n\n// on a new machine pull the checkpoint and restore the redis container\ncheckpoint, err := client.Pull(context, \"myregistry/checkpoints/redis:master\")\n\nredis, err = client.NewContainer(context, \"redis-master\", containerd.WithNewSnapshot(\"redis-rootfs\", checkpoint))\ndefer container.Delete(context)\n\ntask, err = redis.NewTask(context, cio.NewCreator(cio.WithStdio), containerd.WithTaskCheckpoint(checkpoint))\ndefer task.Delete(context)\n\nerr := task.Start(context)\n```\n\n### Snapshot Plugins\n\nIn addition to the built-in Snapshot plugins in containerd, additional external\nplugins can be configured using GRPC. An external plugin is made available using\nthe configured name and appears as a plugin alongside the built-in ones.\n\nTo add an external snapshot plugin, add the plugin to containerd's config file\n(by default at `/etc/containerd/config.toml`). The string following\n`proxy_plugin.` will be used as the name of the snapshotter and the address\nshould refer to a socket with a GRPC listener serving containerd's Snapshot\nGRPC API. Remember to restart containerd for any configuration changes to take\neffect.\n\n```\n[proxy_plugins]\n  [proxy_plugins.customsnapshot]\n    type = \"snapshot\"\n    address =  \"/var/run/mysnapshotter.sock\"\n```\n\nSee [PLUGINS.md](/docs/PLUGINS.md) for how to create plugins\n\n### Releases and API Stability\n\nPlease see [RELEASES.md](RELEASES.md) for details on versioning and stability\nof containerd components.\n\nDownloadable 64-bit Intel/AMD binaries of all official releases are available on\nour [releases page](https://github.com/containerd/containerd/releases).\n\nFor other architectures and distribution support, you will find that many\nLinux distributions package their own containerd and provide it across several\narchitectures, such as [Canonical's Ubuntu packaging](https://launchpad.net/ubuntu/bionic/+package/containerd).\n\n#### Enabling command auto-completion\n\nStarting with containerd 1.4, the urfave client feature for auto-creation of bash and zsh\nautocompletion data is enabled. To use the autocomplete feature in a bash shell for example, source\nthe autocomplete/ctr file in your `.bashrc`, or manually like:\n\n```\n$ source ./contrib/autocomplete/ctr\n```\n\n#### Distribution of `ctr` autocomplete for bash and zsh\n\nFor bash, copy the `contrib/autocomplete/ctr` script into\n`/etc/bash_completion.d/` and rename it to `ctr`. The `zsh_autocomplete`\nfile is also available and can be used similarly for zsh users.\n\nProvide documentation to users to `source` this file into their shell if\nyou don't place the autocomplete file in a location where it is automatically\nloaded for the user's shell environment.\n\n### CRI\n\n`cri` is a [containerd](https://containerd.io/) plugin implementation of the Kubernetes [container runtime interface (CRI)](https://github.com/kubernetes/cri-api/blob/master/pkg/apis/runtime/v1alpha2/api.proto). With it, you are able to use containerd as the container runtime for a Kubernetes cluster.\n\n![cri](./docs/cri/cri.png)\n\n#### CRI Status\n\n`cri` is a native plugin of containerd. Since containerd 1.1, the cri plugin is built into the release binaries and enabled by default.\n\n\u003e **Note:** As of containerd 1.5, the `cri` plugin is merged into the containerd/containerd repo. For example, the source code previously stored under [`containerd/cri/pkg`](https://github.com/containerd/cri/tree/release/1.4/pkg)\nwas moved to [`containerd/containerd/pkg/cri` package](https://github.com/containerd/containerd/tree/main/pkg/cri).\n\nThe `cri` plugin has reached GA status, representing that it is:\n* Feature complete\n* Works with Kubernetes 1.10 and above\n* Passes all [CRI validation tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/cri-validation.md).\n* Passes all [node e2e tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/e2e-node-tests.md).\n* Passes all [e2e tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-testing/e2e-tests.md).\n\nSee results on the containerd k8s [test dashboard](https://k8s-testgrid.appspot.com/sig-node-containerd)\n\n#### Validating Your `cri` Setup\nA Kubernetes incubator project, [cri-tools](https://github.com/kubernetes-sigs/cri-tools), includes programs for exercising CRI implementations. More importantly, cri-tools includes the program `critest` which is used for running [CRI Validation Testing](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/cri-validation.md).\n\n#### CRI Guides\n* [Installing with Ansible and Kubeadm](contrib/ansible/README.md)\n* [For Non-Ansible Users, Preforming a Custom Installation Using the Release Tarball and Kubeadm](docs/cri/installation.md)\n* [CRI Plugin Testing Guide](./docs/cri/testing.md)\n* [Debugging Pods, Containers, and Images with `crictl`](./docs/cri/crictl.md)\n* [Configuring `cri` Plugins](./docs/cri/config.md)\n* [Configuring containerd](https://github.com/containerd/containerd/blob/main/docs/man/containerd-config.8.md)\n\n### Communication\n\nFor async communication and long running discussions please use issues and pull requests on the github repo.\nThis will be the best place to discuss design and implementation.\n\nFor 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.](https://slack.cncf.io)\n\n### Security audit\n\nA third party security audit was performed by Cure53 in 4Q2018; the [full report](docs/SECURITY_AUDIT.pdf) is available in our docs/ directory.\n\n### Reporting security issues\n\n__If you are reporting a security issue, please reach out discreetly at security@containerd.io__.\n\n## Licenses\n\nThe containerd codebase is released under the [Apache 2.0 license](LICENSE).\nThe README.md file, and files in the \"docs\" folder are licensed under the\nCreative Commons Attribution 4.0 International License. You may obtain a\ncopy of the license, titled CC-BY-4.0, at http://creativecommons.org/licenses/by/4.0/.\n\n## Project details\n\n**containerd** is the primary open source project within the broader containerd GitHub organization.\nHowever, all projects within the repo have common maintainership, governance, and contributing\nguidelines which are stored in a `project` repository commonly for all containerd projects.\n\nPlease find all these core project documents, including the:\n * [Project governance](https://github.com/containerd/project/blob/main/GOVERNANCE.md),\n * [Maintainers](https://github.com/containerd/project/blob/main/MAINTAINERS),\n * and [Contributing guidelines](https://github.com/containerd/project/blob/main/CONTRIBUTING.md)\n\ninformation in our [`containerd/project`](https://github.com/containerd/project) repository.\n\n## Adoption\n\nInterested to see who is using containerd? Are you using containerd in a project?\nPlease add yourself via pull request to our [ADOPTERS.md](./ADOPTERS.md) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadyanth%2Fcontainerd-moby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadyanth%2Fcontainerd-moby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadyanth%2Fcontainerd-moby/lists"}