Skip to content

Commit 332fc23

Browse files
committed
Add document about overlaybd
Since nerdctl has been supported overlaybd in containerd#603 but missing document. This pr adds the description in it. Signed-off-by: Yifan Yuan <[email protected]>
1 parent b1ae460 commit 332fc23

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
[Optional] Supports [rootless mode, without slirp overhead (bypass4netns)](./docs/rootless.md)
1515

16-
[Optional] Supports lazy-pulling ([Stargz](./docs/stargz.md), [Nydus](./docs/nydus.md))
16+
[Optional] Supports lazy-pulling ([Stargz](./docs/stargz.md), [Nydus](./docs/nydus.md), [OverlayBD](./docs/overlaybd.md))
1717

1818
[Optional] Supports [encrypted images (ocicrypt)](./docs/ocicrypt.md)
1919

docs/overlaybd.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Lazy-pulling using OverlayBD Snapshotter
2+
3+
| :zap: Requirement | nerdctl >= 0.15.0 |
4+
| ----------------- | --------------- |
5+
6+
OverlayBD is a remote container image format base on block-device which is an open-source implementation of paper ["DADI: Block-Level Image Service for Agile and Elastic Application Deployment. USENIX ATC'20".](https://www.usenix.org/conference/atc20/presentation/li-huiba)
7+
8+
See https://github.com/containerd/accelerated-container-image to learn further information.
9+
10+
## Enable lazy-pulling for `nerdctl run`
11+
12+
- Install containerd remote snapshotter plugin (`overlaybd`) from https://github.com/containerd/accelerated-container-image/blob/main/docs/BUILDING.md
13+
14+
- Add the following to `/etc/containerd/config.toml`:
15+
```toml
16+
[proxy_plugins]
17+
[proxy_plugins.overlaybd]
18+
type = "snapshot"
19+
address = "/run/overlaybd-snapshotter/overlaybd.sock"
20+
```
21+
22+
- Launch `containerd` and `overlaybd-snapshotter`
23+
24+
- Run `nerdctl` with `--snapshotter=overlaybd`
25+
```console
26+
nerdctl run --net host -it --rm --snapshotter=overlaybd registry.hub.docker.com/overlaybd/redis:6.2.1_obd
27+
```
28+
29+
For more details about how to build overlaybd image, please refer to [accelerated-container-image](https://github.com/containerd/accelerated-container-image/blob/main/docs/IMAGE_CONVERTOR.md) conversion tool.

0 commit comments

Comments
 (0)