Skip to content

Commit 7505368

Browse files
authored
Merge pull request #85085 from dfitzmau/OSDOCS-12303-phase3
OSDOCS-12303-phase3: Restructure the Networking docs for Operators
2 parents 23de851 + ab71176 commit 7505368

File tree

48 files changed

+120
-124
lines changed

Some content is hidden

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

48 files changed

+120
-124
lines changed

_topic_maps/_topic_map.yml

Lines changed: 22 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1396,14 +1396,28 @@ Topics:
13961396
File: nw-creating-dns-records-on-infoblox
13971397
- Name: Configuring the cluster-wide proxy on the External DNS Operator
13981398
File: nw-configuring-cluster-wide-egress-proxy
1399-
# - Name: Understanding the Ingress Node Firewall Operator
1400-
# File: ingress-node-firewall-operator
1401-
# - Name: Understanding the Cluster Network Operator
1402-
# File: cluster-network-operator
1403-
# - Name: Understanding the DNS Operator
1404-
# File: dns-operator
1405-
# - Name: Understanding the Ingress Operator
1406-
# File: ingress-operator
1399+
- Name: MetalLB Operator
1400+
Dir: metallb-operator
1401+
Distros: openshift-enterprise,openshift-origin
1402+
Topics:
1403+
- Name: About MetalLB and the MetalLB Operator
1404+
File: about-metallb
1405+
- Name: Installing the MetalLB Operator
1406+
File: metallb-operator-install
1407+
- Name: Upgrading the MetalLB Operator
1408+
File: metallb-upgrading-operator
1409+
- Name: Understanding the Cluster Network Operator
1410+
File: cluster-network-operator
1411+
Distros: openshift-enterprise,openshift-origin
1412+
- Name: Understanding the DNS Operator
1413+
File: dns-operator
1414+
Distros: openshift-enterprise,openshift-origin
1415+
- Name: Understanding the Ingress Operator
1416+
File: ingress-operator
1417+
Distros: openshift-enterprise,openshift-origin
1418+
- Name: Understanding the Ingress Node Firewall Operator
1419+
File: ingress-node-firewall-operator
1420+
Distros: openshift-enterprise,openshift-origin
14071421
# - Name: SR-IOV Operator
14081422
# Dir: sr-iov-operator
14091423
# Distros: openshift-enterprise,openshift-origin
@@ -1414,16 +1428,6 @@ Topics:
14141428
# File: configuring-sriov-operator
14151429
# - Name: Uninstalling the SR-IOV Operator
14161430
# File: uninstalling-sriov-operator
1417-
# - Name: MetalLB Operator
1418-
# Dir: metallb-operator
1419-
# Distros: openshift-enterprise,openshift-origin
1420-
# Topics:
1421-
# - Name: About MetalLB and the MetalLB Operator
1422-
# File: about-metallb
1423-
# - Name: Installing the MetalLB Operator
1424-
# File: metallb-operator-install
1425-
# - Name: Upgrading the MetalLB Operator
1426-
# File: metallb-upgrading-operator
14271431
- Name: Network security
14281432
Dir: network_security
14291433
Distros: openshift-enterprise,openshift-origin
@@ -1466,8 +1470,6 @@ Topics:
14661470
File: multitenant-network-policy
14671471
- Name: Audit logging for network security
14681472
File: logging-network-security
1469-
- Name: Understanding the Ingress Node Firewall Operator
1470-
File: ingress-node-firewall-operator
14711473
- Name: Egress Firewall
14721474
Dir: egress_firewall
14731475
Distros: openshift-enterprise,openshift-origin
@@ -1482,15 +1484,6 @@ Topics:
14821484
File: configuring-egress-firewall-ovn
14831485
- Name: Configuring IPsec encryption
14841486
File: configuring-ipsec-ovn
1485-
- Name: Understanding the Cluster Network Operator
1486-
File: cluster-network-operator
1487-
Distros: openshift-enterprise,openshift-origin
1488-
- Name: Understanding the DNS Operator
1489-
File: dns-operator
1490-
Distros: openshift-enterprise,openshift-origin
1491-
- Name: Understanding the Ingress Operator
1492-
File: ingress-operator
1493-
Distros: openshift-enterprise,openshift-origin
14941487
- Name: Configuring the Ingress Controller for manual DNS management
14951488
File: ingress-controller-dnsmgt
14961489
Distros: openshift-enterprise,openshift-origin
@@ -1674,12 +1667,6 @@ Topics:
16741667
- Name: Load balancing with MetalLB
16751668
Dir: metallb
16761669
Topics:
1677-
- Name: About MetalLB and the MetalLB Operator
1678-
File: about-metallb
1679-
- Name: Installing the MetalLB Operator
1680-
File: metallb-operator-install
1681-
- Name: Upgrading the MetalLB Operator
1682-
File: metallb-upgrading-operator
16831670
- Name: Configuring MetalLB address pools
16841671
File: metallb-configure-address-pools
16851672
- Name: Advertising the IP address pools

