Skip to content

Commit 4a2db1f

Browse files
kquinn1204kquinn1204
committed
OCPBUGS-59577 Correcting inaccurate description
1 parent 4b772b7 commit 4a2db1f

8 files changed

+150
-6
lines changed

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

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/multiple_networks/configuring-additional-network.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="nw-multus-bond-cni-object_{context}"]
7+
= Configuration for a Bond CNI secondary network
8+
9+
[role="_abstract"]
10+
The Bond Container Network Interface (Bond CNI) enables the aggregation of multiple network interfaces into a single logical bonded interface within a container, which enhanches network redundancy and fault tolerance. Only SR-IOV Virtual Functions (VFs) are supported for bonding with this plugin.
11+
12+
The following table describes the configuration parameters for the Bond CNI plugin:
13+
14+
.Bond CNI plugin JSON configuration object
15+
[cols=".^2,.^2,.^6",options="header"]
16+
|====
17+
|Field|Type|Description
18+
19+
|`name`
20+
|`string`
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.
22+
23+
|`cniVersion`
24+
|`string`
25+
|The CNI specification version.
26+
27+
|`type`
28+
|`string`
29+
|Specifies the name of the CNI plugin to configure: `bond`.
30+
31+
|`miimon`
32+
|`string`
33+
|Specifies the address resolution protocol (ARP) link monitoring frequency in milliseconds. This parameter defines how often the bond interface sends ARP requests to check the availability of its aggregated interfaces.
34+
35+
|`mtu`
36+
|`integer`
37+
|Optional: Specifies the maximum transmission unit (MTU) of the bond. The default is `1500`.
38+
39+
|`failOverMac`
40+
|`integer`
41+
|Optional: Specifies the `failOverMac` setting for the bond. Default is `0`.
42+
43+
|`mode`
44+
|`string`
45+
|Specifies the bonding policy.
46+
47+
|`linksInContainer`
48+
|`boolean`
49+
|Optional: Specifies whether the network interfaces intended for bonding are expected to be created and available directly within the network namespace of the container when the bond starts. If `false` which is the default, the CNI plugin looks for these interfaces on the host system first before attempting to form the bond.
50+
51+
|`links`
52+
|`object`
53+
|Specifies the interfaces to be bonded.
54+
55+
|`ipam`
56+
|`object`
57+
|The configuration object for the IPAM CNI plugin. The plugin manages IP address assignment for the attachment definition.
58+
59+
|====
60+
61+
[id="nw-multus-bond-cni-config-example_{context}"]
62+
== Bond CNI plugin configuration example
63+
64+
The following example configures a secondary network named `bond-net1`:
65+
66+
[source,json]
67+
----
68+
{
69+
"type": "bond",
70+
"cniVersion": "0.3.1",
71+
"name": "bond-net1",
72+
"mode": "active-backup",
73+
"failOverMac": 1,
74+
"linksInContainer": true,
75+
"miimon": "100",
76+
"mtu": 1500,
77+
"links": [
78+
{"name": "net1"},
79+
{"name": "net2"}
80+
],
81+
"ipam": {
82+
"type": "host-local",
83+
"subnet": "10.56.217.0/24",
84+
"routes": [{
85+
"dst": "0.0.0.0/0"
86+
}],
87+
"gateway": "10.56.217.1"
88+
}
89+
}
90+
----
91+

‎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: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/multiple_networks/configuring-additional-network.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="nw-multus-dummy-device-object_{context}"]
7+
= Configuration for a dummy device additional network
8+
9+
[role="_abstract"]
10+
The dummy CNI plugin functions like a loopback device. The plugin is a virtual interface, and you can use the plugin to route the packets to a designated IP address. Unlike a loopback device, the IP address is arbitrary and is not restricted to the `127.0.0.0/8` address range.
11+
12+
The dummy device CNI plugin JSON configuration object describes the configuration parameters for the dummy CNI plugin. The following table details these parameters:
13+
14+
[cols=".^2,.^2,.^6",options="header"]
15+
|====
16+
|Field|Type|Description
17+
18+
|`cniVersion`
19+
|`string`
20+
|The CNI specification version. The required value is `0.3.1`.
21+
22+
|`name`
23+
|`string`
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+
26+
|`type`
27+
|`string`
28+
|The name of the CNI plugin that you want to configure. The required value is `dummy`.
29+
30+
|`ipam`
31+
|`object`
32+
|The configuration object for the IPAM CNI plugin. The plugin manages the IP address assignment for the attachment definition.
33+
34+
|====
35+
36+
[id="nw-multus-dummy-device-config-example_{context}"]
37+
== dummy configuration example
38+
39+
The following example configures an additional network named `hostdev-net`:
40+
41+
[source,json]
42+
----
43+
{
44+
"cniVersion": "0.3.1",
45+
"name": "dummy-net",
46+
"type": "dummy",
47+
"ipam": {
48+
"type": "host-local",
49+
"subnet": "10.1.1.0/24"
50+
}
51+
}
52+
----

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The following object describes the configuration parameters for the host-device
2424

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

2929
|`type`
3030
|`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 following object describes the configuration parameters for the IPVLAN, `ipv
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 following object describes the configuration parameters for the MAC Virtual
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
@@ -20,7 +20,7 @@ plugin:
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-vlan-object.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The following object describes the configuration parameters for the VLAN, `vlan`
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)