Skip to content

Commit 6742c59

Browse files
skrthomasskrthomas
authored
Merge pull request #61277 from kquinn1204/OCPBUGS-15034
OCPBUGS-15034 correcting minor misnaming and adding optional
2 parents 90db5bf + d84b0d8 commit 6742c59

File tree

4 files changed

+77
-42
lines changed

4 files changed

+77
-42
lines changed

‎modules/nw-multus-bridge-object.adoc

Lines changed: 47 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * networking/multiple_networks/configuring-additional-network.adoc
4-
4+
:_content-type: REFERENCE
55
[id="nw-multus-bridge-object_{context}"]
66
= Configuration for a bridge additional network
77

@@ -23,50 +23,82 @@ plugin:
2323

2424
|`type`
2525
|`string`
26-
|
27-
28-
|`bridge`
29-
|`string`
30-
|Specify the name of the virtual bridge to use. If the bridge interface does not exist on the host, it is created. The default value is `cni0`.
26+
|The name of the CNI plugin to configure: `bridge`.
3127

3228
|`ipam`
3329
|`object`
3430
|The configuration object for the IPAM CNI plugin. The plugin manages IP address assignment for the attachment definition.
3531

32+
|`bridge`
33+
|`string`
34+
|Optional: Specify the name of the virtual bridge to use. If the bridge interface does not exist on the host, it is created. The default value is `cni0`.
35+
3636
|`ipMasq`
3737
|`boolean`
38-
|Set to `true` to enable IP masquerading for traffic that leaves the virtual network. The source IP address for all traffic is rewritten to the bridge's IP address. If the bridge does not have an IP address, this setting has no effect. The default value is `false`.
38+
|Optional: Set to `true` to enable IP masquerading for traffic that leaves the virtual network. The source IP address for all traffic is rewritten to the bridge's IP address. If the bridge does not have an IP address, this setting has no effect. The default value is `false`.
3939

4040
|`isGateway`
4141
|`boolean`
42-
|Set to `true` to assign an IP address to the bridge. The default value is `false`.
42+
|Optional: Set to `true` to assign an IP address to the bridge. The default value is `false`.
4343

4444
|`isDefaultGateway`
4545
|`boolean`
46-
|Set to `true` to configure the bridge as the default gateway for the virtual network. The default value is `false`. If `isDefaultGateway` is set to `true`, then `isGateway` is also set to `true` automatically.
46+
|Optional: Set to `true` to configure the bridge as the default gateway for the virtual network. The default value is `false`. If `isDefaultGateway` is set to `true`, then `isGateway` is also set to `true` automatically.
4747

4848
|`forceAddress`
4949
|`boolean`
50-
|Set to `true` to allow assignment of a previously assigned IP address to the virtual bridge. When set to `false`, if an IPv4 address or an IPv6 address from overlapping subsets is assigned to the virtual bridge, an error occurs. The default value is `false`.
50+
|Optional: Set to `true` to allow assignment of a previously assigned IP address to the virtual bridge. When set to `false`, if an IPv4 address or an IPv6 address from overlapping subsets is assigned to the virtual bridge, an error occurs. The default value is `false`.
5151

5252
|`hairpinMode`
5353
|`boolean`
54-
|Set to `true` to allow the virtual bridge to send an Ethernet frame back through the virtual port it was received on. This mode is also known as _reflective relay_. The default value is `false`.
54+
|Optional: Set to `true` to allow the virtual bridge to send an Ethernet frame back through the virtual port it was received on. This mode is also known as _reflective relay_. The default value is `false`.
5555

5656
|`promiscMode`
5757
|`boolean`
58-
|Set to `true` to enable promiscuous mode on the bridge. The default value is `false`.
58+
|Optional: Set to `true` to enable promiscuous mode on the bridge. The default value is `false`.
5959

6060
|`vlan`
6161
|`string`
62-
|Specify a virtual LAN (VLAN) tag as an integer value. By default, no VLAN tag is assigned.
62+
|Optional: Specify a virtual LAN (VLAN) tag as an integer value. By default, no VLAN tag is assigned.
63+
64+
|`preserveDefaultVlan`
65+
|`string`
66+
|Optional: Indicates whether the default vlan must be preserved on the `veth` end connected to the bridge. Defaults to true.
67+
68+
|`vlanTrunk`
69+
|`list`
70+
|Optional: Assign a VLAN trunk tag. The default value is `none`.
6371

