|
| 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 | +The Bond Container Network Interface (Bond CNI) enables the aggregation of multiple network interfaces into a single logical "bonded" interface within a container, enhancing network redundancy and fault tolerance. Only SR-IOV Virtual Functions (VFs) are supported for bonding with this plugin. |
| 10 | + |
| 11 | +The following table describes the configuration parameters for the Bond CNI plugin: |
| 12 | + |
| 13 | +.Bond CNI plugin JSON configuration object |
| 14 | +[cols=".^2,.^2,.^6",options="header"] |
| 15 | +|==== |
| 16 | +|Field|Type|Description |
| 17 | + |
| 18 | + |
| 19 | +|`name` |
| 20 | +|`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. |
| 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 container's network namespace 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 | +---- |
0 commit comments