Skip to content

Commit 9e6d930

Browse files
authored
Merge pull request #85589 from dfitzmau/OSDOCS-12303-phase-4-16
[enterprise-4.16] 4.16 Cherry pick for OSDOCS-12303-phase-4
2 parents 40987d7 + 3b8b2c0 commit 9e6d930

File tree

44 files changed

+164
-67
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+164
-67
lines changed

_topic_maps/_topic_map.yml

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1283,15 +1283,15 @@ Topics:
12831283
Dir: networking_operators
12841284
Distros: openshift-enterprise,openshift-origin
12851285
Topics:
1286-
- Name: About the Kubernetes NMState Operator
1286+
- Name: Kubernetes NMState Operator
12871287
File: k8s-nmstate-about-the-k8s-nmstate-operator
12881288
- Name: AWS Load Balancer Operator
12891289
Dir: aws_load_balancer_operator
12901290
Distros: openshift-enterprise,openshift-origin
12911291
Topics:
12921292
- Name: AWS Load Balancer Operator release notes
12931293
File: aws-load-balancer-operator-release-notes
1294-
- Name: Understanding the AWS Load Balancer Operator
1294+
- Name: AWS Load Balancer Operator in OpenShift Container Platform
12951295
File: understanding-aws-load-balancer-operator
12961296
- Name: Installing the AWS Load Balancer Operator
12971297
File: install-aws-load-balancer-operator
@@ -1301,9 +1301,9 @@ Topics:
13011301
File: create-instance-aws-load-balancer-controller
13021302
- Name: Serving multiple ingress resources through a single AWS Load Balancer
13031303
File: multiple-ingress-through-single-alb
1304-
- Name: Adding TLS termination on the AWS Load Balancer
1304+
- Name: Adding TLS termination
13051305
File: add-tls-termination
1306-
- Name: Configuring cluster-wide proxy on the AWS Load Balancer Operator
1306+
- Name: Configuring cluster-wide proxy
13071307
File: configure-egress-proxy-aws-load-balancer-operator
13081308
- Name: External DNS Operator
13091309
Dir: external_dns_operator
@@ -1316,13 +1316,13 @@ Topics:
13161316
File: nw-installing-external-dns-operator-on-cloud-providers
13171317
- Name: External DNS Operator configuration parameters
13181318
File: nw-configuration-parameters
1319-
- Name: Creating DNS records on a public hosted zone for AWS
1319+
- Name: Creating DNS records on AWS
13201320
File: nw-creating-dns-records-on-aws
1321-
- Name: Creating DNS records on a public zone for Azure
1321+
- Name: Creating DNS records on Azure
13221322
File: nw-creating-dns-records-on-azure
1323-
- Name: Creating DNS records on a public managed zone for GCP
1323+
- Name: Creating DNS records on GCP
13241324
File: nw-creating-dns-records-on-gcp
1325-
- Name: Creating DNS records on a public DNS zone for Infoblox
1325+
- Name: Creating DNS records on Infoblox
13261326
File: nw-creating-dns-records-on-infoblox
13271327
- Name: Configuring the cluster-wide proxy on the External DNS Operator
13281328
File: nw-configuring-cluster-wide-egress-proxy
@@ -1336,28 +1336,28 @@ Topics:
13361336
File: metallb-operator-install
13371337
- Name: Upgrading the MetalLB Operator
13381338
File: metallb-upgrading-operator
1339-
- Name: Understanding the Cluster Network Operator
1339+
- Name: Cluster Network Operator in OpenShift Container Platform
13401340
File: cluster-network-operator
13411341
Distros: openshift-enterprise,openshift-origin
1342-
- Name: Understanding the DNS Operator
1342+
- Name: DNS Operator in OpenShift Container Platform
13431343
File: dns-operator
13441344
Distros: openshift-enterprise,openshift-origin
1345-
- Name: Understanding the Ingress Operator
1345+
- Name: Ingress Operator in OpenShift Container Platform
13461346
File: ingress-operator
13471347
Distros: openshift-enterprise,openshift-origin
1348-
- Name: Understanding the Ingress Node Firewall Operator
1348+
- Name: Ingress Node Firewall Operator in OpenShift Container Platform
13491349
File: ingress-node-firewall-operator
13501350
Distros: openshift-enterprise,openshift-origin
1351-
# - Name: SR-IOV Operator
1352-
# Dir: sr-iov-operator
1353-
# Distros: openshift-enterprise,openshift-origin
1354-
# Topics:
1355-
# - Name: Installing the SR-IOV Operator
1356-
# File: installing-sriov-operator
1357-
# - Name: Configuring the SR-IOV Operator
1358-
# File: configuring-sriov-operator
1359-
# - Name: Uninstalling the SR-IOV Operator
1360-
# File: uninstalling-sriov-operator
1351+
- Name: SR-IOV Operator
1352+
Dir: sr-iov-operator
1353+
Distros: openshift-enterprise,openshift-origin
1354+
Topics:
1355+
- Name: Installing the SR-IOV Operator
1356+
File: installing-sriov-operator
1357+
- Name: Configuring the SR-IOV Operator
1358+
File: configuring-sriov-operator
1359+
- Name: Uninstalling the SR-IOV Operator
1360+
File: uninstalling-sriov-operator
13611361
- Name: Network security
13621362
Dir: network_security
13631363
Distros: openshift-enterprise,openshift-origin
@@ -1477,10 +1477,6 @@ Topics:
14771477
Topics:
14781478
- Name: About Single Root I/O Virtualization (SR-IOV) hardware networks
14791479
File: about-sriov
1480-
- Name: Installing the SR-IOV Operator
1481-
File: installing-sriov-operator
1482-
- Name: Configuring the SR-IOV Operator
1483-
File: configuring-sriov-operator
14841480
- Name: Configuring an SR-IOV network device
14851481
File: configuring-sriov-device
14861482
- Name: Configuring an SR-IOV Ethernet network attachment
@@ -1503,8 +1499,6 @@ Topics:
15031499
File: configuring-hardware-offloading
15041500
- Name: Switching Bluefield-2 from NIC to DPU mode
15051501
File: switching-bf2-nic-dpu
1506-
- Name: Uninstalling the SR-IOV Operator
1507-
File: uninstalling-sriov-operator
15081502
- Name: OVN-Kubernetes network plugin
15091503
Dir: ovn_kubernetes_network_provider
15101504
Topics:

_topic_maps/_topic_map_osd.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -823,9 +823,9 @@ Topics:
823823
Dir: networking_operators
824824
Distros: openshift-dedicated
825825
Topics:
826-
- Name: Understanding the DNS Operator
826+
- Name: DNS Operator in OpenShift Dedicated
827827
File: dns-operator
828-
- Name: Understanding the Ingress Operator
828+
- Name: Ingress Operator in OpenShift Dedicated
829829
File: ingress-operator
830830
- Name: Network verification
831831
File: network-verification

_topic_maps/_topic_map_rosa.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1087,11 +1087,11 @@ Topics:
10871087
Topics:
10881088
- Name: AWS Load Balancer Operator
10891089
File: aws-load-balancer-operator
1090-
- Name: Understanding the DNS Operator
1090+
- Name: DNS Operator in Red Hat OpenShift Service on AWS
10911091
File: dns-operator
1092-
- Name: Understanding the Ingress Operator
1092+
- Name: Ingress Operator in Red Hat OpenShift Service on AWS
10931093
File: ingress-operator
1094-
- Name: Understanding the Ingress Node Firewall Operator
1094+
- Name: Ingress Node Firewall Operator in Red Hat OpenShift Service on AWS
10951095
File: ingress-node-firewall-operator
10961096
- Name: Network verification
10971097
File: network-verification

architecture/admission-plug-ins.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ endif::openshift-rosa,openshift-dedicated[]
2828
== Additional resources
2929

3030
ifndef::openshift-rosa,openshift-dedicated[]
31-
* xref:../networking/hardware_networks/configuring-sriov-operator.adoc#configuring-sriov-operator[Configuring the SR-IOV Network Operator]
31+
* xref:../networking/networking_operators/sr-iov-operator/configuring-sriov-operator.adoc#configuring-sriov-operator_configuring-sriov-operator[Configuring the SR-IOV Network Operator]
3232

3333
* xref:../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations_dedicating_nodes-scheduler-taints-tolerations[Controlling pod placement using node taints]
3434
endif::openshift-rosa,openshift-dedicated[]

hosted_control_planes/hcp-getting-started.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ You can view the procedures by selecting from one of the following providers:
4646

4747
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosting-cluster-aws-infra-reqs[AWS infrastructure requirements]: Review the infrastructure requirements to create a hosted cluster on {aws-short}.
4848
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hosting-service-cluster-configure-aws[Configuring hosted control plane clusters on AWS]: The tasks to configure hosted control plane clusters on {aws-short} include creating the {aws-short} S3 OIDC secret, creating a routable public zone, enabling external DNS, enabling {aws-short} PrivateLink, and deploying a hosted cluster.
49-
* xref:../networking/hardware_networks/configuring-sriov-operator.adoc#sriov-operator-hosted-control-planes_configuring-sriov-operator[Deploying the SR-IOV Operator for {hcp}]: After you configure and deploy your hosting service cluster, you can create a subscription to the Single Root I/O Virtualization (SR-IOV) Operator on a hosted cluster. The SR-IOV pod runs on worker machines rather than the control plane.
49+
* 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}]: After you configure and deploy your hosting service cluster, you can create a subscription to the Single Root I/O Virtualization (SR-IOV) Operator on a hosted cluster. The SR-IOV pod runs on worker machines rather than the control plane.
5050

