Skip to content

engine: describe how to use the c8d image store with docker-ce #17482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1346,6 +1346,8 @@ manuals:
title: Use the VFS storage driver
- path: /storage/storagedriver/aufs-driver/
title: Use the AUFS storage driver (deprecated)
- path: /storage/containerd/
title: containerd snapshotters
- sectiontitle: Networking
section:
- path: /network/
Expand Down
58 changes: 58 additions & 0 deletions storage/containerd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: containerd image store with Docker Engine
keywords: containerd, snapshotters, image store, docker engine
description: Enabling the containerd image store on Docker Engine
---

> **Note**
>
> The containerd image store is an experimental feature of Docker Engine.
> If you're using Docker Desktop, don't use the instructions on this page. See
> [containerd image store with Docker Desktop](../desktop/containerd/index.md).

containerd, the industry-standard container runtime, uses snapshotters instead
of the classic storage drivers for storing image and container data.
While the `overlay2` driver still remains the default driver for Docker Engine,
you can opt in to using containerd snapshotters as an experimental feature.

To learn more about the containerd image store and its benefits, refer to
[containerd image store on Docker Desktop](../desktop/containerd/index.md).

## Enable containerd image store on Docker Engine

Switching to containerd snapshotters causes you to temporarily lose images and
containers created using the classic storage drivers.
Those resources still exist on your filesystem, and you can retrieve them by
turning off the containerd snapshotters feature.

The following steps explain how to enable the containerd snapshotters feature.

1. Add the following configuration to your `/etc/docker/daemon.json`
configuration file:

```json
{
"features": {
"containerd-snapshotter": true
}
}
```

2. Save the file.
3. Restart the daemon for the changes to take effect.

```console
$ sudo systemctl restart docker
```

After restarting the daemon, running `docker info` shows that you're using
containerd snapshotter storage drivers.

{% raw %}
```console
$ docker info -f '{{ .DriverStatus }}'
[[driver-type io.containerd.snapshotter.v1]]
```
{% endraw %}

Docker Engine uses the `overlayfs` containerd snapshotter by default.