Skip to content

Commit b6e00ad

Browse files
committed
OSDOCS-12303-phase3: Restructure the Networking docs for Operators
1 parent f12188a commit b6e00ad

File tree

45 files changed

+142
-145
lines changed

Some content is hidden

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

45 files changed

+142
-145
lines changed

_topic_maps/_topic_map.yml

Lines changed: 22 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1326,14 +1326,28 @@ Topics:
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
1329-
# - Name: Understanding the Ingress Node Firewall Operator
1330-
# File: ingress-node-firewall-operator
1331-
# - Name: Understanding the Cluster Network Operator
1332-
# File: cluster-network-operator
1333-
# - Name: Understanding the DNS Operator
1334-
# File: dns-operator
1335-
# - Name: Understanding the Ingress Operator
1336-
# File: ingress-operator
1329+
- Name: MetalLB Operator
1330+
Dir: metallb-operator
1331+
Distros: openshift-enterprise,openshift-origin
1332+
Topics:
1333+
- Name: About MetalLB and the MetalLB Operator
1334+
File: about-metallb
1335+
- Name: Installing the MetalLB Operator
1336+
File: metallb-operator-install
1337+
- Name: Upgrading the MetalLB Operator
1338+
File: metallb-upgrading-operator
1339+
- Name: Understanding the Cluster Network Operator
1340+
File: cluster-network-operator
1341+
Distros: openshift-enterprise,openshift-origin
1342+
- Name: Understanding the DNS Operator
1343+
File: dns-operator
1344+
Distros: openshift-enterprise,openshift-origin
1345+
- Name: Understanding the Ingress Operator
1346+
File: ingress-operator
1347+
Distros: openshift-enterprise,openshift-origin
1348+
- Name: Understanding the Ingress Node Firewall Operator
1349+
File: ingress-node-firewall-operator
1350+
Distros: openshift-enterprise,openshift-origin
13371351
# - Name: SR-IOV Operator
13381352
# Dir: sr-iov-operator
13391353
# Distros: openshift-enterprise,openshift-origin
@@ -1344,16 +1358,6 @@ Topics:
13441358
# File: configuring-sriov-operator
13451359
# - Name: Uninstalling the SR-IOV Operator
13461360
# File: uninstalling-sriov-operator
1347-
# - Name: MetalLB Operator
1348-
# Dir: metallb-operator
1349-
# Distros: openshift-enterprise,openshift-origin
1350-
# Topics:
1351-
# - Name: About MetalLB and the MetalLB Operator
1352-
# File: about-metallb
1353-
# - Name: Installing the MetalLB Operator
1354-
# File: metallb-operator-install
1355-
# - Name: Upgrading the MetalLB Operator
1356-
# File: metallb-upgrading-operator
13571361
- Name: Network security
13581362
Dir: network_security
13591363
Distros: openshift-enterprise,openshift-origin
@@ -1396,8 +1400,6 @@ Topics:
13961400
File: multitenant-network-policy
13971401
- Name: Audit logging for network security
13981402
File: logging-network-security
1399-
- Name: Understanding the Ingress Node Firewall Operator
1400-
File: ingress-node-firewall-operator
14011403
- Name: Egress Firewall
14021404
Dir: egress_firewall
14031405
Distros: openshift-enterprise,openshift-origin
@@ -1412,15 +1414,6 @@ Topics:
14121414
File: configuring-egress-firewall-ovn
14131415
- Name: Configuring IPsec encryption
14141416
File: configuring-ipsec-ovn
1415-
- Name: Understanding the Cluster Network Operator
1416-
File: cluster-network-operator
1417-
Distros: openshift-enterprise,openshift-origin
1418-
- Name: Understanding the DNS Operator
1419-
File: dns-operator
1420-
Distros: openshift-enterprise,openshift-origin
1421-
- Name: Understanding the Ingress Operator
1422-
File: ingress-operator
1423-
Distros: openshift-enterprise,openshift-origin
14241417
- Name: Configuring the Ingress Controller for manual DNS management
14251418
File: ingress-controller-dnsmgt
14261419
Distros: openshift-enterprise,openshift-origin
@@ -1644,12 +1637,6 @@ Topics:
16441637
- Name: Load balancing with MetalLB
16451638
Dir: metallb
16461639
Topics:
1647-
- Name: About MetalLB and the MetalLB Operator
1648-
File: about-metallb
1649-
- Name: Installing the MetalLB Operator
1650-
File: metallb-operator-install
1651-
- Name: Upgrading the MetalLB Operator
1652-
File: metallb-upgrading-operator
16531640
- Name: Configuring MetalLB address pools
16541641
File: metallb-configure-address-pools
16551642
- Name: Advertising the IP address pools

