Skip to content

Commit 19bd68d

Browse files
JoeAldingerSteven Smith
authored andcommitted
OSDOCS-11974:reorg of multi nwt docs
trying xref fix topics map rebase modularizes benefits for mulit nwt docs Addresses Suryas comments Commit three
1 parent 89aa916 commit 19bd68d

34 files changed

+363
-147
lines changed

_topic_maps/_topic_map.yml

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1520,22 +1520,38 @@ Topics:
15201520
Topics:
15211521
- Name: Understanding multiple networks
15221522
File: understanding-multiple-networks
1523-
- Name: Understanding user defined networks
1524-
File: understanding-user-defined-network
1525-
- Name: Configuring an additional network
1526-
File: configuring-additional-network
1523+
- Name: Primary networks
1524+
Dir: primary_networks
1525+
Distros: openshift-enterprise, openshift-origin
1526+
Topics:
1527+
- Name: UserDefinedNetwork CR
1528+
File: about-user-defined-networks
1529+
- Name: NetworkAttachmentDefinition CR
1530+
File: about-primary-nwt-nad
1531+
- Name: Secondary networks
1532+
Dir: secondary_networks
1533+
Distros: openshift-enterprise, openshift-origin
1534+
Topics:
1535+
- Name: Creating secondary networks on OVN-Kubernetes
1536+
File: creating-secondary-nwt-ovnk
1537+
- Name: Creating secondary networks with other CNI plugins
1538+
File: creating-secondary-nwt-other-cni
1539+
- Name: Attaching a pod to an additional network
1540+
File: attaching-pod
1541+
- Name: Configuring multi-network policies
1542+
File: configuring-multi-network-policy
1543+
- Name: Removing a pod from an additional network
1544+
File: removing-pod
1545+
- Name: Editing an additional network
1546+
File: editing-additional-network
1547+
- Name: Configuring IP address assignment for secondary networks
1548+
File: configuring-ip-secondary-nwt
1549+
- Name: Configuring the master interface in the container network namespace
1550+
File: configuring-master-interface
1551+
- Name: Removing an additional network
1552+
File: removing-additional-network
15271553
- Name: About virtual routing and forwarding
15281554
File: about-virtual-routing-and-forwarding
1529-
- Name: Configuring multi-network policy
1530-
File: configuring-multi-network-policy
1531-
- Name: Attaching a pod to an additional network
1532-
File: attaching-pod
1533-
- Name: Removing a pod from an additional network
1534-
File: removing-pod
1535-
- Name: Editing an additional network
1536-
File: edit-additional-network
1537-
- Name: Removing an additional network
1538-
File: remove-additional-network
15391555
- Name: Assigning a secondary network to a VRF
15401556
File: assigning-a-secondary-network-to-a-vrf
15411557
- Name: Hardware networks

installing/installing_openstack/installing-openstack-installer-ovs-dpdk.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ include::modules/networking-osp-enabling-vfio-noiommu.adoc[leveloffset=+1]
5959
include::modules/installation-osp-dpdk-binding-vfio-pci.adoc[leveloffset=+1]
6060
include::modules/installation-osp-dpdk-exposing-host-interface.adoc[leveloffset=+1]
6161

62-
.Additional resources
62+
.Additional resource
6363

64-
* xref:../../networking/multiple_networks/configuring-additional-network.adoc#nw-multus-host-device-object_configuring-additional-network[Creating an additional network attachment with the Cluster Network Operator]
64+
* xref:../../networking/multiple_networks/primary_networks/creating-primary-nad.adoc#creating-primary-nad[Creating an additional network attachment with the Cluster Network Operator]
6565

6666
The cluster is installed and prepared for configuration. You must now perform the OVS-DPDK configuration tasks in <<next-steps_installing-openstack-installer-ovs-dpdk, Next steps>>.
6767

modules/nw-nad-cr.adoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/multiple_networks/creating-primary-nad.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="nw-nad-cr_{context}"]
7+
== Configuration for an additional network attachment
8+
9+
An additional network is configured by using the `NetworkAttachmentDefinition` API in the `k8s.cni.cncf.io` API group.
10+
11+
The configuration for the API is described in the following table:
12+
13+
.`NetworkAttachmentDefinition` API fields
14+
[cols=".^3,.^2,.^5",options="header"]
15+
|====
16+
|Field|Type|Description
17+
18+
|`metadata.name`
19+
|`string`
20+
|The name for the additional network.
21+
22+
|`metadata.namespace`
23+
|`string`
24+
|The namespace that the object is associated with.
25+
26+
|`spec.config`
27+
|`string`
28+
|The CNI plugin configuration in JSON format.
29+
30+
|====

modules/nw-udn-benefits.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
//module included in the following assembly:
2+
//
3+
// *networking/multiple_networks/about-user-defined-networks.adoc
4+
:_mod-docs-content-type: REFERENCE
5+
[id="nw-udn-benefits_{context}"]
6+
= Benefits of a user-defined network
7+
8+
User-defined networks provide the following benefits:
9+
10+
. Enhanced network isolation for security
11+
+
12+
* **Tenant isolation**: Namespaces can have their own isolated primary network, similar to how tenants are isolated in {rh-openstack-first}. This improves security by reducing the risk of cross-tenant traffic.
13+
14+
. Network flexibility
15+
+
16+
* **Layer 2 and layer 3 support**: Cluster administrators can configure primary networks as layer 2 or layer 3 network types. This provides the flexibility of a secondary network to the primary network.
17+
18+
. Simplified network management
19+
+
20+
* **Reduced network configuration complexity**: With user-defined networks, the need for complex network policies are eliminated because isolation can be achieved by grouping workloads in different networks.
21+
22+
. Advanced capabilities
23+
+
24+
* **Consistent and selectable IP addressing**: Users can specify and reuse IP subnets across different namespaces and clusters, providing a consistent networking environment.
25+
+
26+
* **Support for multiple networks**: The user-defined networking feature allows administrators to connect multiple namespaces to a single network, or to create distinct networks for different sets of namespaces.
27+
28+
. Simplification of application migration from {rh-openstack-first}
29+
+
30+
* **Network parity**: With user-defined networking, the migration of applications from OpenStack to {product-title} is simplified by providing similar network isolation and configuration options.
31+
32+
Developers and administrators can create a user-defined network that is namespace scoped using the custom resource. An overview of the process is: create a namespace, create and configure the custom resource, create pods in the namespace.

