From 4ae917c88a348767b0af196255898d049dde6248 Mon Sep 17 00:00:00 2001 From: Yadong Ding Date: Tue, 31 Oct 2023 13:13:31 +0800 Subject: [PATCH 1/2] docs: replace images-service to nydus in links Since https://github.com/dragonflyoss/nydus/issues/1405, we had changed repo name to nydus. Signed-off-by: Yadong Ding --- README.md | 32 ++++++++++++++++---------------- docs/containerd-env-setup.md | 4 ++-- docs/docker-env-setup.md | 6 +++--- docs/nydus-image.md | 4 ++-- docs/nydus-zran.md | 4 ++-- docs/nydusd.md | 6 +++--- docs/nydusify.md | 2 +- 7 files changed, 29 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 84f910c6c93..b57bd65d8cc 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ -[**[⬇️ Download]**](https://github.com/dragonflyoss/image-service/releases) +[**[⬇️ Download]**](https://github.com/dragonflyoss/nydus/releases) [**[πŸ“– Website]**](https://nydus.dev/) [**[☸ Quick Start (Kubernetes)**]](https://github.com/containerd/nydus-snapshotter/blob/main/docs/run_nydus_in_kubernetes.md) [**[πŸ€“ Quick Start (nerdctl)**]](https://github.com/containerd/nerdctl/blob/master/docs/nydus.md) -[**[❓ FAQs & Troubleshooting]**](https://github.com/dragonflyoss/image-service/wiki/FAQ) +[**[❓ FAQs & Troubleshooting]**](https://github.com/dragonflyoss/nydus/wiki/FAQ) # Nydus: Dragonfly Container Image Service

