CUDN field |
UDN field |
Type |
Description |
spec.network.<topology>.joinSubnets
|
spec.<topology>.joinSubnets
|
object |
When omitted, the platform sets default values for the joinSubnets field of 100.65.0.0/16 for IPv4 and fd99::/64 for IPv6. If the default address values are used anywhere in the cluster’s network you must override it by setting the joinSubnets field. If you choose to set this field, ensure it does not conflict with other subnets in the cluster such as the cluster subnet, the default network cluster subnet, and the masquerade subnet.
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. |
spec.network.<topology>.excludeSubnets
|
spec.<topology>.excludeSubnets
|
string |
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.
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. |
spec.network.layer2.reservedSubnets
|
spec.layer2.reservedSubnets
|
object |
This optional field specifies a list of CIDRs reserved for static IP assignment, which therefore excludes it from automatic allocation.
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. |
spec.network.layer2.infrastructureSubnets
|
spec.layer2.infrastructureSubnets
|
object |
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. |
spec.network.layer2.defaultGatewayIPs
|
spec.layer2.defaultGatewayIPs
|
object |
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. |
spec.network.<topology>.ipam.lifecycle
|
spec.layer2.ipam.lifecycle
|
object |
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.
Setting a value of Persistent is only supported when ipam.mode parameter is set to Enabled. |
spec.network.<topology>.ipam.mode
|
spec.<topology>`ipam.mode
|
object |
The mode parameter controls how much of the IP configuration is managed by OVN-Kubernetes. The following options are available:
* Enabled: When enabled, OVN-Kubernetes applies the IP configuration to the SDN infrastructure and assigns IP addresses from the selected subnet to the individual pods. This is the default setting. When set to Enabled, the subnets field must be defined. Enabled is the default configuration.
* Disabled: When disabled, OVN-Kubernetes only assigns MAC addresses and provides layer 2 communication, which allows users to configure IP addresses. Disabled is only available for layer 2 (secondary) networks. By disabling IPAM, features that rely on selecting pods by IP, for example, network policy, services, and so on, no longer function. Additionally, IP port security is also disabled for interfaces attached to this network. The subnets field must be empty when spec.ipam.mode is set to Disabled.
|
spec.network.<topology>.mtu
|
spec.<topology>.mtu
|
integer |
The maximum transmission units (MTU). The default value is 1400. The boundary for IPv4 is 576, and for IPv6 it is 1280. |
spec.network.localnet.vlan
|
N/A |
object |
This field is optional and configures the virtual local area network (VLAN) tagging and allows you to segment the physical network into multiple independent broadcast domains. |
spec.network.localnet.vlan.mode
|
N/A |
object |
Acceptable values are Access. A value of Access specifies that the network interface belongs to a single VLAN and all traffic will be labelled with an id that is configured in the spec.network.localnet.vlan.mode.access.id field. The id specifies the VLAN id (VID) for access ports. Values must be an integer between 1 and 4094. |
spec.network.localnet.physicalNetworkName
|
N/A |
string |
Specifies the name for a physical network interface. The value you specify must match the network-name parameter that you provided in your Open vSwitch (OVS) bridge mapping. |
spec.network.transport
|
N/A |
string |
Specifies how pod traffic is carried on the cluster infrastructure for the ClusterUserDefinedNetwork CR. Accepted values are EVPN and NoOverlay. Additional configuration is required when setting the spec.network.transport field. For more information, see "About BGP EVPN for primary cluster user-defined networks" and "Improve east-west performance by routing pods on the underlay with BGP". |