_topic_maps/_topic_map_osd.yml

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -823,18 +823,14 @@ Distros: openshift-dedicated
823823
Topics:
824824
- Name: About networking
825825
File: about-managed-networking
826-
# - Name: Networking Operators
827-
# Dir: networking_operators
828-
# Distros: openshift-dedicated
829-
# Topics:
830-
# - Name: Understanding the DNS Operator
831-
# File: dns-operator
832-
# - Name: Understanding the Ingress Operator
833-
# File: ingress-operator
834-
- Name: Understanding the DNS Operator
835-
File: dns-operator
836-
- Name: Understanding the Ingress Operator
837-
File: ingress-operator
826+
- Name: Networking Operators
827+
Dir: networking_operators
828+
Distros: openshift-dedicated
829+
Topics:
830+
- Name: Understanding the DNS Operator
831+
File: dns-operator
832+
- Name: Understanding the Ingress Operator
833+
File: ingress-operator
838834
- Name: Network verification
839835
File: network-verification
840836
- Name: Configuring a cluster-wide proxy during installation

_topic_maps/_topic_map_rosa.yml

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1088,16 +1088,12 @@ Topics:
10881088
Topics:
10891089
- Name: AWS Load Balancer Operator
10901090
File: aws-load-balancer-operator
1091-
# - Name: Understanding the DNS Operator
1092-
# File: dns-operator
1093-
# - Name: Understanding the Ingress Operator
1094-
# File: ingress-operator
1095-
# - Name: Understanding the Ingress Node Firewall Operator
1096-
# File: ingress-node-firewall-operator
1097-
- Name: Understanding the DNS Operator
1098-
File: dns-operator
1099-
- Name: Understanding the Ingress Operator
1100-
File: ingress-operator
1091+
- Name: Understanding the DNS Operator
1092+
File: dns-operator
1093+
- Name: Understanding the Ingress Operator
1094+
File: ingress-operator
1095+
- Name: Understanding the Ingress Node Firewall Operator
1096+
File: ingress-node-firewall-operator
11011097
- Name: Network verification
11021098
File: network-verification
11031099
- Name: Configuring a cluster-wide proxy during installation
@@ -1136,8 +1132,6 @@ Topics:
11361132
File: default-network-policy
11371133
- Name: Configuring multitenant isolation with network policy
11381134
File: multitenant-network-policy
1139-
- Name: Understanding the Ingress Node Firewall Operator
1140-
File: ingress-node-firewall-operator
11411135
- Name: OVN-Kubernetes network plugin
11421136
Dir: ovn_kubernetes_network_provider
11431137
Topics:

_unused_topics/migrate-from-openshift-sdn.adoc

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,35 @@ include::modules/live-migration-metrics-information.adoc[leveloffset=+3]
3030
== Additional resources
3131

