Merge pull request #185 from morningtzh/for1.0.1

[release/1.0] Prepare release for v1.0.1

Author: abel-von

.github/workflows/ci.yml

@@ -29,6 +29,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - run: rustup toolchain install nightly --component rustfmt
+      - run: rustup show
       - name: Install Protoc
         uses: arduino/setup-protoc@v1.1.2
         with:

Makefile

@@ -9,6 +9,14 @@ INSTALL_DIR := /var/lib/kuasar
 BIN_DIR := /usr/local/bin
 SYSTEMD_SERVICE_DIR := /usr/lib/systemd/system
 SYSTEMD_CONF_DIR := /etc/sysconfig
+ENABLE_YOUKI ?= false
+RUNC_FEATURES =
+VMM_TASK_FEATURES =
+
+ifeq ($(ENABLE_YOUKI), true)
+	RUNC_FEATURES = youki
+	VMM_TASK_FEATURES = youki
+endif
 
 .PHONY: vmm wasm quark clean all install-vmm install-wasm install-quark install \
         bin/vmm-sandboxer bin/vmm-task bin/vmlinux.bin bin/kuasar.img bin/kuasar.initrd \
@@ -21,7 +29,7 @@ bin/vmm-sandboxer:
 	@mkdir -p bin && cp vmm/sandbox/target/release/${HYPERVISOR} bin/vmm-sandboxer
 
 bin/vmm-task:
-	@cd vmm/task && cargo build --release --target=${ARCH}-unknown-linux-musl
+	@cd vmm/task && cargo build --release --target=${ARCH}-unknown-linux-musl --features=${VMM_TASK_FEATURES}
 	@mkdir -p bin && cp vmm/task/target/${ARCH}-unknown-linux-musl/release/vmm-task bin/vmm-task
 
 bin/vmlinux.bin:
@@ -45,17 +53,18 @@ bin/quark-sandboxer:
 	@mkdir -p bin && cp quark/target/release/quark-sandboxer bin/quark-sandboxer
 
 bin/runc-sandboxer:
-	@cd runc && cargo build --release
+	@cd runc && cargo build --release --features=${RUNC_FEATURES}
 	@mkdir -p bin && cp runc/target/release/runc-sandboxer bin/runc-sandboxer
 
 wasm: bin/wasm-sandboxer
 quark: bin/quark-sandboxer
 runc: bin/runc-sandboxer
 
-ifeq ($(HYPERVISOR), stratovirt)
-vmm: bin/vmm-sandboxer bin/kuasar.initrd bin/vmlinux.bin
-else
+ifeq ($(HYPERVISOR), cloud_hypervisor)
 vmm: bin/vmm-sandboxer bin/kuasar.img bin/vmlinux.bin
+else
+# stratovirt or qemu
+vmm: bin/vmm-sandboxer bin/kuasar.initrd bin/vmlinux.bin
 endif
 
 clean:
@@ -76,12 +85,13 @@ install-vmm:
 	@install -d -m 750 ${DEST_DIR}${SYSTEMD_CONF_DIR}
 	@install -p -m 640 vmm/service/kuasar-vmm ${DEST_DIR}${SYSTEMD_CONF_DIR}/kuasar-vmm
 
-ifeq ($(HYPERVISOR), stratovirt)
-	@install -p -m 640 bin/kuasar.initrd ${DEST_DIR}${INSTALL_DIR}/kuasar.initrd
-	@install -p -m 640 vmm/sandbox/config_stratovirt_${ARCH}.toml ${DEST_DIR}${INSTALL_DIR}/config_stratovirt.toml
-else
+ifeq ($(HYPERVISOR), cloud_hypervisor)
 	@install -p -m 640 bin/kuasar.img ${DEST_DIR}${INSTALL_DIR}/kuasar.img
