From ca2943fa1e85079e6ec248039085c7a13dfcec00 Mon Sep 17 00:00:00 2001 From: Jason Boxman Date: Wed, 11 Sep 2024 14:00:58 -0400 Subject: [PATCH] OSDOCS-11732: Add dummy device as additional network - https://issues.redhat.com/browse/OSDOCS-11732 --- modules/nw-multus-dummy-device-object.adoc | 52 +++++++++++++++++++ .../configuring-additional-network.adoc | 4 ++ 2 files changed, 56 insertions(+) create mode 100644 modules/nw-multus-dummy-device-object.adoc diff --git a/modules/nw-multus-dummy-device-object.adoc b/modules/nw-multus-dummy-device-object.adoc new file mode 100644 index 0000000000..64afe7227a --- /dev/null +++ b/modules/nw-multus-dummy-device-object.adoc @@ -0,0 +1,52 @@ +// Module included in the following assemblies: +// +// * networking/multiple_networks/configuring-additional-network.adoc + +:_mod-docs-content-type: REFERENCE +[id="nw-multus-dummy-device-object_{context}"] += Configuration for a dummy device additional network + +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. + +The following object describes the configuration parameters for the dummy CNI plugin: + +.Dummy device CNI plugin JSON configuration object +[cols=".^2,.^2,.^6",options="header"] +|==== +|Field|Type|Description + +|`cniVersion` +|`string` +|The CNI specification version. The required value is `0.3.1`. + +|`name` +|`string` +|The value for the `name` parameter that you previously specified for the CNO configuration. + +|`type` +|`string` +|The name of the CNI plugin that you want to configure. The required value is `dummy`. + +|`ipam` +|`object` +|The configuration object for the IPAM CNI plugin. The plugin manages the IP address assignment for the attachment definition. + +|==== + +[id="nw-multus-dummy-device-config-example_{context}"] +== dummy configuration example + +The following example configures an additional network named `hostdev-net`: + +[source,json] +---- +{ + "cniVersion": "0.3.1", + "name": "dummy-net", + "type": "dummy", + "ipam": { + "type": "host-local", + "subnet": "10.1.1.0/24" + } +} +---- diff --git a/networking/multiple_networks/configuring-additional-network.adoc b/networking/multiple_networks/configuring-additional-network.adoc index ad609ce1b0..cf6674fda1 100644 --- a/networking/multiple_networks/configuring-additional-network.adoc +++ b/networking/multiple_networks/configuring-additional-network.adoc @@ -9,6 +9,7 @@ toc::[] As a cluster administrator, you can configure a primary network for your cluster. The following network types are supported: * xref:../../networking/multiple_networks/configuring-additional-network.adoc#nw-multus-bridge-object_configuring-additional-network[Bridge] +* xref:../../networking/multiple_networks/configuring-additional-network.adoc#nw-multus-dummy-device-object_configuring-additional-network[Dummy device] * xref:../../networking/multiple_networks/configuring-additional-network.adoc#nw-multus-host-device-object_configuring-additional-network[Host device] * xref:../../networking/multiple_networks/configuring-additional-network.adoc#nw-multus-vlan-object_configuring-additional-network[VLAN] * xref:../../networking/multiple_networks/configuring-additional-network.adoc#nw-multus-ipvlan-object_configuring-additional-network[IPVLAN] @@ -166,6 +167,9 @@ include::modules/nw-multus-bridge-object.adoc[leveloffset=+2] // Configuration for a host device additional network include::modules/nw-multus-host-device-object.adoc[leveloffset=+2] +// Configure for a dummy additional network +include::modules/nw-multus-dummy-device-object.adoc[leveloffset=+2] + // Configuration for an VLAN additional network include::modules/nw-multus-vlan-object.adoc[leveloffset=+2]