From 53de7fdd59c7376e8641daa240439e9e6a6d9bca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adolfo=20Ochagav=C3=ADa?= Date: Mon, 25 Mar 2024 10:30:12 +0100 Subject: [PATCH] Add compression method support to zran docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Adolfo Ochagavía --- docs/nydus-zran.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/nydus-zran.md b/docs/nydus-zran.md index 68ac379a296..e02d9b152f0 100644 --- a/docs/nydus-zran.md +++ b/docs/nydus-zran.md @@ -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): @@ -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