Skip to content

Commit 4eb7aa6

Browse files
stevsmitstevsmit
authored
Merge pull request #84432 from stevsmit/11461-udn-support-matrix
OSDOCS-11461:support matrix module for UDN
2 parents e901131 + f4f5ead commit 4eb7aa6

File tree

2 files changed

+155
-1
lines changed

2 files changed

+155
-1
lines changed

‎modules/nw-udn-support-matrix-primary-secondary.adoc

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
//module included in the following assembly:
2+
//
3+
// *networkking/multiple_networks/understanding-user-defined-networks.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="support-matrix-for-udn-nad_{context}"]
7+
= UserDefinedNetwork and NetworkAttachmentDefinition support matrix
8+
9+
The `UserDefinedNetwork` and `NetworkAttachmentDefinition` custom resources (CRs) provide cluster administrators and users the ability to create customizable network configurations and define their own network topologies, ensure network isolation, manage IP addressing for workloads, and configure advanced network features. A third CR, `ClusterUserDefinedNetwork`, is also available, which allows administrators the ability to create and define additional networks spanning multiple namespaces at the cluster level.
10+
11+
User-defined networks and network attachment definitions can serve as both the primary and secondary network interface, and each support `layer2` and `layer3` topologies; a third network topology, Localnet, is also supported with network attachment definitions with secondary networks.
12+
13+
[NOTE]
14+
====
15+
As of {product-title} 4.18, the Localnet topology is unavailable for use with the `UserDefinedNetwork` and `ClusterUserDefinedNetwork` CRs. It is only available for `NetworkAttachmentDefinition` CRs that leverage secondary networks.
16+
====
17+
18+
The following section highlights the supported features of the `UserDefinedNetwork` and `NetworkAttachmentDefinition` CRs when they are used as either the primary or secondary network. A separate table for the `ClusterUserDefinedNetwork` CR is also included.
19+
20+
.Primary network support matrix for `UserDefinedNetwork` and `NetworkAttachmentDefinition` CRs
21+
[cols="1a,1a,1a, options="header"]
22+
|===
23+
^| Network feature ^| Layer2 topology ^|Layer3 topology
24+
25+
^| east-west traffic
26+
^| ✓
27+
^| ✓
28+
29+
^| north-south traffic
30+
^| ✓
31+
^| ✓
32+
33+
^| Persistent IPs
34+
^| ✓
35+
^| X
36+
37+
^| Services
38+
^| ✓
39+
^| ✓
40+
41+
^| `EgressIP` resource
42+
^| ✓
43+
^| ✓
44+
45+
^| Multicast ^[1]^
46+
^| X
47+
^| ✓
48+
49+
^| `NetworkPolicy` resource ^[2]^
50+
^| ✓
51+
^| ✓
52+
53+
^| `MultinetworkPolicy` resource
54+
^| X
55+
^| X
56+
57+
|===
58+
1. Multicast must be enabled in the namespace, and it is only available between OVN-Kubernetes network pods. For more information about multicast, see "Enabling multicast for a project".
59+
2. When creating a `UserDefinedNetwork` CR with a primary network type, network policies must be created _after_ the `UserDefinedNetwork` CR.
60+
61+
.Secondary network support matrix for `UserDefinedNetwork` and `NetworkAttachmentDefinition` CRs
62+
[cols="1a,1a,1a,1a, options="header"]
63+
|===
64+
^| Network feature ^| Layer2 topology ^|Layer3 topology ^|Localnet topology ^[1]^
65+
66+
^| east-west traffic
67+
^| ✓
68+
^| ✓
69+
^| ✓ (`NetworkAttachmentDefinition` CR only)
70+
71+
^| north-south traffic
72+
^| X
73+
^| X
74+
^| ✓
75+
76+
^| Persistent IPs
77+
^| ✓
78+
^| X
79+
^| ✓ (`NetworkAttachmentDefinition` CR only)
80+
81+
^| Services
82+
^| X
83+
^| X
84+
^| X
85+
86+
^| `EgressIP` resource
87+
^| X
88+
^| X
89+
^| X
90+
91+
^| Multicast
92+
^| X
93+
^| X
94+
^| X
95+
96+
^| `NetworkPolicy` resource
97+
^| X
98+
^| X
99+
^| X
100+
101+
^| `MultinetworkPolicy` resource
102+
^| ✓
103+
^| ✓
104+
^| ✓ (`NetworkAttachmentDefinition` CR only)
105+
106+
|===
107+
1. The Localnet topology is unavailable for use with the `UserDefinedNetwork` CR. It is only supported on secondary networks for `NetworkAttachmentDefinition` CRs.
108+
109+
.Support matrix for `ClusterUserDefinedNetwork` CRs
110+
[cols="1a,1a,1a, options="header"]
111+
|===
112+
^| Network feature ^| Layer2 topology ^|Layer3 topology
113+
114+
^| east-west traffic
115+
^| ✓
116+
^| ✓
117+
118+
^| north-south traffic
119+
^| ✓
120+
^| ✓
121+
122+
^| Persistent IPs
123+
^| ✓
124+
^| X
125+
126+
^| Services
127+
^| ✓
128+
^| ✓
129+
130+
^| `EgressIP` resource
131+
^| ✓
132+
^| ✓
133+
134+
^| Multicast ^[1]^
135+
^| X
136+
^| ✓
137+
138+
^| `MultinetworkPolicy` resource
139+
^| X
140+
^| X
141+
142+
^| `NetworkPolicy` resource ^[2]^
143+
^| ✓
144+
^| ✓
145+
146+
|===
147+
1. Multicast must be enabled in the namespace, and it is only available between OVN-Kubernetes network pods. For more information, see "About multicast".
148+
2. When creating a `ClusterUserDefinedNetwork` CR with a primary network type, network policies must be created _after_ the `UserDefinedNetwork` CR.

‎networking/multiple_networks/understanding-multiple-networks.adoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,10 @@ networks in your cluster:
6767

6868
* *TAP*: xref:../../networking/multiple_networks/secondary_networks/creating-secondary-nwt-other-cni.adoc#nw-multus-tap-object_configuring-additional-network-cni[Configure a TAP-based additional network] to create a tap device inside the container namespace. A TAP device enables user space programs to send and receive network packets.
6969

70-
* *SR-IOV*: xref:../../networking/hardware_networks/about-sriov.adoc#about-sriov[Configure an SR-IOV based additional network] to allow pods to attach to a virtual function (VF) interface on SR-IOV capable hardware on the host system.
70+
* *SR-IOV*: xref:../../networking/hardware_networks/about-sriov.adoc#about-sriov[Configure an SR-IOV based additional network] to allow pods to attach to a virtual function (VF) interface on SR-IOV capable hardware on the host system.
71+
72+
include::modules/nw-udn-support-matrix-primary-secondary.adoc[leveloffset=+1]
73+
74+
.Additional resources
75+
76+
* xref:../../networking/ovn_kubernetes_network_provider/enabling-multicast.adoc#nw-ovn-kubernetes-enabling-multicast[Enabling multicast for a project]

0 commit comments

Comments
 (0)