-[![Release Version](https://img.shields.io/github/v/release/dragonflyoss/image-service?style=flat)](https://github.com/dragonflyoss/image-service/releases) +[![Release Version](https://img.shields.io/github/v/release/dragonflyoss/nydus?style=flat)](https://github.com/dragonflyoss/nydus/releases) [![License](https://img.shields.io/crates/l/nydus-rs)](https://crates.io/crates/nydus-rs) [![Twitter](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2Fdragonfly_oss)](https://twitter.com/dragonfly_oss) [![Nydus Stars](https://img.shields.io/github/stars/dragonflyoss/image-service?label=Nydus%20Stars&style=social)](https://github.com/dragonflyoss/image-service) -[![Smoke Test](https://github.com/dragonflyoss/image-service/actions/workflows/smoke.yml/badge.svg?event=schedule)](https://github.com/dragonflyoss/image-service/actions/workflows/smoke.yml) -[![Image Conversion](https://github.com/dragonflyoss/image-service/actions/workflows/convert.yml/badge.svg?event=schedule)](https://github.com/dragonflyoss/image-service/actions/workflows/convert.yml) -[![Release Test Daily](https://github.com/dragonflyoss/image-service/actions/workflows/release.yml/badge.svg?event=schedule)](https://github.com/dragonflyoss/image-service/actions/workflows/release.yml) -[![Coverage](https://codecov.io/gh/dragonflyoss/image-service/branch/master/graph/badge.svg)](https://codecov.io/gh/dragonflyoss/image-service) +[![Smoke Test](https://github.com/dragonflyoss/nydus/actions/workflows/smoke.yml/badge.svg?event=schedule)](https://github.com/dragonflyoss/nydus/actions/workflows/smoke.yml) +[![Image Conversion](https://github.com/dragonflyoss/nydus/actions/workflows/convert.yml/badge.svg?event=schedule)](https://github.com/dragonflyoss/nydus/actions/workflows/convert.yml) +[![Release Test Daily](https://github.com/dragonflyoss/nydus/actions/workflows/release.yml/badge.svg?event=schedule)](https://github.com/dragonflyoss/nydus/actions/workflows/release.yml) +[![Coverage](https://codecov.io/gh/dragonflyoss/nydus/branch/master/graph/badge.svg)](https://codecov.io/gh/dragonflyoss/nydus) ## Introduction Nydus implements a content-addressable file system on the RAFS format, which enhances the current OCI image specification by improving container launch speed, image space and network bandwidth efficiency, and data integrity. @@ -38,7 +38,7 @@ The following Benchmarking results demonstrate that Nydus images significantly o - **On-demand Load**: Container images/packages are downloaded on-demand in chunk unit to boost startup. - **Chunk Deduplication**: Chunk level data de-duplication cross-layer or cross-image to reduce storage, transport, and memory cost. -- **Compatible with Ecosystem**: Storage backend support with Registry, OSS, NAS, Shared Disk, and [P2P service](https://d7y.io/). Compatible with the [OCI images](https://github.com/dragonflyoss/image-service/blob/master/docs/nydus-zran.md), and provide native [eStargz images](https://github.com/containerd/stargz-snapshotter) support. +- **Compatible with Ecosystem**: Storage backend support with Registry, OSS, NAS, Shared Disk, and [P2P service](https://d7y.io/). Compatible with the [OCI images](https://github.com/dragonflyoss/nydus/blob/master/docs/nydus-zran.md), and provide native [eStargz images](https://github.com/containerd/stargz-snapshotter) support. - **Data Analyzability**: Record accesses, data layout optimization, prefetch, IO amplification, abnormal behavior detection. - **POSIX Compatibility**: In-Kernel EROFS or FUSE filesystems together with overlayfs provide full POSIX compatibility - **I/O optimization**: Use merged filesystem tree, data prefetching and User I/O amplification to reduce read latency and improve user I/O performance. @@ -48,13 +48,13 @@ The following Benchmarking results demonstrate that Nydus images significantly o | Tool | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [nydusd](https://github.com/dragonflyoss/image-service/blob/master/docs/nydusd.md) | Nydus user-space daemon, it processes all fscache/FUSE messages from the kernel and parses Nydus images to fullfil those requests | -| [nydus-image](https://github.com/dragonflyoss/image-service/blob/master/docs/nydus-image.md) | Convert a single layer of OCI format container image into a nydus format container image generating meta part file and data part file respectively | -| [nydusify](https://github.com/dragonflyoss/image-service/blob/master/docs/nydusify.md) | It pulls OCI image down and unpack it, invokes `nydus-image create` to convert image and then pushes the converted image back to registry and data storage | -| [nydusctl](https://github.com/dragonflyoss/image-service/blob/master/docs/nydus-image.md) | Nydusd CLI client (`nydus-image inspect`), query daemon's working status/metrics and configure it | -| [ctr-remote](https://github.com/dragonflyoss/image-service/tree/master/contrib/ctr-remote) | An enhanced `containerd` CLI tool enable nydus support with `containerd` ctr | +| [nydusd](https://github.com/dragonflyoss/nydus/blob/master/docs/nydusd.md) | Nydus user-space daemon, it processes all fscache/FUSE messages from the kernel and parses Nydus images to fullfil those requests | +| [nydus-image](https://github.com/dragonflyoss/nydus/blob/master/docs/nydus-image.md) | Convert a single layer of OCI format container image into a nydus format container image generating meta part file and data part file respectively | +| [nydusify](https://github.com/dragonflyoss/nydus/blob/master/docs/nydusify.md) | It pulls OCI image down and unpack it, invokes `nydus-image create` to convert image and then pushes the converted image back to registry and data storage | +| [nydusctl](https://github.com/dragonflyoss/nydus/blob/master/docs/nydus-image.md) | Nydusd CLI client (`nydus-image inspect`), query daemon's working status/metrics and configure it | +| [ctr-remote](https://github.com/dragonflyoss/nydus/tree/master/contrib/ctr-remote) | An enhanced `containerd` CLI tool enable nydus support with `containerd` ctr | | [nydus-docker-graphdriver](https://github.com/nydusaccelerator/docker-nydus-graphdriver) | [Experimental] Works as a `docker` remote graph driver to control how images and containers are stored and managed | -| [nydus-overlayfs](https://github.com/dragonflyoss/image-service/tree/master/contrib/nydus-overlayfs) | `Containerd` mount helper to invoke overlayfs mount with tweaking mount options a bit. So nydus prerequisites can be passed to vm-based runtime | +| [nydus-overlayfs](https://github.com/dragonflyoss/nydus/tree/master/contrib/nydus-overlayfs) | `Containerd` mount helper to invoke overlayfs mount with tweaking mount options a bit. So nydus prerequisites can be passed to vm-based runtime | | [nydus-backend-proxy](./contrib/nydus-backend-proxy/README.md) | A simple HTTP server to serve local directory as a blob backend for nydusd | ### Supported platforms @@ -66,7 +66,7 @@ The following Benchmarking results demonstrate that Nydus images significantly o | Distribution | [Dragonfly](https://github.com/dragonflyoss/Dragonfly2) | Improve the runtime performance of Nydus image even further with the Dragonfly P2P data distribution system | βœ… | | Build | [Buildkit](https://github.com/moby/buildkit/blob/master/docs/nydus.md) | Provides the ability to build and export Nydus images directly from Dockerfile | βœ… | | Build/Runtime | [Nerdctl](https://github.com/containerd/nerdctl/blob/master/docs/nydus.md) | The containerd client to build or run (requires nydus snapshotter) Nydus image | βœ… | -| Runtime | [Docker / Moby](https://github.com/dragonflyoss/image-service/blob/master/docs/docker-env-setup.md) | Run Nydus image in Docker container with containerd and nydus-snapshotter | βœ… | +| Runtime | [Docker / Moby](https://github.com/dragonflyoss/nydus/blob/master/docs/docker-env-setup.md) | Run Nydus image in Docker container with containerd and nydus-snapshotter | βœ… | | Runtime | [Kubernetes](https://github.com/containerd/nydus-snapshotter/blob/main/docs/run_nydus_in_kubernetes.md) | Run Nydus image using CRI interface | βœ… | | Runtime | [Containerd](https://github.com/containerd/nydus-snapshotter) | Nydus Snapshotter, a containerd remote plugin to run Nydus image | βœ… | | Runtime | [CRI-O / Podman](https://github.com/containers/nydus-storage-plugin) | Run Nydus image with CRI-O or Podman | 🚧 | @@ -152,7 +152,7 @@ Using the key features of nydus as native in your project without preparing and ## Documentation -Please visit [**Wiki**](https://github.com/dragonflyoss/image-service/wiki), or [**docs**](./docs) +Please visit [**Wiki**](https://github.com/dragonflyoss/nydus/wiki), or [**docs**](./docs) ## Community diff --git a/docs/containerd-env-setup.md b/docs/containerd-env-setup.md index 7a1c14db5e3..fd610be593d 100644 --- a/docs/containerd-env-setup.md +++ b/docs/containerd-env-setup.md @@ -4,7 +4,7 @@ This document will walk through how to setup a nydus image service to work with ## Install All Nydus Binaries -1. Get `nydus-image`, `nydusd`, `nydusify`, `nydusctl` and `nydus-overlayfs` binaries from [release](https://github.com/dragonflyoss/image-service/releases/latest) page. +1. Get `nydus-image`, `nydusd`, `nydusify`, `nydusctl` and `nydus-overlayfs` binaries from [release](https://github.com/dragonflyoss/nydus/releases/latest) page. ```bash sudo install -D -m 755 nydusd nydus-image nydusify nydusctl nydus-overlayfs /usr/bin @@ -169,7 +169,7 @@ Note: For private registry repo, please make sure you are authorized to pull and sudo nydusify convert --source ubuntu --target localhost:5000/ubuntu-nydus ``` -For more details about how to build nydus image, please refer to [Nydusify](https://github.com/dragonflyoss/image-service/blob/master/docs/nydusify.md) conversion tool, [Acceld](https://github.com/goharbor/acceleration-service) conversion service or [Nerdctl](https://github.com/containerd/nerdctl/blob/master/docs/nydus.md#build-nydus-image-using-nerdctl-image-convert). +For more details about how to build nydus image, please refer to [Nydusify](https://github.com/dragonflyoss/nydus/blob/master/docs/nydusify.md) conversion tool, [Acceld](https://github.com/goharbor/acceleration-service) conversion service or [Nerdctl](https://github.com/containerd/nerdctl/blob/master/docs/nydus.md#build-nydus-image-using-nerdctl-image-convert). ## Try Nydus with `nerdctl` diff --git a/docs/docker-env-setup.md b/docs/docker-env-setup.md index bee42f5a91c..b12bec02f58 100644 --- a/docs/docker-env-setup.md +++ b/docs/docker-env-setup.md @@ -23,11 +23,11 @@ wget -O /etc/nydus/nydusd-config.json https://raw.githubusercontent.com/containe wget -O /etc/nydus/config.toml https://raw.githubusercontent.com/containerd/nydus-snapshotter/"$TAG"/misc/snapshotter/config.toml ``` -3. Download nydus image service release tarball from [the release page](https://github.com/dragonflyoss/image-service/releases). +3. Download nydus image service release tarball from [the release page](https://github.com/dragonflyoss/nydus/releases). ``` # Get the latest version. If this version does not work for you, you can try v2.1.4 -TAG=`curl -s https://api.github.com/repos/dragonflyoss/image-service/releases/latest | grep tag_name | cut -f4 -d "\""` -wget https://github.com/dragonflyoss/image-service/releases/download/"$TAG"/nydus-static-"$TAG"-linux-amd64.tgz +TAG=`curl -s https://api.github.com/repos/dragonflyoss/nydus/releases/latest | grep tag_name | cut -f4 -d "\""` +wget https://github.com/dragonflyoss/nydus/releases/download/"$TAG"/nydus-static-"$TAG"-linux-amd64.tgz tar -xzvf nydus-static-"$TAG"-linux-amd64.tgz sudo install -D -m 755 nydus-static/* /usr/local/bin ``` diff --git a/docs/nydus-image.md b/docs/nydus-image.md index b264f05a2ad..2b9a8e7da42 100644 --- a/docs/nydus-image.md +++ b/docs/nydus-image.md @@ -14,7 +14,7 @@ Therefore, a RAFS file system may consist of the following parts: ## Installation -Get latest `nydus-image` binary from [release](https://github.com/dragonflyoss/image-service/releases/latest) page. +Get latest `nydus-image` binary from [release](https://github.com/dragonflyoss/nydus/releases/latest) page. ## Nydus Image Builder @@ -257,7 +257,7 @@ dm-verity options: --no-superblock --format=1 -s "" --hash=sha256 --data-block-s [root@image-service]# lsblk NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT loop1 7:1 0 2.4M 0 loop -└─verity 252:0 0 2.2M 1 crypt /root/image-service/mnt +└─verity 252:0 0 2.2M 1 crypt /root/nydus/mnt [root@image-service]# mount -t erofs -r /dev/dm-0 mnt/ ``` diff --git a/docs/nydus-zran.md b/docs/nydus-zran.md index 64116becdcc..68ac379a296 100644 --- a/docs/nydus-zran.md +++ b/docs/nydus-zran.md @@ -19,7 +19,7 @@ A simple test result is shown below: ## Generate nydus zran artifact -1. Get nydus components `nydusd`, `nydus-image`, `nydusify` from [release](https://github.com/dragonflyoss/image-service/releases) page (requires >= v2.2). +1. Get nydus components `nydusd`, `nydus-image`, `nydusify` from [release](https://github.com/dragonflyoss/nydus/releases) page (requires >= v2.2). ``` sudo install -D -m 755 nydusd nydus-image nydusify /usr/bin @@ -43,7 +43,7 @@ sudo nydusify convert --oci-ref --source your-registry.com/node:19.0 --target yo - Nydus ZRAN artifacts must be in the same namespace with the OCI image. ## Run nydus zran artifact: -Follow the [documentation](https://github.com/dragonflyoss/image-service/blob/master/docs/containerd-env-setup.md) to configure `containerd` and `nydus-snapshotter` (containerd-nydus-grpc): +Follow the [documentation](https://github.com/dragonflyoss/nydus/blob/master/docs/containerd-env-setup.md) to configure `containerd` and `nydus-snapshotter` (containerd-nydus-grpc): ``` bash # Run nydus zran artifact diff --git a/docs/nydusd.md b/docs/nydusd.md index 17b886e8d7a..6697bb326f0 100644 --- a/docs/nydusd.md +++ b/docs/nydusd.md @@ -4,7 +4,7 @@ ### Get binary from release page -Get `nydusd` binary from [release](https://github.com/dragonflyoss/image-service/releases/latest) page. +Get `nydusd` binary from [release](https://github.com/dragonflyoss/nydus/releases/latest) page. ## Run Nydusd Daemon @@ -36,7 +36,7 @@ EOF ``` ### Run With FUSE -If no `/path/to/bootstrap` is available, please refer to [nydus-image.md](https://github.com/dragonflyoss/image-service/blob/master/docs/nydus-image.md) for more details. +If no `/path/to/bootstrap` is available, please refer to [nydus-image.md](https://github.com/dragonflyoss/nydus/blob/master/docs/nydus-image.md) for more details. ``` shell sudo mkdir -p /var/lib/nydus/blobs/ @@ -51,7 +51,7 @@ sudo nydusd \ For registry backend, we can set authorization with environment variable `IMAGE_PULL_AUTH` to avoid loading `auth` from nydusd configuration file. ### Run With Virtio-FS -If no `/path/to/bootstrap` is available, please refer to [nydus-image.md](https://github.com/dragonflyoss/image-service/blob/master/docs/nydus-image.md) for more details. +If no `/path/to/bootstrap` is available, please refer to [nydus-image.md](https://github.com/dragonflyoss/nydus/blob/master/docs/nydus-image.md) for more details. Virtio-fs is supported by both [QEMU](https://www.qemu.org/) and [Cloud-hypervisor](https://github.com/cloud-hypervisor/cloud-hypervisor). To run `nydusd` with virtio-fs support, first start it with `--sock` option to expose a virtio-fs socket endpoint. diff --git a/docs/nydusify.md b/docs/nydusify.md index 606da580f4d..935d49bb368 100644 --- a/docs/nydusify.md +++ b/docs/nydusify.md @@ -6,7 +6,7 @@ The Nydusify CLI tool supports: ### Get binaries from release page -Get `nydus-image`, `nydusd` and `nydusify` binaries from [release](https://github.com/dragonflyoss/image-service/releases/latest) page and install them to system PATH like `/usr/bin` or `/usr/local/bin`. +Get `nydus-image`, `nydusd` and `nydusify` binaries from [release](https://github.com/dragonflyoss/nydus/releases/latest) page and install them to system PATH like `/usr/bin` or `/usr/local/bin`. ## Basic Usage From 5b5ece2770d9be49e85d653fa8588d5f916b1027 Mon Sep 17 00:00:00 2001 From: Yadong Ding Date: Tue, 31 Oct 2023 13:18:08 +0800 Subject: [PATCH 2/2] action: rename images-service to nydus Signed-off-by: Yadong Ding --- .github/workflows/smoke.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/smoke.yml b/.github/workflows/smoke.yml index 4cc7573eeb7..4982c6a13fa 100644 --- a/.github/workflows/smoke.yml +++ b/.github/workflows/smoke.yml @@ -155,7 +155,7 @@ jobs: version=${versions[$i]} version_arch=${version_archs[$i]} - wget -q https://github.com/dragonflyoss/image-service/releases/download/$version/nydus-static-$version_arch.tgz + wget -q https://github.com/dragonflyoss/nydus/releases/download/$version/nydus-static-$version_arch.tgz sudo mkdir nydus-$version /usr/bin/nydus-$version sudo tar xzf nydus-static-$version_arch.tgz -C nydus-$version sudo cp -r nydus-$version/nydus-static/* /usr/bin/nydus-$version/