-	@install -p -m 640 vmm/sandbox/config_clh.toml ${DEST_DIR}${INSTALL_DIR}/config_clh.toml
+	@install -p -m 640 vmm/sandbox/config_clh.toml ${DEST_DIR}${INSTALL_DIR}/config.toml
+else
+# stratovirt or qemu
+	@install -p -m 640 bin/kuasar.initrd ${DEST_DIR}${INSTALL_DIR}/kuasar.initrd
+	@install -p -m 640 vmm/sandbox/config_${HYPERVISOR}_${ARCH}.toml ${DEST_DIR}${INSTALL_DIR}/config.toml
 endif
 
 install-wasm:

README.md

@@ -169,7 +169,7 @@ Since Kuasar is a low-level container runtime, all interactions should be done v
 
 + For vmm, quark or runc, run the following scripts:
 
-  `examples/run_example_container.sh vmm`, `examples/run_example_container.sh quark` or `examples/run_example_container.sh runc`
+  `examples/run_example_container.sh kuasar-vmm`, `examples/run_example_container.sh kuasar-quark` or `examples/run_example_container.sh kuasar-runc`
 
 + For wasm: Wasm container needs its own container image so our script has to build and import the container image at first.
 

docs/wasm/How-to-run-Llama-3-8B-with-Kubernetes.md

@@ -10,7 +10,7 @@ details in: https://www.secondstate.io/articles/wasm-runtime-agi/.
 
 ## How to run a llm inference application in Kuasar?
 
-Since Kuasar v0.8.0, Kuasar wasm-sandboxer with `wasmedge` and `wasmedge_wasi_nn` 
+Since Kuasar v1.0.0, Kuasar wasm-sandboxer with `wasmedge` and `wasmedge_wasi_nn` 
 features allows your WasmEdge application use the ability of WASI API for
 performing Machine Learning inference: https://github.com/WebAssembly/wasi-nn.
 
@@ -22,7 +22,6 @@ which introducing how to create an OpenAI-compatible API service for Llama-3-8B.
 + Install WasmEdge and plugins: 
 `curl -sSf https://raw.githubusercontent.com/WasmEdge/WasmEdge/master/utils/install.sh | bash -s -- -v 0.13.5 --plugins wasi_logging wasi_nn-ggml`
 
-
 ### 1. Build docker image
 
 We already have an example docker image on dockerhub: `docker.io/kuasario/llama-api-server:v1`.
