update readme (#2458)

* update readme Signed-off-by: [email protected] <[email protected]> update Signed-off-by: [email protected] <[email protected]> update Signed-off-by: [email protected] <[email protected]> update Signed-off-by: [email protected] <[email protected]> update Signed-off-by: [email protected] <[email protected]> update Signed-off-by: [email protected] <[email protected]> * update Signed-off-by: [email protected] <[email protected]> * update Signed-off-by: [email protected] <[email protected]> * en doc: update readme and arch based on pr#2458 * fix errors * fix doc links * correct links * Update arch.png * update usage/readme --------- Signed-off-by: [email protected] <[email protected]> Co-authored-by: Jeanine-tw <[email protected]>
spidernet-io · Oct 27, 2023 · 6b92d6d · 6b92d6d
1 parent c8a03ae
commit 6b92d6d
Show file tree

Hide file tree

Showing 35 changed files with 995 additions and 1,151 deletions.
diff --git a/README-zh_CN.md b/README-zh_CN.md
diff --git a/README.md b/README.md
diff --git a/docs/README-zh_CN.md b/docs/README-zh_CN.md
@@ -44,7 +44,7 @@ Spiderpool 是一个 kubernetes 的 underlay 网络解决方案，它提供了
 云原生网络中出现了两种技术类别，"overlay 网络方案" 和 "underlay 网络方案"，
 云原生网络对于它们没有严格的定义，我们可以从很多 CNI 项目的实现原理中，简单抽象出这两种技术流派的特点，它们可以满足不同场景下的需求。
 
-[文章](./concepts/solution-zh_CN.md) 对两种方案的 IPAM 和网络性能做了简单比较，能够更好说明 Spiderpool 的特点和使用场景。
+[文章](./concepts/arch-zh_CN.md) 对两种方案的 IPAM 和网络性能做了简单比较，能够更好说明 Spiderpool 的特点和使用场景。
 
 为什么需要 underlay 网络解决方案？存在很多应用场景：
 
@@ -169,7 +169,7 @@ RDMA 功能使得网卡能够直接读写内存，降低了 CPU 的负担和内
 
 ## 快速开始
 
-快速搭建 Spiderpool，启动一个应用，可参考[快速搭建](./usage/install/install.md)。
+快速搭建 Spiderpool，启动一个应用，可参考[快速搭建](./usage/readme-zh_CN.md)。
 
 ## 功能
 
@@ -231,22 +231,22 @@ RDMA 功能使得网卡能够直接读写内存，降低了 CPU 的负担和内
 
 * 以最佳实践的 CNI 配置来便捷地生成 [Multus](https://github.com/k8snetworkplumbingwg/multus-cni)
   NetworkAttachmentDefinition 实例，并且保证其正确的 JSON 格式来提高使用体验。
-  可参考[例子](./concepts/mulltusconfig-zh_CN.md)。
+  可参考[例子](./usage/spider-multus-config-zh_CN.md)。
 
 * 应用可设置多个 IP 池，实现 IP 资源的备用效果。可参考[例子](./usage/ippool-multi.md)。
 
 * 设置全局的预留 IP，让 IPAM 不分配出这些 IP 地址，这样能避免与集群外部的已用 IP 冲突。
   可参考[例子](./usage/reserved-ip.md)。
 
-* 分配和释放 IP 地址的高效性能，可参考[报告](./concepts/performance-zh_CN.md)。
+* 分配和释放 IP 地址的高效性能，可参考[报告](./concepts/ipam-performance-zh_CN.md)。
 
-* 合理的 IP 回收机制设计，使得集群或应用在故障恢复过程中，能够及时分配到 IP 地址。可参考[例子](./usage/gc.md)。
+* 合理的 IP 回收机制设计，使得集群或应用在故障恢复过程中，能够及时分配到 IP 地址。可参考[例子](./concepts/ipam-zh_CN.md)。
 
 * 所有的功能都能够在 ipv4-only、ipv6-only、dual-stack 场景下工作。可参考[例子](./usage/ipv6.md)。
 
 * 支持 AMD64 和 ARM64
 
-* [指标](./concepts/metrics.md)
+* [指标](./reference/metrics.md)
 
 ## Blogs
 
@@ -293,7 +293,7 @@ RDMA 功能使得网卡能够直接读写内存，降低了 CPU 的负担和内
 
 ## License
 
-Spiderpool is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text.
+Spiderpool is licensed under the Apache License, Version 2.0. See [LICENSE](../LICENSE) for the full license text.
 
 <p align="center">
 <img src="https://landscape.cncf.io/images/left-logo.svg" width="300"/>&nbsp;&nbsp;<img src="https://landscape.cncf.io/images/right-logo.svg" width="350"/>

diff --git a/docs/README.md b/docs/README.md
@@ -56,7 +56,7 @@ Despite no strict definition for underlay and overlay networks in cloud-native n
 can simply abstract their characteristics from many CNI projects. The two technologies meet
 the needs of different scenarios.
 
-The [article](./concepts/solution.md) provides a brief comparison of IPAM and
+The [article](./usage/spider-multus-config.md) provides a brief comparison of IPAM and
 network performance between the two technologies, which offers better insights into
 the unique features and use cases of Spiderpool.
 
@@ -219,7 +219,7 @@ Currently, RDMA finds extensive applications in fields such as AI computing and
 
 ## Quick start
 
-Refer to [Quick start](./usage/install/install.md), set up a cluster quickly.
+Refer to [Quick start](./usage/readme.md), set up a cluster quickly.
 
 ## Major features
 
@@ -288,7 +288,7 @@ Refer to [Quick start](./usage/install/install.md), set up a cluster quickly.
 
 * Easy generation of [Multus](https://github.com/k8snetworkplumbingwg/multus-cni) NetworkAttachmentDefinition
   custom resources with best-practice CNI configuration, also ensure well formatted JSON
-  to improve experience. See [example](./concepts/multusconfig.md) for details.
+  to improve experience. See [example](./usage/spider-multus-config.md) for details.
 
 * Multiple IP pools can be set for the application for prevent IP address from running out.
   See [example](./usage/ippool-multi.md) for details.
@@ -297,18 +297,18 @@ Refer to [Quick start](./usage/install/install.md), set up a cluster quickly.
   already taken by hosts out of the cluster. See [example](./usage/reserved-ip.md) for details.
 
 * Outstanding performance for assigning and releasing Pod IPs, showcased in the
- [test report](./concepts/performance.md).
+ [test report](./concepts/ipam-performance.md).
 
 * Well-designed IP reclaim mechanism could help assign IP address in time and
   quickly recover from the breakdown for the cluster or application.
-  See [example](./usage/gc.md) for details.
+  See [example](./reference/metrics.md) for details.
 
 * All above features can work in ipv4-only, ipv6-only, and dual-stack scenarios.
   See [example](./usage/ipv6.md) for details.
 
 * Support AMD64 and ARM64.
 
-* [Metrics](./concepts/metrics.md)
+* [Metrics](./reference/metrics.md)
 
 ## Blogs
 
@@ -330,7 +330,7 @@ Refer to [Quick start](./usage/install/install.md), set up a cluster quickly.
 
 ## Governance
 
-The project is governed by a group of [Maintainers and Committers](./AUTHORS). How they are selected and govern is outlined in our [governance document](./develop/CODE-OF-CONDUCT.md).
+The project is governed by a group of [Maintainers and Committers](../AUTHORS). How they are selected and govern is outlined in our [governance document](./develop/CODE-OF-CONDUCT.md).
 
 ## Adopters
 
@@ -357,7 +357,7 @@ and then join the [#Spiderpool](https://cloud-native.slack.com/messages/spiderpo
 ## License
 
 Spiderpool is licensed under the Apache License, Version 2.0.
-See [LICENSE](./LICENSE) for the full license text.
+See [LICENSE](../LICENSE) for the full license text.
 
 <p align="center">
 <img src="https://landscape.cncf.io/images/left-logo.svg" width="300"/>&nbsp;&nbsp;<img src="https://landscape.cncf.io/images/right-logo.svg" width="350"/>

diff --git a/docs/concepts/allocation-zh_CN.md b/docs/concepts/allocation-zh_CN.md
diff --git a/docs/concepts/allocation.md b/docs/concepts/allocation.md