docs: note label worker nodes for sriov-operator

Signed-off-by: cyclinder <[email protected]>
spidernet-io · Jun 21, 2024 · 2aaa37f · 2aaa37f
1 parent f4d26b6
commit 2aaa37f
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 4 deletions.
diff --git a/docs/usage/rdma-ib-zh_CN.md b/docs/usage/rdma-ib-zh_CN.md
@@ -79,6 +79,10 @@
 
 3. 配置 SR-IOV operator 
 
+    给希望运行 SR-IOV CNI 的节点，按照如下命令打上如下 label。这样，sriov-network-operator 才会在指定的节点上安装组件:
+
+        kubectl label node $NodeName node-role.kubernetes.io/worker=""
+
     使用如下命令，查询主机上 Infiniband 网卡设备的信息
 
         ~# lspci -nn | grep Infiniband

diff --git a/docs/usage/rdma-ib.md b/docs/usage/rdma-ib.md
@@ -79,6 +79,10 @@ The following steps demonstrate how to use [IB-SRIOV](https://github.com/k8snetw
 
 3. configure SR-IOV operator.
 
+    To enable the SR-IOV CNI on specific nodes, you need to apply the following command to label those nodes. This will allow the sriov-network-operator to install the components on the designated nodes.
+
+        kubectl label node $NodeName node-role.kubernetes.io/worker=""
+
     Use the following commands to look up the device information of infiniband card
 
         ~# lspci -nn | grep Infiniband

diff --git a/docs/usage/rdma-roce-zh_CN.md b/docs/usage/rdma-roce-zh_CN.md
@@ -254,8 +254,6 @@ RDMA 网卡，也可以基于 SR-IOV CNI 来使用 exclusive 模式的网卡。
 
     - 如果您是国内用户，可以指定参数 `--set global.imageRegistryOverride=ghcr.m.daocloud.io` 避免 Spiderpool 的镜像拉取失败。
 
-    完成 Spiderpool 安装后，可以手动编辑 configmap spiderpool-rdma-shared-device-plugin 来重新配置 RDMA shared device plugin
-
     完成后，安装的组件如下
 
         ~# kubectl get pod -n kube-system
@@ -267,6 +265,10 @@ RDMA 网卡，也可以基于 SR-IOV CNI 来使用 exclusive 模式的网卡。
 
 3. 配置 SR-IOV operator
 
+    给希望运行 SR-IOV CNI 的节点，按照如下命令打上如下 label。这样，sriov-network-operator 才会在指定的节点上安装组件:
+
+        kubectl label node $NodeName node-role.kubernetes.io/worker=""
+
     查询 RDMA 网卡的设备信息。本演示环境，输入如下命令，网卡 vendors 为 15b3，网卡 deviceIDs 为 1017
 
         ~# lspci -nn | grep Ethernet

diff --git a/docs/usage/rdma-roce.md b/docs/usage/rdma-roce.md
@@ -253,8 +253,6 @@ The following steps demonstrate how to enable isolated usage of RDMA devices by
 
     - If you are a user from China, you can specify the parameter `--set global.imageRegistryOverride=ghcr.m.daocloud.io` to pull image from china registry.
 
-    After completing the installation of Spiderpool, you can manually edit the spiderpool-rdma-shared-device-plugin configmap to reconfigure the RDMA shared device plugin.
-
     Once the installation is complete, the following components will be installed:
         ~# kubectl get pod -n kube-system
         spiderpool-agent-9sllh                         1/1     Running     0          1m
@@ -265,6 +263,10 @@ The following steps demonstrate how to enable isolated usage of RDMA devices by
 
 3. Configure SR-IOV operator
 
+    To enable the SR-IOV CNI on specific nodes, you need to apply the following command to label those nodes. This will allow the sriov-network-operator to install the components on the designated nodes.
+
+        kubectl label node $NodeName node-role.kubernetes.io/worker=""
+
     Look up the device information of the RoCE interface. Enter the following command to get NIC vendors 15b3 and deviceIDs 1017
 
         ~# lspci -nn | grep Ethernet