Merge pull request #85441 from dfitzmau/OSDOCS-12303-phase-4

OSDOCS-12303-phase-4: Reorg of the networking operator docs

Author: dfitzmau

_topic_maps/_topic_map.yml

@@ -1344,15 +1344,15 @@ Topics:
   Dir: networking_operators
   Distros: openshift-enterprise,openshift-origin
   Topics:
-  - Name: About the Kubernetes NMState Operator
+  - Name: Kubernetes NMState Operator
     File: k8s-nmstate-about-the-k8s-nmstate-operator
   - Name: AWS Load Balancer Operator
     Dir: aws_load_balancer_operator
     Distros: openshift-enterprise,openshift-origin
     Topics:
     - Name: AWS Load Balancer Operator release notes
       File: aws-load-balancer-operator-release-notes
-    - Name: Understanding the AWS Load Balancer Operator
+    - Name: AWS Load Balancer Operator in OpenShift Container Platform
       File: understanding-aws-load-balancer-operator
     - Name: Installing the AWS Load Balancer Operator
       File: install-aws-load-balancer-operator
@@ -1362,9 +1362,9 @@ Topics:
       File: create-instance-aws-load-balancer-controller
     - Name: Serving multiple ingress resources through a single AWS Load Balancer
       File: multiple-ingress-through-single-alb
-    - Name: Adding TLS termination on the AWS Load Balancer
+    - Name: Adding TLS termination
       File: add-tls-termination
-    - Name: Configuring cluster-wide proxy on the AWS Load Balancer Operator
+    - Name: Configuring cluster-wide proxy
       File: configure-egress-proxy-aws-load-balancer-operator
   - Name: eBPF manager Operator
     Dir: ebpf_manager
@@ -1386,13 +1386,13 @@ Topics:
       File: nw-installing-external-dns-operator-on-cloud-providers
     - Name: External DNS Operator configuration parameters
       File: nw-configuration-parameters
-    - Name: Creating DNS records on a public hosted zone for AWS
+    - Name: Creating DNS records on AWS
       File: nw-creating-dns-records-on-aws
-    - Name: Creating DNS records on a public zone for Azure
+    - Name: Creating DNS records on Azure
       File: nw-creating-dns-records-on-azure
-    - Name: Creating DNS records on a public managed zone for GCP
+    - Name: Creating DNS records on GCP
       File: nw-creating-dns-records-on-gcp
-    - Name: Creating DNS records on a public DNS zone for Infoblox
+    - Name: Creating DNS records on Infoblox
       File: nw-creating-dns-records-on-infoblox
     - Name: Configuring the cluster-wide proxy on the External DNS Operator
       File: nw-configuring-cluster-wide-egress-proxy
@@ -1406,28 +1406,28 @@ Topics:
       File: metallb-operator-install
     - Name: Upgrading the MetalLB Operator
       File: metallb-upgrading-operator
-  - Name: Understanding the Cluster Network Operator
+  - Name: Cluster Network Operator in OpenShift Container Platform
     File: cluster-network-operator
     Distros: openshift-enterprise,openshift-origin
-  - Name: Understanding the DNS Operator
+  - Name: DNS Operator in OpenShift Container Platform
     File: dns-operator
     Distros: openshift-enterprise,openshift-origin
-  - Name: Understanding the Ingress Operator
+  - Name: Ingress Operator in OpenShift Container Platform
     File: ingress-operator
     Distros: openshift-enterprise,openshift-origin
-  - Name: Understanding the Ingress Node Firewall Operator
+  - Name: Ingress Node Firewall Operator in OpenShift Container Platform
     File: ingress-node-firewall-operator
     Distros: openshift-enterprise,openshift-origin
-#   - Name: SR-IOV Operator
-#     Dir: sr-iov-operator
-#     Distros: openshift-enterprise,openshift-origin
-#     Topics:
-#     - Name: Installing the SR-IOV Operator
-#       File: installing-sriov-operator
-#     - Name: Configuring the SR-IOV Operator
-#       File: configuring-sriov-operator
-#     - Name: Uninstalling the SR-IOV Operator
-#       File: uninstalling-sriov-operator
+  - Name: SR-IOV Operator
+    Dir: sr-iov-operator
+    Distros: openshift-enterprise,openshift-origin
+    Topics:
+    - Name: Installing the SR-IOV Operator
+      File: installing-sriov-operator
+    - Name: Configuring the SR-IOV Operator
+      File: configuring-sriov-operator
+    - Name: Uninstalling the SR-IOV Operator
+      File: uninstalling-sriov-operator
 - Name: Network security
   Dir: network_security
   Distros: openshift-enterprise,openshift-origin
@@ -1549,10 +1549,6 @@ Topics:
   Topics:
   - Name: About Single Root I/O Virtualization (SR-IOV) hardware networks
     File: about-sriov