@@ -50,6 +49,18 @@ CMD ["llama-api-server.wasm", "--prompt-template", "llama-3-chat", "--ctx-size",
 ```
 Build it with `docker build -t docker.io/kuasario/llama-api-server:v1 .`
 
+Otherwise, you can use this DOCKERFILE if you are debugging while developing:
+```dockerfile
+FROM ubuntu:22.04
+RUN apt-get update && apt-get install -y curl
+RUN curl -LO https://huggingface.co/second-state/Llama-3-8B-Instruct-GGUF/resolve/main/Meta-Llama-3-8B-Instruct-Q5_K_M.gguf
+RUN curl -LO https://github.com/second-state/chatbot-ui/releases/latest/download/chatbot-ui.tar.gz; tar xzf chatbot-ui.tar.gz; rm chatbot-ui.tar.gz
+COPY *.wasm .
+```
+
+This would download all prerequisites to docker image cache, allowing you pay attention only on development.
+`docker build -f Dockerfile -t docker.io/kuasario/llama-api-server:v2 $path_to_app`
+
 ### 2. Build and run Kuasar Wasm Sandboxer
 
 ```bash

runc/src/sandbox.rs

@@ -165,18 +165,19 @@ impl Sandboxer for RuncSandboxer {
         let mut sandbox = sandbox.lock().await;
         let mut sandbox_parent = self.sandbox_parent.lock().await;
         let sandbox_pid = sandbox_parent.fork_sandbox_process(id, &sandbox.data.netns)?;
-        sandbox.prepare_sandbox_ns(sandbox_pid).await.map_err(|e| {
-            kill(Pid::from_raw(sandbox_pid), Signal::SIGKILL).unwrap_or_default();
-            e
-        })?;
+        sandbox
+            .prepare_sandbox_ns(sandbox_pid)
+            .await
+            .inspect_err(|_| {
+                kill(Pid::from_raw(sandbox_pid), Signal::SIGKILL).unwrap_or_default();
+            })?;
 
         sandbox
             .data
             .task_address
             .clone_from(&format!("ttrpc+{}", self.task_address));
-        sandbox.dump().await.map_err(|e| {
+        sandbox.dump().await.inspect_err(|_| {
             kill(Pid::from_raw(sandbox_pid), Signal::SIGKILL).unwrap_or_default();
-            e
         })?;
         Ok(())
     }

rust-toolchain.toml

@@ -0,0 +1,3 @@
+[toolchain]
+channel = "1.81"
+components = ["rustfmt", "clippy", "llvm-tools"]

vmm/common/Cargo.toml

@@ -18,7 +18,16 @@ ttrpc = { version = "0.7", features = ["async"] }
 protobuf = "3.2"
 async-trait = "0.1"
 regex = "1.5.6"
+futures = { version = "0.3.21" }
+signal-hook-tokio = { version = "0.3.1", features = ["futures-v0_3"] }
+
+tracing = "0.1.40"
+tracing-opentelemetry = "0.21.0"
+tracing-subscriber = { version = "0.3.18", features = ["env-filter"] }
+
+opentelemetry = { version = "0.20.0", features = ["rt-tokio"] }
+opentelemetry-otlp = "0.13.0"
 
 [build-dependencies]
 ttrpc-codegen = { git = "https://github.com/kuasar-io/ttrpc-rust.git", branch = "v0.7.1-kuasar" }
-tonic-build = "0.7.2"
+tonic-build = "0.7.2"

vmm/common/build.rs

@@ -14,6 +14,8 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+use std::fs;
+
 use ttrpc_codegen::{Codegen, Customize, ProtobufCustomize};
 
 fn main() {
@@ -45,4 +47,24 @@ fn main() {
         )
         .run()
         .expect("Gen protos code failed");
+
+    // Protobuf-rust 3.5.1 no longer generates the `#![allow(box_pointers)]` lint.
+    // However, ttrpc-rust has not yet upgraded to protobuf-rust 3.5.1.
+    // As a temporary measure, we are modifying the files to suppress the warning.
+    remove_box_pointers("src/api").expect("Remove api box_pointer failed");
+}
+
+fn remove_box_pointers(dir: &str) -> std::io::Result<()> {
+    for entry in fs::read_dir(dir)? {
+        let entry = entry?;
+        let path = entry.path();
+
+        if path.is_file() {
+            let content = fs::read_to_string(&path)?;
+            let new_content = content.replace("#![allow(box_pointers)]", "");
+
+            fs::write(path, new_content)?;
+        }
+    }
+    Ok(())
 }

vmm/common/src/lib.rs

@@ -18,7 +18,9 @@ pub use containerd_sandbox::data::Io;
 
 pub mod api;
 pub mod mount;
+pub mod signal;
 pub mod storage;
+pub mod trace;
 
 pub const KUASAR_STATE_DIR: &str = "/run/kuasar/state";
 

vmm/common/src/signal.rs

@@ -0,0 +1,34 @@
+/*
+Copyright 2024 The Kuasar Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+use futures::StreamExt;
+use nix::libc;
+use signal_hook_tokio::Signals;
+
+use crate::trace;
+
+pub async fn handle_signals(log_level: &str, otlp_service_name: &str) {
+    let mut signals = Signals::new([libc::SIGUSR1])
+        .expect("new signal failed")
+        .fuse();
+
+    while let Some(sig) = signals.next().await {
+        if sig == libc::SIGUSR1 {
+            trace::set_enabled(!trace::is_enabled());
+            let _ = trace::setup_tracing(log_level, otlp_service_name);
+        }
+    }
+}