networking/hardware_networks/about-sriov.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ include::modules/nw-sriov-huge-pages.adoc[leveloffset=+2]
9090
[id="configure-multi-networks-additional-resources"]
9191
== Additional resources
9292

93-
* xref:../../networking/multiple_networks/configuring-multi-network-policy.adoc#configuring-multi-network-policy[Configuring multi-network policy]
93+
* xref:../../networking/multiple_networks/secondary_networks/configuring-multi-network-policy.adoc#configuring-multi-network-policy[Configuring multi-network policy]
9494

9595
[id="about-sriov-next-steps"]
9696
== Next steps

networking/hardware_networks/configuring-sriov-ib-attach.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ include::modules/nw-multus-configure-dualstack-ip-address.adoc[leveloffset=+2]
2121

2222
[role="_additional-resources"]
2323
.Additional resources
24-
* xref:../../networking/multiple_networks/attaching-pod.html#nw-multus-add-pod_attaching-pod[Attaching a pod to an additional network]
24+
* xref:../../networking/multiple_networks/secondary_networks/attaching-pod.adoc#attaching-pod[Attaching a pod to an additional network]
2525
2626
// Configuring SR-IOV additional network
2727
include::modules/nw-sriov-network-attachment.adoc[leveloffset=+1]

networking/hardware_networks/configuring-sriov-net-attach.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ include::modules/nw-multus-configure-dualstack-ip-address.adoc[leveloffset=+2]
1717

1818
[role="_additional-resources"]
1919
.Additional resources
20-
* xref:../../networking/multiple_networks/attaching-pod.html#nw-multus-add-pod_attaching-pod[Attaching a pod to an additional network]
20+
* xref:../../networking/multiple_networks/secondary_networks/attaching-pod.adoc#attaching-pod[Attaching a pod to an additional network]
2121
2222
include::modules/nw-sriov-network-attachment.adoc[leveloffset=+1]
2323

networking/hardware_networks/configuring-sriov-qinq-support.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ include::modules/nw-sriov-about-qinq.adoc[leveloffset=+1]
1515
[role="_additional-resources"]
1616
.Additional resources
1717

18-
* xref:../../networking/multiple_networks/configuring-additional-network.adoc#nw-multus-vlan-object_configuring-additional-network[Configuration for an VLAN additional network]
18+
xref:../../networking/multiple_networks/secondary_networks/creating-secondary-nwt-other-cni.adoc#nw-multus-vlan-object_configuring-additional-network-cni[Configuration for an VLAN additional network]
1919

2020
include::modules/nw-configuring-qinq-sriov-proc.adoc[leveloffset=+1]

networking/hardware_networks/using-dpdk-and-rdma.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ include::modules/nw-running-dpdk-rootless-tap.adoc[leveloffset=+1]
2222
[role="_additional-resources"]
2323
.Additional resources
2424

25-
* xref:../../networking/multiple_networks/configuring-additional-network.adoc#nw-multus-enable-container_use_devices_configuring-additional-network[Enabling the container_use_devices boolean]
25+
// I can't seem to find this in 4.16 or 4.15 * xr3f:../../networking/multiple_networks/configuring-additional-network.adoc#nw-multus-enable-container_use_devices_configuring-additional-network[Enabling the container_use_devices boolean]
2626

2727
* xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-create-performance-profiles[Creating a performance profile]
2828
@@ -68,9 +68,7 @@ include::modules/nw-openstack-hw-offload-testpmd-pod.adoc[leveloffset=+1]
6868
* xref:../../networking/networking_operators/sr-iov-operator/installing-sriov-operator.adoc#installing-sriov-operator[Installing the SR-IOV Network Operator]
6969

7070
* xref:../../networking/hardware_networks/configuring-sriov-device.adoc#nw-sriov-networknodepolicy-object_configuring-sriov-device[Configuring an SR-IOV network device]
71-
72-
* xref:../../networking/multiple_networks/configuring-additional-network.adoc#nw-multus-whereabouts_configuring-additional-network[Dynamic IP address assignment configuration with Whereabouts]
73-
71+
* xref:../../networking/multiple_networks/secondary_networks/configuring-ip-secondary-nwt.adoc#nw-multus-whereabouts_configuring-additional-network[Dynamic IP address assignment configuration with Whereabouts]
7472
* xref:../../scalability_and_performance/low_latency_tuning/cnf-provisioning-low-latency-workloads.adoc#disabling-interrupt-processing-for-individual-pods_cnf-provisioning-low-latency[Disabling interrupt processing for individual pods]
7573

7674
* xref:../../networking/hardware_networks/configuring-sriov-net-attach.adoc#configuring-sriov-net-attach[Configuring an SR-IOV Ethernet network attachment]

networking/multiple_networks/about-virtual-routing-and-forwarding.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="about-virtual-routing-and-forwarding"]
3-
= About virtual routing and forwarding
2+
[id="virtual-routing-and-forwarding"]
3+
= Virtual routing and forwarding
44
include::_attributes/common-attributes.adoc[]
55
:context: about-virtual-routing-and-forwarding
66

0 commit comments

Comments
 (0)