3232
* link:https://access.redhat.com/labs/ocpnc/[Red Hat OpenShift Network Calculator]
33-
* xref:../../networking/cluster-network-operator.adoc#nw-operator-configuration-parameters-for-ovn-sdn_cluster-network-operator[Configuration parameters for the OVN-Kubernetes network plugin]
33+
34+
* xref:../networking/networking_operators/cluster-network-operator.adoc#nw-operator-cr_cluster-network-operator[Configuration for the OVN-Kubernetes network plugin]
35+
3436
* xref:../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[Backing up etcd]
37+
3538
* xref:../../networking/network_security/network_policy/about-network-policy.adoc#about-network-policy[About network policy]
39+
3640
* xref:../../networking/changing-cluster-network-mtu.adoc#nw-cluster-mtu-change_changing-cluster-network-mtu[Changing the cluster MTU]
41+
3742
* xref:../../networking/changing-cluster-network-mtu.adoc#mtu-value-selection_changing-cluster-network-mtu[MTU value selection]
43+
3844
* xref:../../networking/network_security/network_policy/about-network-policy.adoc#nw-networkpolicy-optimize-ovn_about-network-policy[About network policy]
3945
* OVN-Kubernetes capabilities
46+
4047
- xref:../../networking/ovn_kubernetes_network_provider/configuring-egress-ips-ovn.adoc#configuring-egress-ips-ovn[Configuring an egress IP address]
48+
4149
- xref:../../networking/network_security/egress_firewall/configuring-egress-firewall-ovn.adoc#configuring-egress-firewall-ovn[Configuring an egress firewall for a project]
50+
4251
- link:https://access.redhat.com/solutions/7078619[OVN-Kubernetes egress firewall blocks process to deploy application as DeploymentConfig]
52+
4353
- xref:../../networking/ovn_kubernetes_network_provider/enabling-multicast.adoc#nw-ovn-kubernetes-enabling-multicast[Enabling multicast for a project]
4454
* OpenShift SDN capabilities
55+
4556
- xref:../../networking/openshift_sdn/assigning-egress-ips.adoc#assigning-egress-ips[Configuring egress IPs for a project]
57+
4658
- xref:../../networking/openshift_sdn/configuring-egress-firewall.adoc#configuring-egress-firewall[Configuring an egress firewall for a project]
59+
4760
- xref:../../networking/openshift_sdn/enabling-multicast.adoc#enabling-multicast[Enabling multicast for a project]
61+
4862
- xref:../../networking/openshift_sdn/deploying-egress-router-layer3-redirection.adoc#deploying-egress-router-layer3-redirection[Deploying an egress router pod in redirect mode]
49-
* xref:../../rest_api/operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[Network [operator.openshift.io/v1]]
63+
64+
* xref:../../rest_api/operator_apis/network-operator-openshift-io-v1.adoc#network-operator-openshift-io-v1[Network [operator.openshift.io/v1]

cli_reference/rosa_cli/rosa-manage-objects-cli.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ include::modules/rosa-edit-objects.adoc[leveloffset=+1]
2929

3030
[role="_additional-resources_1"]
3131
== Additional resources
32-
* See xref:../../networking/ingress-operator.adoc#configuring-ingress-controller[Configuring the Ingress Controller] for information regarding editing non-default application routers.
32+
* See xref:../../networking/networking_operators/ingress-operator.adoc#configuring-ingress-controller[Configuring the Ingress Controller] for information regarding editing non-default application routers.
3333

3434
include::modules/rosa-delete-objects.adoc[leveloffset=+1]
3535
include::modules/rosa-install-uninstall-addon.adoc[leveloffset=+1]

getting_started/openshift-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ of the {product-title} {product-version} control plane. See how {product-title}
9090
* **xref:../authentication/understanding-authentication.adoc#understanding-authentication[Manage authentication]**: Learn how user, group, and API authentication
9191
works in {product-title}. {product-title} supports multiple identity providers.
9292

