Skip to content

Commit 281567c

Browse files
thaJeztahjsternberg
authored andcommitted
docs: update nydus repository URLs
The repository was renamed to https://github.com/dragonflyoss/nydus, and while GitHub does provide redirects, their services have been a bit flaky recently so sometimes the redirects would fail. Signed-off-by: Sebastiaan van Stijn <[email protected]> (cherry picked from commit 8607e21)
1 parent 99eb71e commit 281567c

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

docs/nydus.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Nydus image formats
22

3-
Nydus is an OCI/Docker-compatible accelerated image format provided by the Dragonfly [image-service](https://github.com/dragonflyoss/image-service) project, which offers the ability to pull image data on-demand, without waiting for the entire image pull to complete and then start the container. It has been put in production usage and shown vast improvements to significantly reduce the overhead costs on time, network, disk IO of pulling image or starting container.
3+
Nydus is an OCI/Docker-compatible accelerated image format provided by the Dragonfly [image-service](https://github.com/dragonflyoss/nydus) project, which offers the ability to pull image data on-demand, without waiting for the entire image pull to complete and then start the container. It has been put in production usage and shown vast improvements to significantly reduce the overhead costs on time, network, disk IO of pulling image or starting container.
44

55
Nydus image can be flexibly configured as a FUSE-based user-space filesystem or in-kernel [EROFS](https://www.kernel.org/doc/html/latest/filesystems/erofs.html) (from Linux kernel v5.16) with nydus daemon in user-space, integrating with VM-based container runtime like [KataContainers](https://katacontainers.io/) is much easier.
66

@@ -16,7 +16,7 @@ go build -tags=nydus -o ./bin/buildkitd ./cmd/buildkitd
1616

1717
### Building Nydus with BuildKit
1818

19-
Download `nydus-image` binary from [nydus release page](https://github.com/dragonflyoss/image-service/releases) (require v2.1.6 or higher), then put the `nydus-image` binary path into $PATH or specifying it on `NYDUS_BUILDER` environment variable for buildkitd:
19+
Download `nydus-image` binary from [nydus release page](https://github.com/dragonflyoss/nydus/releases) (require v2.1.6 or higher), then put the `nydus-image` binary path into $PATH or specifying it on `NYDUS_BUILDER` environment variable for buildkitd:
2020

2121
```
2222
env NYDUS_BUILDER=/path/to/nydus-image buildkitd ...
@@ -33,7 +33,7 @@ buildctl build ... \
3333

3434
### Known limitations
3535

36-
- The export of Nydus image and runtime (e.g. [docker](https://github.com/dragonflyoss/image-service/tree/master/contrib/docker-nydus-graphdriver), [containerd](https://github.com/containerd/nydus-snapshotter), etc.) is currently only supported on linux platform.
36+
- The export of Nydus image and runtime (e.g. [docker](https://github.com/nydusaccelerator/docker-nydus-graphdriver), [containerd](https://github.com/containerd/nydus-snapshotter), etc.) is currently only supported on linux platform.
3737
- Nydus image layers cannot be mixed with other compression types in the same image, so the `force-compression=true` option must be enabled when exporting both Nydus and other compression types.
3838
- Specifying a Nydus image as a base image in a Dockerfile is supported, but it does not currently support lazy pulling.
3939
- Since exported Nydus image will always have one more metadata layer than images in other compression types, Nydus image cannot be exported/imported as cache.
@@ -42,6 +42,6 @@ buildctl build ... \
4242

4343
Pre-converted nydus images are available at [`ghcr.io/dragonflyoss/image-service` repository](https://github.com/orgs/dragonflyoss/packages?ecosystem=container) (mainly for testing purpose).
4444

45-
[`Nydusify`](https://github.com/dragonflyoss/image-service/blob/master/docs/nydusify.md) The Nydusify CLI tool pulls & converts an OCIv1 image into a nydus image, and pushes nydus image to registry.
45+
[`Nydusify`](https://github.com/dragonflyoss/nydus/blob/master/docs/nydusify.md) The Nydusify CLI tool pulls & converts an OCIv1 image into a nydus image, and pushes nydus image to registry.
4646

47-
[`Harbor Acceld`](https://github.com/goharbor/acceleration-service) Harbor acceld provides a general service to convert OCIv1 image to acceleration image like [Nydus](https://github.com/dragonflyoss/image-service) and [eStargz](https://github.com/containerd/stargz-snapshotter) etc.
47+
[`Harbor Acceld`](https://github.com/goharbor/acceleration-service) Harbor acceld provides a general service to convert OCIv1 image to acceleration image like [Nydus](https://github.com/dragonflyoss/nydus) and [eStargz](https://github.com/containerd/stargz-snapshotter) etc.

0 commit comments

Comments
 (0)