Skip to content

Commit b72f9ad

Browse files
committed
OSDOCS-15266:updates additional configs for UDN ingress/egress non-nated
updates from QE
1 parent b60fdc6 commit b72f9ad

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

modules/nw-udn-additional-config-details.adoc

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
The following table explains additional configurations for `ClusterUserDefinedNetwork` and `UserDefinedNetwork` custom resources (CRs) that are optional. It is not recommended to set these fields without explicit need and understanding of OVN-Kubernetes network topology.
1010

1111
. Optional configurations for user-defined networks
12-
[cols="2,1,7", options="header"]
12+
[cols="2,1,7",options="header"]
1313
|====
1414

1515
|CUDN field|UDN field|Type|Description
@@ -22,14 +22,30 @@ The following table explains additional configurations for `ClusterUserDefinedNe
2222
The `joinSubnets` field configures the routing between different segments within a user-defined network. Dual-stack clusters can set 2 subnets, one for each IP family; otherwise, only 1 subnet is allowed. This field is only allowed for the `Primary` network.
2323

2424
|`spec.network.<topology>.excludeSubnets`
25-
|`spec.<topology>.exlcudeSubnets`
25+
|`spec.<topology>.excludeSubnets`
2626
|string
27-
|Specifies a list of CIDRs to be removed from the specified CIDRs in the `subnets` field. The CIDRs in this list must be in range of at least one subnet specified in `subnets`. When omitted, no IP addresses are excluded, and all IP addresses specified in the `subnets` field are subject to assignment. You must use standard CIDR notation. For example, `10.128.0.0/16`. This field must be omitted if the `subnets` field is not set or if the `ipam.mode` field is set to `Disabled`. You can only set 25 values for the `excludeSubnets` field.
27+
|Specifies a list of CIDRs to be removed from the CIDRs specified in the `subnets` field. The CIDRs in this list must be in range of at least one subnet specified in the `subnets` field. When omitted, OVN-Kubernetes assigns all IP addresses specified in the `subnets` field. You must use standard CIDR notation. For example, `10.128.0.0/16`. You must omit this field if the `subnets` field is not set or if the `ipam.mode` field is set to `Disabled`. You can only set 25 values for the `excludeSubnets` field.
2828

2929
When deploying a secondary network with `Localnet` topology, the IP ranges used in your physical network must be explicitly listed in the `excludeSubnets` field to prevent IP duplication in your subnet.
3030

31+
|`spec.network.layer2.reservedSubnets`
32+
|`spec.layer2.reservedSubnets`
33+
|object
34+
|This optional field specifies a list of CIDRs reserved for static IP assignment, which therefore excludes it from automatic allocation.
35+
When omitted, all IP addresses in the `subnets` field are available for automatic assignment. All IP addresses in the listed ranges are available to request through static IP assignment in pod annotations. Each address must be in the CIDR range specified in the `subnets` field. The field only accepts 25 entries. The format should match standard CIDR notation (for example, `10.128.0.0/16`). You must omit this field if the `subnets` field is unset or the `ipam.mode` field is `Disabled`. Specifies a reserved list of addresses for workloads. You can set this field to reserve IP addresses that pods can then request in the future.
36+
37+
|`spec.network.layer2.infrastructureSubnets`
38+
|`spec.layer2.infrastructureSubnets`
39+
|object
40+
|This optional field specifies addresses used for OVN-Kubernetes internal network infrastructure. You cannot assign any IP addresses within these ranges to workloads. When omitted, OVN-Kubernetes automatically assigns IP addresses from the `subnets` field for its infrastructure needs. When the `reservedSubnets` field are also specified, the CIDRs cannot overlap. Additionally when the `defaultGatewayIPs` field are also specified, the default gateway IP addresses must belong to one of the CIDRs. Each address must be in the CIDR range specified in `subnets`. The maximum number of entries allowed is 10. The format should match standard CIDR notation (for example, `10.128.0.0/16`). You must omit this field if the `subnets` field is unset or the `ipam.mode` field is `Disabled`.
41+
42+
|`spec.network.layer2.defaultGatewayIPs`
43+
|`spec.layer2.defaultGatewayIPs`
44+
|object
45+
|This field is optional and specifies an IP address that overrides the addresses assigned by default for the gateway. Acceptable values are both IPv4 and IPv6 addresses for dual stack clusters. Specifies the default gateway IP address used in the internal OVN-Kubernetes topology. Dual-stack clusters can set two IP addresses (one for each IP family), otherwise only one IP address can be used. This field is only allowed when the `role` field is set to `Primary`. It is not recommended to set this field without explicit need and understanding of the OVN-Kubernetes network topology. When omitted, OVN-Kubernetes assigns the first IP address from the network's `subnet` field.
46+
3147
|`spec.network.<topology>.ipam.lifecycle`
32-
|`spec.<topology>.ipam.lifecycle`
48+
|`spec.layer2.ipam.lifecycle`
3349
|object
3450
|The `spec.ipam.lifecycle` field configures the IP address management system (IPAM). You might use this field for virtual workloads to ensure persistent IP addresses. The only allowed value is `Persistent`, which ensures that your virtual workloads have persistent IP addresses across reboots and migration. These are assigned by the container network interface (CNI) and used by OVN-Kubernetes to program pod IP addresses. You must not change this for pod annotations.
3551

0 commit comments

Comments
 (0)