Skip to content

Commit

Permalink
docs: typo README
Browse files Browse the repository at this point in the history
  • Loading branch information
zjregee committed Aug 24, 2024
1 parent 594805d commit df82268
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
# OVFS, OpenDAL File System via Virtio

OVFS is a backend implementation of VirtioFS. It provides a file system interface for VMs based on OpenDAL, aiming to accelerate VMs IO performance by VirtIO and seamlessly connect with various storage backends.
OVFS is a backend implementation of VirtioFS. It provides a filesystem interface for VMs based on [Apache OpenDAL](https://github.com/apache/opendal), aiming to accelerate VMs IO performance by VirtIO and seamlessly connect with various storage backends.

<div style="text-align: center">
<img src="./docs/proposal/media/architecture.png" width="600" height="450" alt="OVFS Architecture">
</div>
![OVFS Architecture](./docs/proposal/media/architecture.png)

## How to Use

The following components are required:
- Rust environment on the host to run OVFS
- QEMU 4.2 or later for built-in VirtioFS support
- A Linux 5.4 or later guest kernel for built-in VirtioFS support
- Rust environment on the host to run OVFS.
- QEMU 4.2 or later for built-in VirtioFS support.
- A Linux 5.4 or later guest kernel for built-in VirtioFS support.

### Install QEMU and VMs

Expand All @@ -24,18 +22,21 @@ Download and install the VM, taking Ubuntu as an example:
```shell
wget https://releases.ubuntu.com/20.04/ubuntu-20.04.6-live-server-amd64.iso
truncate -s 10G image.img
sudo qemu-system-x86_64 -enable-kvm -smp 2 -m 4G -cdrom ubuntu-20.04.6-live-server-amd64.iso -drive file=image.img,format=raw,cache=none,if=virtio -boot d
sudo qemu-system-x86_64 -enable-kvm -smp 2 -m 4G \
-cdrom ubuntu-20.04.6-live-server-amd64.iso \
-drive file=image.img,format=raw,cache=none,if=virtio \
-boot d
```

### Mount shared directory on VMs

Run ovfs and set the listening socket path and service configuration used:
Run OVFS and set the listening socket path and service configuration used:

```shell
host# cargo run --release <socket-path> <backend-url>
```

backend-url is the URL that includes the scheme and parameters of the service used, in the following format:
`backend-url` is the URL that includes the scheme and parameters of the service used, in the following format:
- fs://?root=<directory>
- s3://?root=<path>&bucket=<bucket>&endpoint=<endpoint>&region=<region>&access_key_id=<access-key-id>&secret_access_key=<secret-access-key>

Expand All @@ -56,6 +57,8 @@ Mount a shared directory in the VM:
guest# sudo mount -t virtiofs <fs-tag> <mount-point>
```

For more examples, please refer to the test scripts in github actions of this repository.

## Periodic Reports During GSoC 2024
- [05.12-05.19](./docs/reports/05.12-05.19.md)
- [05.20-06.02](./docs/reports/05.20-06.02.md)
Expand Down

0 comments on commit df82268

Please sign in to comment.