Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: a few improvements #12

Merged
merged 1 commit into from
Oct 22, 2020
Merged

docs: a few improvements #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ specification. Its key features include:
* Only usable image data is saved when building a container image
* Only usable image data is downloaded when running a container
* End-to-end image data integrity
* Compactible with the OCI artifacts spec and distribution spec
* Compatible with the OCI artifacts spec and distribution spec
* Integrated with existing CNCF project Dragonfly to support image distribution in large clusters
* Different container image storage backends are supported

Expand Down Expand Up @@ -39,4 +39,4 @@ Convert OCI image to Nydus image: [Nydusify](./docs/nydusify.md).

## Run Nydusd Daemon

Run Nydusd Daemon to serve Nydus image: [Nydusd](./docs/nydusd.md).
Run `nydusd` Daemon to serve Nydus image: [Nydusd](./docs/nydusd.md).
8 changes: 6 additions & 2 deletions docs/nydusd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Nydusd

`nydusd` running as daemon to expose a FUSE mountpoint or a Virtio-FS mountpoint inside guest for containers to access
`nydusd` running as daemon to expose a [FUSE](https://www.kernel.org/doc/html/latest/filesystems/fuse.html) mountpoint or a [Virtio-FS](https://virtio-fs.gitlab.io/) mountpoint inside guest for containers to access.

## Run Nydusd Daemon

Expand Down Expand Up @@ -31,6 +31,8 @@ sudo target-fusedev/debug/nydusd \

### Run With Virtio-FS

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.

``` shell
sudo target-virtiofsd/debug/nydusd \
--config /path/to/config-localfs.json \
Expand All @@ -39,7 +41,7 @@ sudo target-virtiofsd/debug/nydusd \
--log-level info
```

To start a qemu process, run something like:
Then start a qemu process with a `vhost-user-fs-pci` device, run something like:

``` shell
./qemu-system-x86_64 -M pc -cpu host --enable-kvm -smp 2 \
Expand All @@ -65,6 +67,8 @@ Or simply below if you are running newer guest kernel:
mount -t virtiofs nydus /mnt
```

We are working on enabling cloud-hypervisor support for nydus.

### Nydus Configuration

#### Common Fields In Config
Expand Down