_topic_maps/_topic_map_osd.yml

Lines changed: 17 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -816,33 +816,14 @@ Distros: openshift-dedicated
816816
Topics:
817817
- Name: About networking
818818
File: about-managed-networking
819-
# - Name: Networking Operators
820-
# Dir: networking_operators
821-
# Distros: openshift-dedicated
822-
# Topics:
823-
# - Name: Understanding the DNS Operator
824-
# File: dns-operator
825-
# - Name: Understanding the Ingress Operator
826-
# File: ingress-operator
827-
- Name: Understanding the DNS Operator
828-
File: dns-operator
829-
- Name: Understanding the Ingress Operator
830-
File: ingress-operator
831-
- Name: OpenShift OVN default CNI network provider
832-
Dir: ovn_kubernetes_network_provider
819+
- Name: Networking Operators
820+
Dir: networking_operators
821+
Distros: openshift-dedicated
833822
Topics:
834-
- Name: About the OpenShift OVN network plugin
835-
File: about-ovn-kubernetes
836-
# TODO OSDOCS-11397: The next file was not present in OSD initially, need to verify if it applies
837-
# - Name: Configuring an egress IP address
838-
# File: configuring-egress-ips-ovn
839-
- Name: Enabling multicast for a project
840-
File: enabling-multicast
841-
# - Name: OpenShift SDN default CNI network provider
842-
# Dir: openshift_sdn
843-
# Topics:
844-
# - Name: Enabling multicast for a project
845-
# File: enabling-multicast
823+
- Name: Understanding the DNS Operator
824+
File: dns-operator
825+
- Name: Understanding the Ingress Operator
826+
File: ingress-operator
846827
- Name: Network verification
847828
File: network-verification
848829
- Name: Configuring a cluster-wide proxy during installation
@@ -869,6 +850,16 @@ Topics:
869850
File: deleting-network-policy
870851
- Name: Configuring multitenant isolation with network policy
871852
File: multitenant-network-policy
853+
- Name: OVN-Kubernetes network plugin
854+
Dir: ovn_kubernetes_network_provider
855+
Topics:
856+
- Name: About the OVN-Kubernetes network plugin
857+
File: about-ovn-kubernetes
858+
- Name: OpenShift SDN network plugin
859+
Dir: ovn_kubernetes_network_provider
860+
Topics:
861+
- Name: Enabling multicast for a project
862+
File: enabling-multicast
872863
- Name: Configuring Routes
873864
Dir: routes
874865
Topics:

_topic_maps/_topic_map_rosa.yml

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1084,25 +1084,12 @@ Topics:
10841084
Topics:
10851085
- Name: AWS Load Balancer Operator
10861086
File: aws-load-balancer-operator
1087-
# - Name: Understanding the DNS Operator
1088-
# File: dns-operator
1089-
# - Name: Understanding the Ingress Operator
1090-
# File: ingress-operator
1091-
# - Name: Understanding the Ingress Node Firewall Operator
1092-
# File: ingress-node-firewall-operator
1093-
- Name: Understanding the DNS Operator
1094-
File: dns-operator
1095-
- Name: Understanding the Ingress Operator
1096-
File: ingress-operator
1097-
- Name: OpenShift OVN default CNI network provider
1098-
Dir: ovn_kubernetes_network_provider
1099-
Topics:
1100-
- Name: About the OpenShift OVN network plugin
1101-
File: about-ovn-kubernetes
1102-
- Name: Configuring an egress IP address
1103-
File: configuring-egress-ips-ovn
1104-
- Name: Enabling multicast for a project
1105-
File: enabling-multicast
1087+
- Name: Understanding the DNS Operator
1088+
File: dns-operator
1089+
- Name: Understanding the Ingress Operator
1090+
File: ingress-operator
1091+
- Name: Understanding the Ingress Node Firewall Operator
1092+
File: ingress-node-firewall-operator
11061093
- Name: Network verification
11071094
File: network-verification
11081095
- Name: Configuring a cluster-wide proxy during installation
@@ -1141,8 +1128,18 @@ Topics:
11411128
File: default-network-policy
11421129
- Name: Configuring multitenant isolation with network policy
11431130
File: multitenant-network-policy
1144-
- Name: Understanding the Ingress Node Firewall Operator
1145-
File: ingress-node-firewall-operator
1131+
- Name: OVN-Kubernetes network plugin
1132+
Dir: ovn_kubernetes_network_provider
1133+
Topics:
1134+
- Name: About the OVN-Kubernetes network plugin
1135+
File: about-ovn-kubernetes
1136+
- Name: Configuring an egress IP address
1137+
File: configuring-egress-ips-ovn
1138+
- Name: OpenShift SDN network plugin
1139+
Dir: ovn_kubernetes_network_provider
1140+
Topics:
1141+
- Name: Enabling multicast for a project
1142+
File: enabling-multicast
11461143
- Name: Configuring Routes
11471144
Dir: routes
11481145
Topics:

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ include::modules/rosa-create-objects.adoc[leveloffset=+1]
2626
* See xref:../../rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-aws-prereqs.adoc#rosa-security-groups_prerequisites[Additional custom security groups] for information about security group requirements.
2727

