Skip to content

Commit

Permalink
Merge pull request #3811 from BraveY/docs-nydus
Browse files Browse the repository at this point in the history
docs: Fix incorrect parameter description in documentation of nydus
  • Loading branch information
djdongjin authored Jan 14, 2025
2 parents b854127 + 2ce9918 commit b17b2cc
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/nydus.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ For the list of pre-converted Nydus images, see https://github.com/orgs/dragonfl

Nerdctl supports to convert an OCI image or docker format v2 image to Nydus image by using the `nerdctl image convert` command.

Before the conversion, you should have the `nydus-image` binary installed, which is contained in the ["nydus static package"](https://github.com/dragonflyoss/image-service/releases). You can run the command like `nerdctl image convert --nydus --oci --nydus-image <the_path_of_nydus_image> <source_image> <target_image>` to convert the `<source_image>` to a Nydus image whose tag is `<target_image>`.
Before the conversion, you should have the `nydus-image` binary installed, which is contained in the ["nydus static package"](https://github.com/dragonflyoss/image-service/releases). You can run the command like `nerdctl image convert --nydus --oci --nydus-builder-path <the_path_of_nydus_image_binary> <source_image> <target_image>` to convert the `<source_image>` to a Nydus image whose tag is `<target_image>`.

By now, the converted Nydus image cannot be run directly. It shoud be unpacked to nydus snapshotter before `nerdctl run`, which is a part of the processing flow of `nerdctl image pull`. So you need to push the converted image to a registry after the conversion and use `nerdctl --snapshotter nydus image pull` to unpack it to the nydus snapshotter before running the image.

Expand Down

0 comments on commit b17b2cc

Please sign in to comment.