From 959f205432d7fd3c493d34e2dc3aeef4d3d95cf2 Mon Sep 17 00:00:00 2001 From: Ziyi Tan Date: Wed, 29 May 2024 16:46:13 +0800 Subject: [PATCH] Docs: Update installation URL of WasmEdge Signed-off-by: Ziyi Tan --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 77a508f3..905bc0ab 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ Kuasar is an efficient container runtime that provides cloud-native, all-scenari | App Kernel | gVisor | Planned in 2024 | | | Quark | Supported | | runC | runC | Supported | + # Why Kuasar? In the container world, a sandbox is a technique used to separate container processes from each other, and from the operating system itself. After the introduction of the [Sandbox API](https://github.com/containerd/containerd/issues/4131), sandbox has become the first-class citizen in containerd. With more and more sandbox techniques available in the container world, a management service called "sandboxer" is expected to be proposed. @@ -100,24 +101,25 @@ The performance of Kuasar is measured by two metrics: We used the Cloud Hypervisor in the benchmark test and tested the startup time of 100 PODs under both serial and parallel scenario. The result demonstrates that Kuasar outperforms open-source [Kata-containers](https://github.com/kata-containers/kata-containers) in terms of both startup speed and memory consumption. -For detailed test scripts, test data, and results, please refer to the [benchmark test](tests/benchmark/Benchmark.md). +For detailed test scripts, test data, and results, please refer to the [benchmark test](tests/benchmark/Benchmark.md). # Quick Start ## Prerequisites ### 1. OS -The minimum versions of Linux distributions supported by Kuasar are *Ubuntu 22.04* or *CentOS 8* or openEuler 23.03. + +The minimum versions of Linux distributions supported by Kuasar are *Ubuntu 22.04* or *CentOS 8* or openEuler 23.03. Please also note that Quark requires a Linux kernel version >= 5.15. ### 2. Sandbox -+ MicroVM: To launch a microVM-based sandbox, a hypervisor must be installed on the **virtualization-enabled** host. ++ MicroVM: To launch a microVM-based sandbox, a hypervisor must be installed on the **virtualization-enabled** host. + It is recommended to install Cloud Hypervisor by default. You can find Cloud Hypervisor installation instructions [here](https://github.com/cloud-hypervisor/cloud-hypervisor/blob/main/docs/building.md). + If you want to run kuasar with iSulad container engine and StratoVirt hypervisor, you can refer to this guide [how-to-run-kuasar-with-isulad-and-stratovirt](docs/vmm/how-to-run-kuasar-with-isulad-and-stratovirt.md). + Quark: To use Quark, please refer to the installation instructions [here](docs/quark/README.md). -+ WasmEdge: To start WebAssembly sandboxes, you need to install WasmEdge v0.13.5. Instructions for installing WasmEdge can be found in [install.html](https://wasmedge.org/book/en/quick_start/install.html). ++ WasmEdge: To start WebAssembly sandboxes, you need to install WasmEdge v0.13.5. Instructions for installing WasmEdge can be found in [install-a-specific-version-of-wasmedge](https://wasmedge.org/docs/start/install/#install-a-specific-version-of-wasmedge). ### 3. containerd @@ -179,8 +181,8 @@ Since Kuasar is a low-level container runtime, all interactions should be done v If you have questions, feel free to reach out to us in the following ways: -- [mailing list](https://groups.google.com/forum/#!forum/kuasar) -- [slack](https://cloud-native.slack.com/archives/C052JRURD8V) | [Join](https://slack.cncf.io/) ++ [mailing list](https://groups.google.com/forum/#!forum/kuasar) ++ [slack](https://cloud-native.slack.com/archives/C052JRURD8V) | [Join](https://slack.cncf.io/) # Contributing @@ -190,4 +192,4 @@ If you're interested in being a contributor and want to get involved in developi Kuasar is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details. -Kuasar documentation is under the [CC-BY-4.0 license](https://creativecommons.org/licenses/by/4.0/legalcode). \ No newline at end of file +Kuasar documentation is under the [CC-BY-4.0 license](https://creativecommons.org/licenses/by/4.0/legalcode).