Merge pull request #2552 from Icarus9913/doc/wk/macvlan

docs: add vlan and bond description for macvlan
spidernet-io · Nov 7, 2023 · 38ff19b · 38ff19b
2 parents 7e33c1b + 176b814
commit 38ff19b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/docs/usage/install/underlay/get-started-macvlan-zh_CN.md b/docs/usage/install/underlay/get-started-macvlan-zh_CN.md
@@ -73,6 +73,9 @@ Spiderpool 为简化书写 JSON 格式的 Multus CNI 配置，它提供了 Spide
 
 * 确认 Macvlan 所需的宿主机父接口，本例子以宿主机 eth0 网卡为例，从该网卡创建 Macvlan 子接口给 Pod 使用
 
+    > * 若有 vlan 的需求，可在 `spec.vlanID` 字段中指定 vlan 号，我们将会为网卡创建对应的 vlan 子接口
+    > * 我们还提供对网卡 bond 的支持，只需在 `spec.bond.name` 和 `spec.bond.mode` 里指定 bond 网卡的名字和模式即可。随后我们会自动为你实现多张网卡 bond 成一张网卡。
+
     ```shell
     MACVLAN_MASTER_INTERFACE="eth0"
     cat <<EOF | kubectl apply -f -

diff --git a/docs/usage/install/underlay/get-started-macvlan.md b/docs/usage/install/underlay/get-started-macvlan.md
@@ -71,6 +71,9 @@ To simplify writing Multus CNI configuration in JSON format, Spiderpool provides
 
 * Verify the required host parent interface for Macvlan. In this case, a Macvlan sub-interface will be created for Pods from the host parent interface --eth0.
 
+    > * If there is a VLAN requirement, you can specify the VLAN ID in the `spec.vlanID` field. We will create the corresponding VLAN sub-interface for the network card.
+    > * We also provide support for network card bonding. Just specify the name of the bond network card and its mode in the `spec.bond.name` and `spec.bond.mode` respectively. We will automatically combine multiple network cards into one bonded network card for you.
+
     ```shell
     MACVLAN_MASTER_INTERFACE="eth0"
     cat <<EOF | kubectl apply -f -