Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add compression method support to zran docs #1563

Merged
merged 1 commit into from
Mar 25, 2024
Merged

Add compression method support to zran docs #1563

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/nydus-zran.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,10 @@ Or you can generate one by `nydusify` tool:
# Convert the existing OCI image `your-registry.com/node:19.0` to `your-registry.com/node:19.0-nydus-oci-ref`:
sudo nydusify convert --oci-ref --source your-registry.com/node:19.0 --target your-registry.com/node:19.0-nydus-oci-ref
```
**Tips**:

**Tips**:
- Nydus ZRAN artifacts must be in the same namespace with the OCI image.

## Run nydus zran artifact:

Follow the [documentation](https://github.com/dragonflyoss/nydus/blob/master/docs/containerd-env-setup.md) to configure `containerd` and `nydus-snapshotter` (containerd-nydus-grpc):
Expand All @@ -50,6 +52,10 @@ Follow the [documentation](https://github.com/dragonflyoss/nydus/blob/master/doc
sudo nerdctl --snapshotter nydus run --rm -it docker.io/hsiangkao/node:18-nydus-oci-ref node -v
```

## Compression method

Currently ZRAN only supports OCI images that use gzip as their compression method.

## Recording

Pull ZRAN-indexed OCI / OCI wordpress images
Expand Down