diff --git a/docs/kmesh_deploy_and_develop_in_kind.md b/docs/kmesh_deploy_and_develop_in_kind.md index c720bde24..e0c65f353 100644 --- a/docs/kmesh_deploy_and_develop_in_kind.md +++ b/docs/kmesh_deploy_and_develop_in_kind.md @@ -1,6 +1,6 @@ # Kmesh Deploy and Develop in Kind -[Kind](https://github.com/kubernetes-sigs/kind) is a convenient tool for quickly deploying kubernetes cluster locally. We can use `kind` to create an `istio` cluster and deploy `kmesh` on it. +[Kind](https://github.com/kubernetes-sigs/kind) is a convenient tool for quickly deploying kubernetes cluster locally. We can use `kind` to create an `istio` cluster and deploy `kmesh`. ## Deploy Kmesh in Kind @@ -143,7 +143,7 @@ You can follow the steps below to develop in kind: make clean ``` - to cleanup this changes before you execute `git add` command. + to cleanup these changes before you execute `git add` command. ## Reference + Getting Started: https://istio.io/latest/docs/ambient/getting-started/ diff --git a/docs/kmesh_use_enhanced_kernel.md b/docs/kmesh_use_enhanced_kernel.md new file mode 100644 index 000000000..ed2adc855 --- /dev/null +++ b/docs/kmesh_use_enhanced_kernel.md @@ -0,0 +1,30 @@ +# Use Enhanced Kernel in Kmesh + +Some features of kmesh depend on enhanced kernel (e.g., L7 traffic control in ads mode). To utilize it, you can use `openEuler 23.03`, which natively supports all features. + +You can follow the steps below to use enhanced kernel: + ++ Download `openEuler 23.03` image on: https://repo.openeuler.org/openEuler-23.03/ISO/. ++ Install the operation system: Here, we take [VMware](https://www.vmware.com/products/workstation-pro/html.html) for example (you can also use other VM management tools). + + ![](./pics/install_openEuler.png) + + Notice that `openEuler 23.03`'s kernel version is **6.1.19**. So you should select `其他 Linux 6.x 内核 64位`(`Linux 6.x kernel 64bit`). + + Then, you can follow the [official blog](https://www.openeuler.org/zh/blog/20240306vmware/20240306vmware.html) to install it. + ++ Install kernel headers: Kmesh determines whether the enhanced kernel is utilized according to some kernel headers(e.g., `bpf.h`). So, you should install kernel headers by: + + ```shell + yum install kernel-headers + ``` + + Then, you should be able to find the kernel headers in the path `/usr/include/linux`. + ++ Check whether you are ready to use enhanced kernel: + + ```shell + grep -q "FN(parse_header_msg)" /usr/include/linux/bpf.h && echo "enhanced" || echo "unenhanced" + ``` + +Now you can follow the [deploy and develop guide](./kmesh_deploy_and_develop_in_kind.md) to explore kmesh's full features. \ No newline at end of file diff --git a/docs/pics/install_openEuler.png b/docs/pics/install_openEuler.png new file mode 100644 index 000000000..44ca2e116 Binary files /dev/null and b/docs/pics/install_openEuler.png differ