The project is an implementation of additional layer store plugin of CRI-O/Podman, it provides CRI-O/Podman with the ability to lazy mount nydus images.

⚠️ This project is still in progress, see more details in this proposal.

1. Build store plugin

$ git clone https://github.com/containers/nydus-storage-plugin.git
$ cd nydus-storage-plugin
$ make

2. Install nydusd

Download nydus binaries from nydus release page, and then install with the command below:

$ tar xzvf nydus-static-$version-linux-amd64.tgz
$ sudo mv nydus-static/nydusd /usr/bin/nydusd
$ sudo mv nydus-static/nydus-image /usr/bin/nydus-image

3. Configure podman

Replace /etc/containers/storage.conf with misc/storage.conf.

4. Run store plugin

Copy misc/nydusd-config.json to /etc.

$ sudo bin/nydus-store --log-to-stdout --log-level debug \
  --config-path /etc/nydusd-config.json \
  --root /var/lib/nydus-store

5. Run container with nydus image

$ sudo podman run -it ghcr.io/dragonflyoss/image-service/nginx:nydus-latest echo hello word

For the list of pre-converted nydus images, see nydus packages, for more details about how to build nydus image, please refer to nydusify conversion tool and acceld.