https://github.com/containers/nydus-storage-plugin

A storage plugin that provided CRI-O/Podman with the ability to lazy mount nydus images.
https://github.com/containers/nydus-storage-plugin

acceleration containers cri-o image nydus podman

Last synced: about 2 months ago
JSON representation

A storage plugin that provided CRI-O/Podman with the ability to lazy mount nydus images.

• Host: GitHub
• URL: https://github.com/containers/nydus-storage-plugin
• Owner: containers
• Created: 2022-08-11T10:16:50.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-04T00:05:02.000Z (3 months ago)
• Last Synced: 2024-12-07T08:41:46.364Z (2 months ago)
• Topics: acceleration, containers, cri-o, image, nydus, podman
• Language: Go
• Homepage:
• Size: 200 KB
• Stars: 35
• Watchers: 8
• Forks: 10
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# CRI-O/Podman Nydus Store Plugin

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](https://nydus.dev/) images.

⚠️ This project is still in progress, see more details in this [proposal](https://github.com/containers/podman/issues/15249).

[![asciicast](https://asciinema.org/a/EqYr5HCcP5LndnFbKnBucPeqd.svg)](https://asciinema.org/a/EqYr5HCcP5LndnFbKnBucPeqd)

## Quick Start

1. Build store plugin

```shell

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

$ cd nydus-storage-plugin

$ make

```

2. Install nydusd

Download nydus binaries from [nydus release](https://github.com/dragonflyoss/image-service/releases/) page, and then install with the command below:

```shell

$ 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`.

```shell

$ sudo bin/nydus-store --log-to-stdout --log-level info \

  --config-path /etc/nydusd-config.json \

  --root /var/lib/nydus-store

```

5. Run container with nydus image

```shell

$ 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](https://github.com/orgs/dragonflyoss/packages?page=1&repo_name=image-service), for more details about how to build nydus image, please refer to [nydusify](https://github.com/dragonflyoss/image-service/blob/master/docs/nydusify.md) conversion tool and [acceld](https://github.com/goharbor/acceleration-service).