-  - Name: Installing the SR-IOV Operator
-    File: installing-sriov-operator
-  - Name: Configuring the SR-IOV Operator
-    File: configuring-sriov-operator
   - Name: Configuring an SR-IOV network device
     File: configuring-sriov-device
   - Name: Configuring an SR-IOV Ethernet network attachment
@@ -1575,8 +1571,6 @@ Topics:
     File: configuring-hardware-offloading
   - Name: Switching Bluefield-2 from NIC to DPU mode
     File: switching-bf2-nic-dpu
-  - Name: Uninstalling the SR-IOV Operator
-    File: uninstalling-sriov-operator
 - Name: OVN-Kubernetes network plugin
   Dir: ovn_kubernetes_network_provider
   Topics:

_topic_maps/_topic_map_osd.yml

@@ -829,9 +829,9 @@ Topics:
   Dir: networking_operators
   Distros: openshift-dedicated
   Topics:
-  - Name: Understanding the DNS Operator
+  - Name: DNS Operator in OpenShift Dedicated
     File: dns-operator
-  - Name: Understanding the Ingress Operator
+  - Name: Ingress Operator in OpenShift Dedicated
     File: ingress-operator
 - Name: Network verification
   File: network-verification

_topic_maps/_topic_map_rosa.yml

@@ -1088,11 +1088,11 @@ Topics:
   Topics:
   - Name: AWS Load Balancer Operator
     File: aws-load-balancer-operator
-  - Name: Understanding the DNS Operator
+  - Name: DNS Operator in Red Hat OpenShift Service on AWS
     File: dns-operator
-  - Name: Understanding the Ingress Operator
+  - Name: Ingress Operator in Red Hat OpenShift Service on AWS
     File: ingress-operator
-  - Name: Understanding the Ingress Node Firewall Operator
+  - Name: Ingress Node Firewall Operator in Red Hat OpenShift Service on AWS
     File: ingress-node-firewall-operator
 - Name: Network verification
   File: network-verification

architecture/admission-plug-ins.adoc

@@ -28,7 +28,7 @@ endif::openshift-rosa,openshift-dedicated[]
 == Additional resources
 
 ifndef::openshift-rosa,openshift-dedicated[]
-* xref:../networking/hardware_networks/configuring-sriov-operator.adoc#configuring-sriov-operator[Configuring the SR-IOV Network Operator]
+* xref:../networking/networking_operators/sr-iov-operator/configuring-sriov-operator.adoc#configuring-sriov-operator_configuring-sriov-operator[Configuring the SR-IOV Network Operator]
 
 * xref:../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations_dedicating_nodes-scheduler-taints-tolerations[Controlling pod placement using node taints]
 endif::openshift-rosa,openshift-dedicated[]

hosted_control_planes/hcp-deploy/hcp-deploy-aws.adoc

@@ -26,7 +26,7 @@ include::modules/hcp-aws-prereqs.adoc[leveloffset=+2]
 
 * xref:../../hosted_control_planes/hcp-prepare/hcp-enable-disable.adoc#hcp-disable_hcp-enable-disable[Disabling the {hcp} feature]
 
-* xref:../../networking/hardware_networks/configuring-sriov-operator.adoc#sriov-operator-hosted-control-planes_configuring-sriov-operator[Deploying the SR-IOV Operator for {hcp}]
+* xref:../../networking/networking_operators/sr-iov-operator/configuring-sriov-operator.adoc#sriov-operator-hosted-control-planes_configuring-sriov-operator[Deploying the SR-IOV Operator for {hcp}]
 
 include::modules/hcp-aws-create-secret-s3.adoc[leveloffset=+1]
 

installing/installing_openstack/installing-openstack-nfv-preparing.adoc

@@ -39,7 +39,7 @@ After you perform preinstallation tasks, install your cluster by following the m
 * For either type of deployment:
 ** xref:../../scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed-by-apps.adoc#what-huge-pages-do_huge-pages[Configure the Node Tuning Operator with huge pages support].
 * To complete SR-IOV configuration after you deploy your cluster:
-** xref:../../networking/hardware_networks/installing-sriov-operator.adoc#installing-sr-iov-operator_installing-sriov-operator[Install the SR-IOV Operator].
+** xref:../../networking/networking_operators/sr-iov-operator/installing-sriov-operator.adoc#installing-sr-iov-operator_installing-sriov-operator[Install the SR-IOV Operator].
 ** xref:../../networking/hardware_networks/configuring-sriov-device.adoc#nw-sriov-networknodepolicy-object_configuring-sriov-device[Configure your SR-IOV network device].
 ** xref:../../machine_management/creating_machinesets/creating-machineset-osp.adoc#machineset-yaml-osp-sr-iov_creating-machineset-osp[Create SR-IOV compute machines].
 * Consult the following references after you deploy your cluster to improve its performance:

modules/nw-ne-openshift-ingress.adoc

@@ -4,7 +4,8 @@
 
 [id="nw-ne-openshift-ingress_{context}"]
 = {product-title} Ingress Operator
-When you create your {product-title} cluster, pods and services running on the cluster are each allocated their own IP addresses. The IP addresses are accessible to other pods and services running nearby but are not accessible to outside clients. The Ingress Operator implements the `IngressController` API and is the component responsible for enabling external access to {product-title} cluster services.
+
+When you create your {product-title} cluster, pods and services running on the cluster are each allocated their own IP addresses. The IP addresses are accessible to other pods and services running nearby but are not accessible to outside clients.
 
 ifndef::openshift-rosa,openshift-dedicated[]
 The Ingress Operator makes it possible for external clients to access your service by deploying and managing one or more HAProxy-based

modules/nw-sriov-nic-partitioning.adoc

@@ -2,6 +2,7 @@
 //
 // * networking/hardware_networks/configuring-sriov-device.adoc
 
+:_mod-docs-content-type: REFERENCE
 [id="nw-sriov-nic-partitioning_{context}"]
 = Virtual function (VF) partitioning for SR-IOV devices
 

networking/hardware_networks/about-sriov.adoc

@@ -8,6 +8,8 @@ toc::[]
 
 The Single Root I/O Virtualization (SR-IOV) specification is a standard for a type of PCI device assignment that can share a single device with multiple pods.
 
+You can configure a Single Root I/O Virtualization (SR-IOV) device in your cluster by using the xref:../../networking/networking_operators/sr-iov-operator/installing-sriov-operator.adoc#installing-sriov-operator[SR-IOV Operator].
+
 SR-IOV can segment a compliant network device, recognized on the host node as a physical function (PF), into multiple virtual functions (VFs).
 The VF is used like any other network device.
 The SR-IOV network device driver for the device determines how the VF is exposed in the container:
@@ -33,11 +35,17 @@ You can enable SR-IOV on a node by using the following command:
 $ oc label node <node_name> feature.node.kubernetes.io/network-sriov.capable="true"
 ----
 
+[discrete]
+[role="_additional-resources"]
+[id="additional-resources-about-sr-iov_{context}"]
+== Additional resources
+
+* xref:../../networking/networking_operators/sr-iov-operator/installing-sriov-operator.adoc#installing-sriov-operator[Installing the SR-IOV Network Operator]
+
 [id="components-sr-iov-network-devices"]
 == Components that manage SR-IOV network devices
 
-The SR-IOV Network Operator creates and manages the components of the SR-IOV stack.
-It performs the following functions:
+The SR-IOV Network Operator creates and manages the components of the SR-IOV stack. The Operator performs the following functions:
 
 - Orchestrates discovery and management of SR-IOV network devices
 - Generates `NetworkAttachmentDefinition` custom resources for the SR-IOV Container Network Interface (CNI)
@@ -87,8 +95,7 @@ include::modules/nw-sriov-huge-pages.adoc[leveloffset=+2]
 [id="about-sriov-next-steps"]
 == Next steps
 
-* xref:../../networking/hardware_networks/installing-sriov-operator.adoc#installing-sriov-operator[Installing the SR-IOV Network Operator]
-* Optional: xref:../../networking/hardware_networks/configuring-sriov-operator.adoc#configuring-sriov-operator[Configuring the SR-IOV Network Operator]
+* Optional: xref:../../networking/networking_operators/sr-iov-operator/configuring-sriov-operator.adoc#configuring-sriov-operator[Configuring the SR-IOV Network Operator]
 * xref:../../networking/hardware_networks/configuring-sriov-device.adoc#configuring-sriov-device[Configuring an SR-IOV network device]
 * If you use {VirtProductName}: xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-connecting-vm-to-sriov[Connecting a virtual machine to an SR-IOV network]
 * xref:../../networking/hardware_networks/configuring-sriov-net-attach.adoc#configuring-sriov-net-attach[Configuring an SR-IOV network attachment]

networking/hardware_networks/add-pod.adoc

@@ -8,6 +8,8 @@ toc::[]
 
 You can add a pod to an existing Single Root I/O Virtualization (SR-IOV) network.
 
+Before you perform any tasks in the following documentation, ensure that you xref:../../networking/networking_operators/sr-iov-operator/installing-sriov-operator.adoc#installing-sriov-operator[installed the SR-IOV Network Operator].
+
 include::modules/nw-sriov-runtime-config.adoc[leveloffset=+1]
 
 include::modules/nw-multus-add-pod.adoc[leveloffset=+1]