2828
include::modules/rosa-edit-objects.adoc[leveloffset=+1]
29+
30+
[role="_additional-resources_1"]
31+
== Additional resources
32+
* See xref:../../networking/networking_operators/ingress-operator.adoc#configuring-ingress-controller[Configuring the Ingress Controller] for information regarding editing non-default application routers.
33+
2934
include::modules/rosa-delete-objects.adoc[leveloffset=+1]
3035
include::modules/rosa-install-uninstall-addon.adoc[leveloffset=+1]
3136
include::modules/rosa-list-objects.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 CNO uses iptables rules in xref:../networking/openshift_sdn/configuring-kube-proxy.adoc#configuring-kube-proxy[kube-proxy] to direct traffic between nodes and pods running on those nodes. 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.

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
====

installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ include::modules/ipi-install-network-requirements.adoc[leveloffset=+1]
4444
[role="_additional-resources"]
4545
.Additional resources
4646

47-
* xref:../../networking/dns-operator.adoc#nw-dns-forward_dns-operator[Using DNS forwarding]
47+
* xref:../../networking/networking_operators/dns-operator.adoc#nw-dns-forward_dns-operator[Using DNS forwarding]
4848
4949
include::modules/ipi-install-configuring-nodes.adoc[leveloffset=+1]
5050

installing/installing_gcp/installing-gcp-user-infra.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,6 @@ include::modules/cluster-telemetry.adoc[leveloffset=+1]
148148

149149
== Next steps
150150

151-
* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
152-
* If necessary, you can xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
153-
* xref:../../networking/ingress-operator.adoc#nw-ingress-controller-configuration-gcp-global-access_configuring-ingress[Configure Global Access for an Ingress Controller on GCP].
151+
* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]
152+
* If necessary, you can xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]
153+
* xref:../../networking/networking_operators/ingress-operator.adoc#nw-ingress-controller-configuration-gcp-global-access_configuring-ingress[Configuring Global Access for an Ingress Controller on {gcp-short}]

networking/cidr-range-definitions.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ You can expand the range after cluster installation.
6565

6666
[role="_additional-resources"]
6767
.Additional resources
68-
* xref:../networking/cluster-network-operator.adoc#nw-operator-cr-cno-object_cluster-network-operator[Cluster Network Operator configuration]
68+
* xref:../networking/networking_operators/cluster-network-operator.adoc#nw-operator-cr_cluster-network-operator[Cluster Network Operator configuration]
6969
* xref:../networking/configuring-cluster-network-range.adoc#configuring-cluster-network-range[Configuring the cluster network range]
7070
endif::openshift-enterprise[]
7171

networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-ingress-controller.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ include::modules/nw-ingress-sharding-route-configuration.adoc[leveloffset=+2]
7979

8080
* xref:../../scalability_and_performance/optimization/routing-optimization.adoc#baseline-router-performance_routing-optimization[Baseline Ingress Controller (router) performance]
8181

82-
* xref:../../networking/ingress-operator.adoc#configuring-ingress[Ingress Operator in {product-title}]
82+
* xref:../../networking/networking_operators/ingress-operator.adoc#configuring-ingress-controller[Configuring the Ingress Controller]
8383

8484
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Installing a cluster on bare metal]
8585

0 commit comments

Comments
 (0)