Skip to content

OSDOCS-11732: Add dummy device as additional network #81643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

OSDOCS-11732: Add dummy device as additional network #81643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions modules/nw-multus-dummy-device-object.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
== dummy configuration example
== 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"
}
}
----
4 changes: 4 additions & 0 deletions networking/multiple_networks/configuring-additional-network.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ toc::[]
As a cluster administrator, you can configure an additional 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]
Expand Down Expand Up @@ -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]

Expand Down