Skip to content

Commit e2b180e

Browse files
authored
Merge pull request #89059 from kquinn1204/OCPBUGS-50848
OCPBUGS-50848 Section IP address assignment for additional networks missing from docs after reorg
2 parents ea1d2d8 + 475c3d8 commit e2b180e

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

modules/nw-multus-ipam-object.adoc

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,26 @@ endif::[]
1717
[id="nw-multus-ipam-object_{context}"]
1818
= Configuration of IP address assignment for an additional network
1919

20-
The IP address management (IPAM) Container Network Interface (CNI) plugin provides IP addresses for other CNI plugins.
20+
For additional networks, IP addresses can be assigned using an IP Address Management (IPAM) CNI plugin, which supports various assignment methods, including Dynamic Host Configuration Protocol (DHCP) and static assignment.
2121

22-
You can use the following IP address assignment types:
22+
The DHCP IPAM CNI plugin responsible for dynamic assignment of IP addresses operates with two distinct components:
2323

24-
- Static assignment.
25-
- Dynamic assignment through a DHCP server. The DHCP server you specify must be reachable from the additional network.
26-
- Dynamic assignment through the Whereabouts IPAM CNI plugin.
24+
* *CNI Plugin*: Responsible for integrating with the Kubernetes networking stack to request and release IP addresses.
25+
* *DHCP IPAM CNI Daemon*: A listener for DHCP events that coordinates with existing DHCP servers in the environment to handle IP address assignment requests. This daemon is _not_ a DHCP server itself.
26+
27+
For networks requiring `type: dhcp` in their IPAM configuration, ensure the following:
28+
29+
* A DHCP server is available and running in the environment. The DHCP server is external to the cluster and is expected to be part of the customer's existing network infrastructure.
30+
* The DHCP server is appropriately configured to serve IP addresses to the nodes.
31+
32+
In cases where a DHCP server is unavailable in the environment, it is recommended to use the Whereabouts IPAM CNI plugin instead. The Whereabouts CNI provides similar IP address management capabilities without the need for an external DHCP server.
33+
34+
[NOTE]
35+
====
36+
Use the Whereabouts CNI plugin when there is no external DHCP server or where static IP address management is preferred. The Whereabouts plugin includes a reconciler daemon to manage stale IP address allocations.
37+
====
38+
39+
A DHCP lease must be periodically renewed throughout the container's lifetime, so a separate daemon, the DHCP IPAM CNI Daemon, is required. To deploy the DHCP IPAM CNI daemon, modify the Cluster Network Operator (CNO) configuration to trigger the deployment of this daemon as part of the additional network setup.
2740

2841
////
2942
IMPORTANT: If you set the `type` parameter to the `DHCP` value, you cannot set

networking/multiple_networks/secondary_networks/configuring-ip-secondary-nwt.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
The following sections provide instructions and information for how to configure IP address assignments for secondary networks.
9+
The following sections give instructions and information for how to configure IP address assignments for secondary networks.
1010

1111
include::modules/nw-multus-ipam-object.adoc[leveloffset=+1]
1212

0 commit comments

Comments
 (0)