From c4a49b9478f716c8c77885ccd5486cc6903719d7 Mon Sep 17 00:00:00 2001 From: Kevin Quinn Date: Mon, 10 Nov 2025 10:39:12 +0000 Subject: [PATCH] OCPBUGS-59577 Correcting inaccurate description --- modules/nw-multus-bond-cni-object.adoc | 28 +++++++++++----------- modules/nw-multus-bridge-object.adoc | 3 ++- modules/nw-multus-dummy-device-object.adoc | 2 +- modules/nw-multus-host-device-object.adoc | 2 +- modules/nw-multus-ipvlan-object.adoc | 2 +- modules/nw-multus-macvlan-object.adoc | 2 +- modules/nw-multus-tap-object.adoc | 2 +- modules/nw-multus-vlan-object.adoc | 2 +- 8 files changed, 22 insertions(+), 21 deletions(-) diff --git a/modules/nw-multus-bond-cni-object.adoc b/modules/nw-multus-bond-cni-object.adoc index 0771a1c727..aaebdf76b4 100644 --- a/modules/nw-multus-bond-cni-object.adoc +++ b/modules/nw-multus-bond-cni-object.adoc @@ -18,7 +18,7 @@ The following table describes the configuration parameters for the Bond CNI plug |`name` |`string` -|Specifies the name given to this CNI network attachment definition. This name is used to identify and reference the interface within the container. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. |`cniVersion` |`string` @@ -34,7 +34,7 @@ The following table describes the configuration parameters for the Bond CNI plug |`mtu` |`integer` -|Optional: Specifies the maximum transmission unit (MTU) of the bond. The default is `1500`. +|Optional: Specifies the maximum transmission unit (MTU) of the bond. The default is `1500`. |`failOverMac` |`integer` @@ -42,7 +42,7 @@ The following table describes the configuration parameters for the Bond CNI plug |`mode` |`string` -|Specifies the bonding policy. +|Specifies the bonding policy. |`xmitHashPolicy` |`string` @@ -73,15 +73,15 @@ The following example configures a secondary network named `bond-net1`: [source,json] ---- { - "type": "bond", + "type": "bond", "cniVersion": "0.3.1", "name": "bond-net1", - "mode": "active-backup", - "failOverMac": 1, - "linksInContainer": true, + "mode": "active-backup", + "failOverMac": 1, + "linksInContainer": true, "miimon": "100", "mtu": 1500, - "links": [ + "links": [ {"name": "net1"}, {"name": "net2"} ], @@ -104,9 +104,9 @@ The following example configures a secondary network named `bond-tlb-net` with t "type": "bond", "cniVersion": "0.3.1", "name": "bond-tlb-net", - "mode": "tlb", - "xmitHashPolicy": "layer2+3", <1> - "failOverMac": 0, + "mode": "tlb", + "xmitHashPolicy": "layer2+3", + "failOverMac": 0, "linksInContainer": true, "miimon": "100", "mtu": 1500, @@ -116,7 +116,7 @@ The following example configures a secondary network named `bond-tlb-net` with t ], "ipam": { "type": "host-local", - "subnet": "10.57.218.0/24", + "subnet": "10.57.218.0/24", "routes": [{ "dst": "0.0.0.0/0" }], @@ -125,6 +125,6 @@ The following example configures a secondary network named `bond-tlb-net` with t } ---- -where -`xmitHashPolicy`:: This parameter dictates how outgoing network traffic is distributed across the `net1` and `net2` active member interfaces within the bond. The hashing algorithm combines layer 2 information, specifically source and destination MAC addresses, with layer 3 information, which includes source and destination IP addresses. + +* `xmitHashPolicy`: This parameter dictates how outgoing network traffic is distributed across the `net1` and `net2` active member interfaces within the bond. The hashing algorithm combines layer 2 information, specifically source and destination MAC addresses, with layer 3 information, which includes source and destination IP addresses. diff --git a/modules/nw-multus-bridge-object.adoc b/modules/nw-multus-bridge-object.adoc index c864498a0d..de441cffe0 100644 --- a/modules/nw-multus-bridge-object.adoc +++ b/modules/nw-multus-bridge-object.adoc @@ -21,7 +21,8 @@ ifndef::microshift[] |`name` |`string` -|The value for the `name` parameter you provided previously for the CNO configuration. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. + endif::microshift[] ifdef::microshift[] diff --git a/modules/nw-multus-dummy-device-object.adoc b/modules/nw-multus-dummy-device-object.adoc index 20fcafb313..93f91e0ed3 100644 --- a/modules/nw-multus-dummy-device-object.adoc +++ b/modules/nw-multus-dummy-device-object.adoc @@ -21,7 +21,7 @@ The dummy device CNI plugin JSON configuration object describes the configuratio |`name` |`string` -|The value for the `name` parameter that you previously specified for the CNO configuration. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. |`type` |`string` diff --git a/modules/nw-multus-host-device-object.adoc b/modules/nw-multus-host-device-object.adoc index 12914bfd9c..483254d3a6 100644 --- a/modules/nw-multus-host-device-object.adoc +++ b/modules/nw-multus-host-device-object.adoc @@ -26,7 +26,7 @@ The following table details the configuration parameters: |`name` |`string` -|The value for the `name` parameter you provided previously for the CNO configuration. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. |`type` |`string` diff --git a/modules/nw-multus-ipvlan-object.adoc b/modules/nw-multus-ipvlan-object.adoc index df3f428f13..6bc912e236 100644 --- a/modules/nw-multus-ipvlan-object.adoc +++ b/modules/nw-multus-ipvlan-object.adoc @@ -23,7 +23,7 @@ The IPVLAN CNI plugin JSON configuration object describes the configuration para |`name` |`string` -|The value for the `name` parameter you provided previously for the CNO configuration. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. |`type` |`string` diff --git a/modules/nw-multus-macvlan-object.adoc b/modules/nw-multus-macvlan-object.adoc index f66bb519b6..3bb9a75340 100644 --- a/modules/nw-multus-macvlan-object.adoc +++ b/modules/nw-multus-macvlan-object.adoc @@ -20,7 +20,7 @@ The MACVLAN CNI plugin JSON configuration object describes the configuration par |`name` |`string` -|The value for the `name` parameter you provided previously for the CNO configuration. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. |`type` |`string` diff --git a/modules/nw-multus-tap-object.adoc b/modules/nw-multus-tap-object.adoc index 9894338437..d60c8a0868 100644 --- a/modules/nw-multus-tap-object.adoc +++ b/modules/nw-multus-tap-object.adoc @@ -19,7 +19,7 @@ The TAP CNI plugin JSON configuration object describes the configuration paramet |`name` |`string` -|The value for the `name` parameter you provided previously for the CNO configuration. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. |`type` |`string` diff --git a/modules/nw-multus-vlan-object.adoc b/modules/nw-multus-vlan-object.adoc index b34e459884..dfdb6c87c9 100644 --- a/modules/nw-multus-vlan-object.adoc +++ b/modules/nw-multus-vlan-object.adoc @@ -21,7 +21,7 @@ The VLAN CNI plugin JSON configuration object describes the configuration parame |`name` |`string` -|The value for the `name` parameter you provided previously for the CNO configuration. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. |`type` |`string`