Skip to content

Commit

Permalink
Add compression method support to zran docs
Browse files Browse the repository at this point in the history
Signed-off-by: Adolfo Ochagavía <[email protected]>
  • Loading branch information
aochagavia committed Mar 25, 2024
1 parent 9ae8e3a commit 53de7fd
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/nydus-zran.md
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

0 comments on commit 53de7fd

Please sign in to comment.