github.com/containerd/nerdctl@v1.7.7/docs/overlaybd.md (about)

     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.
    30  
    31  ## Build OverlayBD image using `nerdctl image convert`
    32  
    33  Nerdctl supports to convert an OCI image or docker format v2 image to OverlayBD image by using the `nerdctl image convert` command.
    34  
    35  Before the conversion, you should have the `overlaybd-snapshotter` binary installed, which build from [accelerated-container-image](https://github.com/containerd/accelerated-container-image). You can run the command like `nerdctl image convert --overlaybd --oci <source_image> <target_image>` to convert the `<source_image>` to a OverlayBD image whose tag is `<target_image>`.