5151
* To destroy a hosted cluster on AWS, follow the instructions in link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#hypershift-cluster-destroy-aws[Destroying a hosted cluster on AWS].
5252
* If you want to disable the hosted control plane feature, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#disable-hosted-control-planes[Disabling the hosted control plane feature].

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ After you perform preinstallation tasks, install your cluster by following the m
3939
* For either type of deployment:
4040
** 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].
4141
* To complete SR-IOV configuration after you deploy your cluster:
42-
** xref:../../networking/hardware_networks/installing-sriov-operator.adoc#installing-sr-iov-operator_installing-sriov-operator[Install the SR-IOV Operator].
42+
** xref:../../networking/networking_operators/sr-iov-operator/installing-sriov-operator.adoc#installing-sr-iov-operator_installing-sriov-operator[Install the SR-IOV Operator].
4343
** xref:../../networking/hardware_networks/configuring-sriov-device.adoc#nw-sriov-networknodepolicy-object_configuring-sriov-device[Configure your SR-IOV network device].
4444
** xref:../../machine_management/creating_machinesets/creating-machineset-osp.adoc#machineset-yaml-osp-sr-iov_creating-machineset-osp[Create SR-IOV compute machines].
4545
* Consult the following references after you deploy your cluster to improve its performance:

modules/nw-ne-openshift-ingress.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
[id="nw-ne-openshift-ingress_{context}"]
66
= {product-title} Ingress Operator
7-
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.
7+
8+
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.
89

910
ifndef::openshift-rosa,openshift-dedicated[]
1011
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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
//
33
// * networking/hardware_networks/configuring-sriov-device.adoc
44

5+
:_mod-docs-content-type: REFERENCE
56
[id="nw-sriov-nic-partitioning_{context}"]
67
= Virtual function (VF) partitioning for SR-IOV devices
78

networking/hardware_networks/about-sriov.adoc

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ toc::[]
88

99
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.
1010

11+
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].
12+
1113
SR-IOV can segment a compliant network device, recognized on the host node as a physical function (PF), into multiple virtual functions (VFs).
1214
The VF is used like any other network device.
1315
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:
3335
$ oc label node <node_name> feature.node.kubernetes.io/network-sriov.capable="true"
3436
----
3537

38+
[discrete]
39+
[role="_additional-resources"]
40+
[id="additional-resources-about-sr-iov_{context}"]
41+
== Additional resources
42+
43+
* xref:../../networking/networking_operators/sr-iov-operator/installing-sriov-operator.adoc#installing-sriov-operator[Installing the SR-IOV Network Operator]
44+
3645
[id="components-sr-iov-network-devices"]
3746
== Components that manage SR-IOV network devices
3847

39-
The SR-IOV Network Operator creates and manages the components of the SR-IOV stack.
40-
It performs the following functions:
48+
The SR-IOV Network Operator creates and manages the components of the SR-IOV stack. The Operator performs the following functions:
4149

4250
- Orchestrates discovery and management of SR-IOV network devices
4351
- 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]
8795
[id="about-sriov-next-steps"]
8896
== Next steps
8997

90-
* xref:../../networking/hardware_networks/installing-sriov-operator.adoc#installing-sriov-operator[Installing the SR-IOV Network Operator]
91-
* Optional: xref:../../networking/hardware_networks/configuring-sriov-operator.adoc#configuring-sriov-operator[Configuring the SR-IOV Network Operator]
98+
* Optional: xref:../../networking/networking_operators/sr-iov-operator/configuring-sriov-operator.adoc#configuring-sriov-operator[Configuring the SR-IOV Network Operator]
9299
* xref:../../networking/hardware_networks/configuring-sriov-device.adoc#configuring-sriov-device[Configuring an SR-IOV network device]
93100
* 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]
94101
* 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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ toc::[]
88

99
You can add a pod to an existing Single Root I/O Virtualization (SR-IOV) network.
1010

11+
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].
12+
1113
include::modules/nw-sriov-runtime-config.adoc[leveloffset=+1]
1214

1315
include::modules/nw-multus-add-pod.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)