From 1bc42182a449584a0f959afbe744146c0b78a91e Mon Sep 17 00:00:00 2001 From: "weizhou.lan@daocloud.io" Date: Thu, 14 Dec 2023 15:37:38 +0800 Subject: [PATCH] d Signed-off-by: weizhou.lan@daocloud.io --- charts/spiderpool/README.md | 2 +- docs/usage/rdma-ib-zh_CN.md | 12 ++++++------ docs/usage/rdma-ib.md | 4 ++-- docs/usage/rdma-roce-zh_CN.md | 7 ++----- docs/usage/rdma-roce.md | 7 ++----- 5 files changed, 13 insertions(+), 19 deletions(-) diff --git a/charts/spiderpool/README.md b/charts/spiderpool/README.md index 8d53a3e38b..e8e5946911 100644 --- a/charts/spiderpool/README.md +++ b/charts/spiderpool/README.md @@ -212,7 +212,7 @@ helm install spiderpool spiderpool/spiderpool --wait --namespace kube-system \ ### plugins parameters | Name | Description | Value | -| -------------------------------- | ---------------------------------------------------------- |----------------------------------------------| +| -------------------------------- | ---------------------------------------------------------- | -------------------------------------------- | | `plugins.installCNI` | install all cni plugins to each node | `false` | | `plugins.installRdmaCNI` | install rdma cni used to isolate rdma device for sriov cni | `true` | | `plugins.installOvsCNI` | install ovs cni to each node | `true` | diff --git a/docs/usage/rdma-ib-zh_CN.md b/docs/usage/rdma-ib-zh_CN.md index 69fbb1b90d..09921a16a9 100644 --- a/docs/usage/rdma-ib-zh_CN.md +++ b/docs/usage/rdma-ib-zh_CN.md @@ -54,9 +54,9 @@ Spiderpool 赋能了 [IB-SRIOV](https://github.com/k8snetworkplumbingwg/ib-sriov 2. 安装好 Spiderpool，确认如下 helm 选项 - > - 务必开启 --set sriov.install=true 选项 - > - > - 如果您是国内用户，可以指定参数 `--set global.imageRegistryOverride=ghcr.m.daocloud.io` 避免 Spiderpool 的镜像拉取失败。 + - 务必开启 `--set sriov.install=true` + + - 如果您是国内用户，可以指定参数 `--set global.imageRegistryOverride=ghcr.m.daocloud.io` 避免 Spiderpool 的镜像拉取失败。 完成后，安装的组件如下 @@ -238,11 +238,11 @@ Spiderpool 赋能了 [IB-SRIOV](https://github.com/k8snetworkplumbingwg/ib-sriov inet6 fe80::eaeb:d303:93:ae10/64 scope link valid_lft forever preferred_lft forever -2. 安装好 Spiderpool，确认如下安装选项 +2. 安装好 Spiderpool - > - 如果您是国内用户，可以指定参数 `--set global.imageRegistryOverride=ghcr.m.daocloud.io` 避免 Spiderpool 的镜像拉取失败。 + 如果您是国内用户，可以指定参数 `--set global.imageRegistryOverride=ghcr.m.daocloud.io` 避免 Spiderpool 的镜像拉取失败。 - 完成后，安装的组件如下 + 完成后，安装的组件如下 ~# kubectl get pod -n kube-system spiderpool-agent-9sllh 1/1 Running 0 1m diff --git a/docs/usage/rdma-ib.md b/docs/usage/rdma-ib.md index 16224b2386..1cb30fa32d 100644 --- a/docs/usage/rdma-ib.md +++ b/docs/usage/rdma-ib.md @@ -10,9 +10,9 @@ Spiderpool empowers [IB-SRIOV](https://github.com/k8snetworkplumbingwg/ib-sriov- Different from RoCE, Infiniband network cards are proprietary devices based on Infiniband networks, and the Spiderpool offers two CNI options: -1. [IB-SR-IOV CNI]（ https://github.com/k8snetworkplumbingwg/ib-sriov-cni ）provides SR-IOV network card with the RDMA device of network namespace isolation. It is suitable for workloads that require RDMA communication. +1. [IB-SR-IOV CNI](https://github.com/k8snetworkplumbingwg/ib-sriov-cni) provides SR-IOV network card with the RDMA device of network namespace isolation. It is suitable for workloads that require RDMA communication. -2. [IPoIB CNI]（ https://github.com/mellanox/ipoib-cni ）provides an IPoIB network card for POD, without RDMA device. It is suitable for conventional applications that require TCP/IP communication, as it does not require an SRIOV network card, allowing more PODs to run on the host +2. [IPoIB CNI](https://github.com/mellanox/ipoib-cni) provides an IPoIB network card for POD, without RDMA device. It is suitable for conventional applications that require TCP/IP communication, as it does not require an SRIOV network card, allowing more PODs to run on the host Moreover, in the RDMA communication scenario, for applications based on clusterIP communication, in order to enable RDMA traffic to be forwarded through the underlay network card, the resolution of clusterIP based on cgroup eBPF can be implemented in the container network namespace. For specific details, please refer to [cgroup eBPF Resolving ClusterIP](./underlay_cni_service zh-CN. md) diff --git a/docs/usage/rdma-roce-zh_CN.md b/docs/usage/rdma-roce-zh_CN.md index 059fc7b91a..9a0b9c61aa 100644 --- a/docs/usage/rdma-roce-zh_CN.md +++ b/docs/usage/rdma-roce-zh_CN.md @@ -258,11 +258,8 @@ RDMA 网卡，也可以基于 SR-IOV CNI 来使用 exclusive 模式的网卡。 3. 安装 Spiderpool - > - 务必设置如下 helm 选项 - > - > --set sriov.install=true \ - > - > - 如果您是国内用户，可以指定参数 `--set global.imageRegistryOverride=ghcr.m.daocloud.io` 避免 Spiderpool 的镜像拉取失败。 + - 务必设置 helm 选项 `--set sriov.install=true` + - 如果您是国内用户，可以指定参数 `--set global.imageRegistryOverride=ghcr.m.daocloud.io` 避免 Spiderpool 的镜像拉取失败。 完成 Spiderpool 安装后，可以手动编辑 configmap spiderpool-rdma-shared-device-plugin 来重新配置 RDMA shared device plugin diff --git a/docs/usage/rdma-roce.md b/docs/usage/rdma-roce.md index 0957ecfec2..70431c1372 100644 --- a/docs/usage/rdma-roce.md +++ b/docs/usage/rdma-roce.md @@ -257,11 +257,8 @@ The following steps demonstrate how to enable isolated usage of RDMA devices by 3. Install Spiderpool - > - set the following values - > - > --set sriov.install=true \ - > - > - If you are a user from China, you can specify the parameter `--set global.imageRegistryOverride=ghcr.m.daocloud.io` to avoid image pull failures from Spiderpool. + - set the values `--set sriov.install=true` + - If you are a user from China, you can specify the parameter `--set global.imageRegistryOverride=ghcr.m.daocloud.io` to avoid image pull failures from Spiderpool. After completing the installation of Spiderpool, you can manually edit the spiderpool-rdma-shared-device-plugin configmap to reconfigure the RDMA shared device plugin.