herolib_rust/virt/src/nerdctl/nerdctldocs/overlaybd.md
Mahmoud-Emad 455f84528b
Some checks are pending
Rhai Tests / Run Rhai Tests (push) Waiting to run
feat: Add support for virt package
- Add sal-virt package to the workspace members
- Update MONOREPO_CONVERSION_PLAN.md to reflect the
  completion of sal-process and sal-virt packages
- Update src/lib.rs to include sal-virt
- Update src/postgresclient to use sal-virt instead of local
  virt module
- Update tests to use sal-virt
2025-06-23 02:37:14 +03:00

1.8 KiB

Lazy-pulling using OverlayBD Snapshotter

Requirement nerdctl >= 0.15.0

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".

See https://github.com/containerd/accelerated-container-image to learn further information.

Enable lazy-pulling for nerdctl run

[proxy_plugins]
  [proxy_plugins.overlaybd]
    type = "snapshot"
    address = "/run/overlaybd-snapshotter/overlaybd.sock"
  • Launch containerd and overlaybd-snapshotter

  • Run nerdctl with --snapshotter=overlaybd

nerdctl run --net host -it --rm --snapshotter=overlaybd registry.hub.docker.com/overlaybd/redis:6.2.1_obd

For more details about how to build overlaybd image, please refer to accelerated-container-image conversion tool.

Build OverlayBD image using nerdctl image convert

Nerdctl supports to convert an OCI image or docker format v2 image to OverlayBD image by using the nerdctl image convert command.

Before the conversion, you should have the overlaybd-snapshotter binary installed, which build from 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>.