docs: add the description of systems currently supported by Kmesh

chuntaojun · Nov 2, 2023 · 4064eab · 4064eab
1 parent ed47cfe
commit 4064eab
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 19 deletions.
diff --git a/docs/kmesh_compile-zh.md b/docs/kmesh_compile-zh.md
@@ -2,15 +2,10 @@
 
 ## 准备工作
 
-Kmesh需要在拥有Kmesh内核增强特性的linux环境上编译构建；当前可以原生支持kmesh的内核见[kmesh_support.md](kmesh_support.md)；
+Kmesh需要在拥有Kmesh内核增强特性的Linux环境中编译构建。当前可以在多个操作系统中编译和运行Kmesh，具体操作系统版本可以参见[Kmesh支持系统](kmesh_support-zh.md)。
 
 ## 编译构建
 
-### 内核编译
-
-编译完整支持kmesh能力的内核，请参考[内核编译](kmesh_kernel_compile-zh.md)文档
-
-
 ### 源码编译
 
 - 代码下载

diff --git a/docs/kmesh_compile.md b/docs/kmesh_compile.md
@@ -2,14 +2,10 @@
 
 ## prerequisite
 
-The Kmesh needs to be compiled and built in the Linux environment with the Kmesh kernel enhancement feature. Currently, natively supported kmesh kernel see [kmesh_support](kmesh_support.md) document.
+The Kmesh needs to be compiled and built in the Linux environment with the Kmesh kernel enhancement feature. Currently, Kmesh can be compiled and run in multiple OS versions, and the specific OS versions can see [Kmesh support system](kmesh_support.md).
 
 ## build
 
-### kernel build
-
-To build a kernel package that supports Kmesh, see the [kernel compilation](kmesh_kernel_compile.md) document.
-
 ### build from source
 
 - Code download

diff --git a/docs/kmesh_support-zh.md b/docs/kmesh_support-zh.md
@@ -1,5 +1,31 @@
-### Kmesh支持的OS列表
+### 原生支持所有特性
 
-| OS版本          | 发布路径                                    |
-| --------------- | ------------------------------------------- |
-| openEuler 23.03 | https://repo.openeuler.org/openEuler-23.03/ |
+在以下操作系统中可以直接编译和运行Kmesh的所有特性。
+
+| 操作系统版本    | 内核版本 | 操作系统发布路径                            |
+| :-------------: | :------: | :-----------------------------------------: |
+| openEuler-23.03 |  6.1.19  | https://repo.openeuler.org/openEuler-23.03/ |
+
+### 通过Kmesh增强内核支持所有特性
+
+在以下操作系统中，可以通过将Kmesh提供的内核补丁合入到这些操作系统对应内核中，然后重新编译内核，在安装了包含Kmesh内核补丁的内核之后，就可以编译并运行Kmesh的所有特性。构建支持Kmesh的内核包的方法，请参见[Kmesh内核编译](kmesh_kernel_compile-zh.md)。
+
+| 操作系统版本            | 内核版本       | 操作系统发布路径                                    |
+| :---------------------: | :------------: | :-------------------------------------------------: |
+| openEuler-22.03-LTS-SP1 |     5.10.0     | https://repo.openeuler.org/openEuler-22.03-LTS-SP1/ |
+
+### 原生支持部分特性
+
+在以下操作系统中，可以编译并运行表格中列出的对应特性。
+
+| 操作系统版本              | 内核版本       | Sockmap网格加速      | 四层代理 | 七层代理 |
+| :-----------------------: | :------------: | :------------------: | :------: | :------: |
+| Ubuntu Server 22.04.3 LTS |     5.15.0     |           √          |     √    |          |
+| openEuler-22.03-LTS-SP1   |     5.10.0     |           √          |     √    |          |
+
+**操作系统发布路径**:
+
+- openEuler: https://repo.openeuler.org/
+- Ubuntu: https://releases.ubuntu.com/
+
+**注**：以上列出的操作系统版本是经过Kmesh社区验证过的，但并不意味着不支持其他操作系统版本，Kmesh社区会继续刷新支持的操作系统版本列表。
diff --git a/docs/kmesh_support.md b/docs/kmesh_support.md
@@ -1,5 +1,31 @@
-### Supported OSs
+### Native support all feature
 
-| OS version      | Release Path                                |
-| --------------- | ------------------------------------------- |
-| openEuler 23.03 | https://repo.openeuler.org/openEuler-23.03/ |
+We can directly compile and run all features of Kmesh in the following OS.
+
+| OS Version      | Kernel Version | Release Path                                |
+| :-------------: | :------------: | :-----------------------------------------: |
+| openEuler-23.03 |     6.1.19     | https://repo.openeuler.org/openEuler-23.03/ |
+
+### Kmesh enhance kernel support all feature
+
+In the following OS, we can incorporate Kmesh kernel patches into the corresponding kernel of these OS, and then recompile the kernel. After installing the kernel containing the Kmesh kernel patches, we can compile and run all features of Kmesh. The method to build kernel package that supports Kmesh, see [Kmesh kernel compilation](kmesh_kernel_compile.md).
+
+| OS Version              | Kernel Version | OS Release Path                                     |
+| :---------------------: | :------------: | :-------------------------------------------------: |
+| openEuler-22.03-LTS-SP1 |     5.10.0     | https://repo.openeuler.org/openEuler-22.03-LTS-SP1/ |
+
+### Native support partial features
+
+In the following OS, we can compile and run the specific features listed in the table in the corresponding OS.
+
+| OS Version                | Kernel Version | Sockmap Accelerate   | L4 Proxy | L7 Proxy |
+| :-----------------------: | :------------: | :------------------: | :------: | :------: |
+| Ubuntu Server 22.04.3 LTS |     5.15.0     |           √          |     √    |          |
+| openEuler-22.03-LTS-SP1   |     5.10.0     |           √          |     √    |          |
+
+**OS release path**:
+
+- openEuler: https://repo.openeuler.org/
+- Ubuntu: https://releases.ubuntu.com/
+
+**Note**: The above listed OS versions have been verified by Kmesh community, which does not mean that other OS versions are not supported, Kmesh community will continue to refresh the supported list.