Skip to content

Commit eae282a

Browse files
authored
Merge pull request #102078 from kquinn1204/OCPBUGS-59577
OCPBUGS-59577 Correcting inaccurate description
2 parents fd64322 + ced3108 commit eae282a

8 files changed

+22
-21
lines changed

modules/nw-multus-bond-cni-object.adoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The following table describes the configuration parameters for the Bond CNI plug
1818

1919
|`name`
2020
|`string`
21-
|Specifies the name given to this CNI network attachment definition. This name is used to identify and reference the interface within the container.
21+
|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.
2222

2323
|`cniVersion`
2424
|`string`
@@ -34,15 +34,15 @@ The following table describes the configuration parameters for the Bond CNI plug
3434

3535
|`mtu`
3636
|`integer`
37-
|Optional: Specifies the maximum transmission unit (MTU) of the bond. The default is `1500`.
37+
|Optional: Specifies the maximum transmission unit (MTU) of the bond. The default is `1500`.
3838

3939
|`failOverMac`
4040
|`integer`
4141
|Optional: Specifies the `failOverMac` setting for the bond. Default is `0`.
4242

4343
|`mode`
4444
|`string`
45-
|Specifies the bonding policy.
45+
|Specifies the bonding policy.
4646

4747
|`xmitHashPolicy`
4848
|`string`
@@ -73,15 +73,15 @@ The following example configures a secondary network named `bond-net1`:
7373
[source,json]
7474
----
7575
{
76-
"type": "bond",
76+
"type": "bond",
7777
"cniVersion": "0.3.1",
7878
"name": "bond-net1",
79-
"mode": "active-backup",
80-
"failOverMac": 1,
81-
"linksInContainer": true,
79+
"mode": "active-backup",
80+
"failOverMac": 1,
81+
"linksInContainer": true,
8282
"miimon": "100",
8383
"mtu": 1500,
84-
"links": [
84+
"links": [
8585
{"name": "net1"},
8686
{"name": "net2"}
8787
],
@@ -104,9 +104,9 @@ The following example configures a secondary network named `bond-tlb-net` with t
104104
"type": "bond",
105105
"cniVersion": "0.3.1",
106106
"name": "bond-tlb-net",
107-
"mode": "tlb",
108-
"xmitHashPolicy": "layer2+3", <1>
109-
"failOverMac": 0,
107+
"mode": "tlb",
108+
"xmitHashPolicy": "layer2+3",
109+
"failOverMac": 0,
110110
"linksInContainer": true,
111111
"miimon": "100",
112112
"mtu": 1500,
@@ -116,7 +116,7 @@ The following example configures a secondary network named `bond-tlb-net` with t
116116
],
117117
"ipam": {
118118
"type": "host-local",
119-
"subnet": "10.57.218.0/24",
119+
"subnet": "10.57.218.0/24",
120120
"routes": [{
121121
"dst": "0.0.0.0/0"
122122
}],
@@ -125,6 +125,6 @@ The following example configures a secondary network named `bond-tlb-net` with t
125125
}
126126
----
127127

128-
where
129128

130-
`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.
129+
130+
* `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.

modules/nw-multus-bridge-object.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ ifndef::microshift[]
2121
2222
|`name`
2323
|`string`
24-
|The value for the `name` parameter you provided previously for the CNO configuration.
24+
|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.
25+
2526
endif::microshift[]
2627
2728
ifdef::microshift[]

modules/nw-multus-dummy-device-object.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The dummy device CNI plugin JSON configuration object describes the configuratio
2121
2222
|`name`
2323
|`string`
24-
|The value for the `name` parameter that you previously specified for the CNO configuration.
24+
|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.
2525
2626
|`type`
2727
|`string`

modules/nw-multus-host-device-object.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The following table details the configuration parameters:
2626
2727
|`name`
2828
|`string`
29-
|The value for the `name` parameter you provided previously for the CNO configuration.
29+
|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.
3030
3131
|`type`
3232
|`string`

modules/nw-multus-ipvlan-object.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The IPVLAN CNI plugin JSON configuration object describes the configuration para
2323

2424
|`name`
2525
|`string`
26-
|The value for the `name` parameter you provided previously for the CNO configuration.
26+
|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.
2727

2828
|`type`
2929
|`string`

modules/nw-multus-macvlan-object.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The MACVLAN CNI plugin JSON configuration object describes the configuration par
2020
2121
|`name`
2222
|`string`
23-
|The value for the `name` parameter you provided previously for the CNO configuration.
23+
|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.
2424
2525
|`type`
2626
|`string`

modules/nw-multus-tap-object.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The TAP CNI plugin JSON configuration object describes the configuration paramet
1919
2020
|`name`
2121
|`string`
22-
|The value for the `name` parameter you provided previously for the CNO configuration.
22+
|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.
2323
2424
|`type`
2525
|`string`

modules/nw-multus-vlan-object.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The VLAN CNI plugin JSON configuration object describes the configuration parame
2121
2222
|`name`
2323
|`string`
24-
|The value for the `name` parameter you provided previously for the CNO configuration.
24+
|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.
2525
2626
|`type`
2727
|`string`

0 commit comments

Comments
 (0)