containers
/
nydus-storage-plugin
mirror of https://github.com/containers/nydus-storage-plugin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
A storage plugin that provided CRI-O/Podman with the ability to lazy mount nydus images.
129 Commits 7 Branches 0 Tags 447 KiB
Go 99.5%
Makefile 0.5%
Go to file
imeoer f262d3f7d4
Merge pull request #142 from containers/dependabot/go_modules/github.com/urfave/cli/v2-2.27.5 
chore(deps): bump github.com/urfave/cli/v2 from 2.27.1 to 2.27.5
 		2025-02-11 17:26:57 +08:00
.github chore(deps): bump actions/setup-go from 4 to 5 2023-12-11 00:03:57 +00:00
cmd/store refactor: make nydus storage plugin work stable. 2022-09-14 12:51:51 +08:00
misc chore: update nydusd snapshotter dep 2022-09-29 13:34:04 +08:00
pkg refactor: make nydus storage plugin work stable. 2022-09-14 12:51:51 +08:00
.gitignore feat: add github ci workflow 2022-08-23 23:32:28 +08:00
.golangci.yml feat: add github ci workflow 2022-08-23 23:32:28 +08:00
Makefile feat: add github ci workflow 2022-08-23 23:32:28 +08:00
README.md bump nydus components to v2.1.2 2022-12-15 11:22:10 +00:00
go.mod chore(deps): bump github.com/urfave/cli/v2 from 2.27.1 to 2.27.5 2024-10-14 01:00:31 +00:00
go.sum chore(deps): bump github.com/urfave/cli/v2 from 2.27.1 to 2.27.5 2024-10-14 01:00:31 +00:00

README.md

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

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

asciicast

Quick Start

  1. Build store plugin
$ git clone https://github.com/containers/nydus-storage-plugin.git
$ cd nydus-storage-plugin
$ make
  1. 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
  1. Configure podman

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

  1. Run store plugin

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

$ sudo bin/nydus-store --log-to-stdout --log-level info \
  --config-path /etc/nydusd-config.json \
  --root /var/lib/nydus-store
  1. 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.