93-
* **xref:../networking/understanding-networking.adoc#understanding-networking[Manage networking]**: The cluster network in {product-title} is managed by the xref:../networking/cluster-network-operator.adoc#cluster-network-operator[Cluster Network Operator] (CNO). The Multus Container Network Interface adds the capability to attach xref:../networking/multiple_networks/understanding-multiple-networks.adoc#understanding-multiple-networks[multiple network interfaces] to a pod. Using
93+
* **xref:../networking/understanding-networking.adoc#understanding-networking[Manage networking]**: The cluster network in {product-title} is managed by the xref:../networking/networking_operators/cluster-network-operator.adoc#nw-cluster-network-operator_cluster-network-operator[Cluster Network Operator] (CNO). The Multus Container Network Interface adds the capability to attach xref:../networking/multiple_networks/understanding-multiple-networks.adoc#understanding-multiple-networks[multiple network interfaces] to a pod. Using
9494
xref:../networking/network_security/network_policy/about-network-policy.adoc#about-network-policy[network policy] features, you can isolate your pods or permit selected traffic.
9595

9696
* **xref:../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Manage storage]**: {product-title} allows cluster administrators to configure persistent storage.

hosted_control_planes/hcp-deploy/hcp-deploy-virt.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ include::modules/hcp-metallb.adoc[leveloffset=+1]
7777
[role="_additional-resources"]
7878
.Additional resources
7979

80-
* For more information about MetalLB, see xref:../../networking/metallb/metallb-operator-install.adoc#metallb-operator-install[Installing the MetalLB Operator].
80+
* For more information about MetalLB, see xref:../../networking/networking_operators/metallb-operator/metallb-operator-install.adoc#metallb-operator-install_metallb-operator-install[Installing the MetalLB Operator].
8181

8282
[id="hcp-virt-addl-resources"]
8383
== Configuring additional networks, guaranteed CPUs, and VM scheduling for node pools

hosted_control_planes/hcp-manage/hcp-manage-bm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ include::modules/hcp-bm-ingress.adoc[leveloffset=+1]
2424
[role="_additional-resources"]
2525
.Additional resources
2626

27-
* xref:../../networking/metallb/about-metallb.adoc#about-metallb[About MetalLB and the MetalLB Operator]
27+
* xref:../../networking/networking_operators/metallb-operator/about-metallb.adoc#about-metallb_about-metallb[About MetalLB and the MetalLB Operator]
2828
2929
include::modules/hcp-bm-machine-health.adoc[leveloffset=+1]
3030
include::modules/hcp-bm-machine-health-disable.adoc[leveloffset=+1]

hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ include::modules/hcp-bm-ingress.adoc[leveloffset=+1]
2424
[role="_additional-resources"]
2525
.Additional resources
2626

27-
* xref:../../networking/metallb/about-metallb.adoc#about-metallb[About MetalLB and the MetalLB Operator]
27+
* xref:../../networking/networking_operators/metallb-operator/about-metallb.adoc#about-metallb_about-metallb[About MetalLB and the MetalLB Operator]
2828
2929
include::modules/hcp-bm-machine-health.adoc[leveloffset=+1]
3030
include::modules/hcp-bm-machine-health-disable.adoc[leveloffset=+1]

installing/installing_bare_metal/ipi/ipi-install-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ For installer-provisioned infrastructure installations, CoreDNS exposes port 53
3737
[role="_additional-resources"]
3838
.Additional resources
3939

40-
* xref:../../../networking/dns-operator.adoc#nw-dns-forward_dns-operator[Using DNS forwarding]
40+
* xref:../../../networking/networking_operators/dns-operator.adoc#nw-dns-forward_dns-operator[Using DNS forwarding]
4141
4242
[IMPORTANT]
4343
====

0 commit comments

Comments
 (0)