6472
|`mtu`
6573
|`string`
66-
|Set the maximum transmission unit (MTU) to the specified value. The default value is automatically set by the kernel.
74+
|Optional: Set the maximum transmission unit (MTU) to the specified value. The default value is automatically set by the kernel.
6775

76+
|`enabledad`
77+
|`boolean`
78+
|Optional: Enables duplicate address detection for the container side `veth`. The default value is `false`.
79+
80+
|`macspoofchk`
81+
|`boolean`
82+
|Optional: Enables mac spoof check, limiting the traffic originating from the container to the mac address of the interface. The default value is `false`.
6883
|====
6984

85+
[NOTE]
86+
====
87+
The VLAN parameter configures the VLAN tag on the host end of the `veth` and also enables the `vlan_filtering` feature on the bridge interface.
88+
====
89+
90+
[NOTE]
91+
====
92+
To configure uplink for a L2 network you need to allow the vlan on the uplink interface by using the following command:
93+
94+
[source,terminal]
95+
----
96+
$ bridge vlan add vid VLAN_ID dev DEV
97+
----
98+
99+
====
100+
101+
70102
[id="nw-multus-bridge-config-example_{context}"]
71103
== bridge configuration example
72104

@@ -76,7 +108,7 @@ The following example configures an additional network named `bridge-net`:
76108
----
77109
{
78110
"cniVersion": "0.3.1",
79-
"name": "work-network",
111+
"name": "bridge-net",
80112
"type": "bridge",
81113
"isGateway": true,
82114
"vlan": 2,

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
// Module included in the following assemblies:
22
//
33
// * networking/multiple_networks/configuring-additional-network.adoc
4-
4+
:_content-type: REFERENCE
55
[id="nw-multus-host-device-object_{context}"]
66
= Configuration for a host device additional network
77

88
[NOTE]
99
====
10-
Specify your network device by setting only one of the
11-
following parameters: `device`, `hwaddr`, `kernelpath`, or `pciBusID`.
10+
Specify your network device by setting only one of the following parameters: `device`,`hwaddr`, `kernelpath`, or `pciBusID`.
1211
====
1312

1413
The following object describes the configuration parameters for the host-device CNI plugin:
@@ -57,8 +56,8 @@ The following example configures an additional network named `hostdev-net`:
5756
----
5857
{
5958
"cniVersion": "0.3.1",
60-
"name": "work-network",
59+
"name": "hostdev-net",
6160
"type": "host-device",
6261
"device": "eth1"
6362
}
64-
----
63+
----

‎modules/nw-multus-ipvlan-object.adoc

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
//37.1. IPVLAN overview
66
// https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/configuring_and_managing_networking/getting-started-with-ipvlan_configuring-and-managing-networking#ipvlan-overview_getting-started-with-ipvlan
7+
:_content-type: REFERENCE
78

89
[id="nw-multus-ipvlan-object_{context}"]
910
= Configuration for an IPVLAN additional network
1011

11-
The following object describes the configuration parameters for the IPVLAN CNI
12-
plugin:
12+
The following object describes the configuration parameters for the IPVLAN CNI plugin:
1313

1414
.IPVLAN CNI plugin JSON configuration object
1515
[cols=".^2,.^2,.^6",options="header"]
@@ -28,26 +28,31 @@ plugin:
2828
|`string`
2929
|The name of the CNI plugin to configure: `ipvlan`.
3030

31+
|`ipam`
32+
|`object`
33+
|The configuration object for the IPAM CNI plugin. The plugin manages IP address assignment for the attachment definition. This is required unless the plugin is chained.
34+
3135
|`mode`
3236
|`string`
33-
|The operating mode for the virtual network. The value must be `l2`, `l3`, or `l3s`. The default value is `l2`.
37+
|Optional: The operating mode for the virtual network. The value must be `l2`, `l3`, or `l3s`. The default value is `l2`.
3438

3539
|`master`
3640
|`string`
37-
|The Ethernet interface to associate with the network attachment. If a `master` is not specified, the interface for the default network route is used.
41+
|Optional: The Ethernet interface to associate with the network attachment. If a `master` is not specified, the interface for the default network route is used.
3842

3943
|`mtu`
4044
|`integer`
41-
|Set the maximum transmission unit (MTU) to the specified value. The default value is automatically set by the kernel.
42-
43-
|`ipam`
44-
|`object`
45-
|The configuration object for the IPAM CNI plugin. The plugin manages IP address assignment for the attachment definition.
46-
47-
Do not specify `dhcp`. Configuring IPVLAN with DHCP is not supported because IPVLAN interfaces share the MAC address with the host interface.
45+
|Optional: Set the maximum transmission unit (MTU) to the specified value. The default value is automatically set by the kernel.
4846

4947
|====
5048

49+
[NOTE]
50+
====
51+
* The `ipvlan` object does not allow virtual interfaces to communicate with the `master` interface. Therefore the container will not be able to reach the host by using the `ipvlan` interface. Be sure that the container joins a network that provides connectivity to the host, such as a network supporting the Precision Time Protocol (`PTP`).
52+
* A single `master` interface cannot simultaneously be configured to use both `macvlan` and `ipvlan`.
53+
* For IP allocation schemes that cannot be interface agnostic, the `ipvlan` plugin can be chained with an earlier plugin that handles this logic. If the `master` is omitted, then the previous result must contain a single interface name for the `ipvlan` plugin to enslave. If `ipam` is omitted, then the previous result is used to configure the `ipvlan` interface.
54+
====
55+
5156
[id="nw-multus-ipvlan-config-example_{context}"]
5257
== ipvlan configuration example
5358

@@ -57,7 +62,7 @@ The following example configures an additional network named `ipvlan-net`:
5762
----
5863
{
5964
"cniVersion": "0.3.1",
60-
"name": "work-network",
65+
"name": "ipvlan-net",
6166
"type": "ipvlan",
6267
"master": "eth1",
6368
"mode": "l3",

‎modules/nw-multus-macvlan-object.adoc

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
// Module included in the following assemblies:
22
//
33
// * networking/multiple_networks/configuring-additional-network.adoc
4-
4+
:_content-type: REFERENCE
55
[id="nw-multus-macvlan-object_{context}"]
66
= Configuration for a MACVLAN additional network
77

8-
The following object describes the configuration parameters for the macvlan CNI
9-
plugin:
8+
The following object describes the configuration parameters for the macvlan CNI plugin:
109

1110
.MACVLAN CNI plugin JSON configuration object
1211
[cols=".^2,.^2,.^6",options="header"]
@@ -25,21 +24,21 @@ plugin:
2524
|`string`
2625
|The name of the CNI plugin to configure: `macvlan`.
2726

27+
|`ipam`
28+
|`object`
29+
|The configuration object for the IPAM CNI plugin. The plugin manages IP address assignment for the attachment definition.
30+
2831
|`mode`
2932
|`string`
30-
|Configures traffic visibility on the virtual network. Must be either `bridge`, `passthru`, `private`, or `vepa`. If a value is not provided, the default value is `bridge`.
33+
|Optional: Configures traffic visibility on the virtual network. Must be either `bridge`, `passthru`, `private`, or `vepa`. If a value is not provided, the default value is `bridge`.
3134

3235
|`master`
3336
|`string`
34-
|The host network interface, such as a network interface, bond, or bond with VLAN, to associate with the newly created macvlan interface. If a value is not specified, then the default route interface is used.
37+
|Optional: The host network interface to associate with the newly created macvlan interface. If a value is not specified, then the default route interface is used.
3538

3639
|`mtu`
3740
|`string`
38-
|The maximum transmission unit (MTU) to the specified value. The default value is automatically set by the kernel.
39-
40-
|`ipam`
41-
|`object`
42-
|The configuration object for the IPAM CNI plugin. The plugin manages IP address assignment for the attachment definition.
41+
|Optional: The maximum transmission unit (MTU) to the specified value. The default value is automatically set by the kernel.
4342

4443
|====
4544

0 commit comments

Comments
 (0)