From a4857b1cd2903558392fb85f7c9ab8862af67aa2 Mon Sep 17 00:00:00 2001 From: JoeAldinger Date: Thu, 29 Jan 2026 16:19:28 -0500 Subject: [PATCH] OSDOCS-16848:NOP-7 --- modules/nw-cluster-network-operator.adoc | 5 +++-- modules/nw-cno-enable-ip-forwarding.adoc | 14 ++++++-------- modules/nw-cno-logs.adoc | 1 + modules/nw-cno-status.adoc | 4 ++-- modules/nw-cno-view.adoc | 16 +++++++++------- modules/nw-operator-cr.adoc | 7 ++++--- .../cluster-network-operator.adoc | 3 +++ 7 files changed, 28 insertions(+), 22 deletions(-) diff --git a/modules/nw-cluster-network-operator.adoc b/modules/nw-cluster-network-operator.adoc index aa765458bd..d10988c552 100644 --- a/modules/nw-cluster-network-operator.adoc +++ b/modules/nw-cluster-network-operator.adoc @@ -5,14 +5,15 @@ [id="nw-cluster-network-operator_{context}"] = Cluster Network Operator +[role="_abstract"] The Cluster Network Operator implements the `network` API from the `operator.openshift.io` API group. The Operator deploys the OVN-Kubernetes network plugin, or the network provider plugin that you selected during cluster installation, by using a daemon set. -.Procedure - The Cluster Network Operator is deployed during installation as a Kubernetes `Deployment`. +.Procedure + . Run the following command to view the Deployment status: + [source,terminal] diff --git a/modules/nw-cno-enable-ip-forwarding.adoc b/modules/nw-cno-enable-ip-forwarding.adoc index be2a1432e0..b933d92208 100644 --- a/modules/nw-cno-enable-ip-forwarding.adoc +++ b/modules/nw-cno-enable-ip-forwarding.adoc @@ -6,20 +6,19 @@ [id="nw-cno-enable-ip-forwarding_{context}"] = Enabling IP forwarding globally -From {product-title} 4.14 onward, global IP address forwarding is disabled on OVN-Kubernetes based cluster deployments to prevent undesirable effects for cluster administrators with nodes acting as routers. However, in some cases where an administrator expects traffic to be forwarded a new configuration parameter `ipForwarding` is available to allow forwarding of all IP traffic. - -To re-enable IP forwarding for all traffic on OVN-Kubernetes managed interfaces set the `gatewayConfig.ipForwarding` specification in the Cluster Network Operator to `Global` following this procedure: +[role="_abstract"] +From {product-title} 4.14 onward, OVN-Kubernetes disables global IP forwarding by default. By setting the Cluster Network Operator `gatewayConfig.ipForwarding` spec to `Global`, you can enable cluster-wide forwarding. .Procedure -. Backup the existing network configuration by running the following command: +. Backup the existing network configuration by running the following command: + [source,terminal] ---- $ oc get network.operator cluster -o yaml > network-config-backup.yaml ---- -. Run the following command to modify the existing network configuration: +. Run the following command to modify the existing network configuration: + [source,terminal] ---- @@ -44,7 +43,7 @@ spec: ipForwarding: Global ---- -.. Save and close the file. +.. Save and close the file. . After applying the changes, the OpenShift Cluster Network Operator (CNO) applies the update across the cluster. You can monitor the progress by using the following command: + @@ -65,6 +64,5 @@ $ oc patch network.operator cluster -p '{"spec":{"defaultNetwork":{"ovnKubernete + [NOTE] ==== -The other valid option for this parameter is `Restricted` in case you want to revert this change. `Restricted` is the default and with that setting global IP address forwarding is disabled. +The other valid option for this parameter is `Restricted` in case you want to revert this change. `Restricted` is the default and with that setting global IP address forwarding is disabled. ==== - diff --git a/modules/nw-cno-logs.adoc b/modules/nw-cno-logs.adoc index 41a67ba763..54d61182f1 100644 --- a/modules/nw-cno-logs.adoc +++ b/modules/nw-cno-logs.adoc @@ -6,6 +6,7 @@ [id="nw-cno-logs_{context}"] = Viewing Cluster Network Operator logs +[role="_abstract"] You can view Cluster Network Operator logs by using the `oc logs` command. .Procedure diff --git a/modules/nw-cno-status.adoc b/modules/nw-cno-status.adoc index 620df078d2..b37636acc2 100644 --- a/modules/nw-cno-status.adoc +++ b/modules/nw-cno-status.adoc @@ -6,8 +6,8 @@ [id="nw-cno-status_{context}"] = Viewing Cluster Network Operator status -You can inspect the status and view the details of the Cluster Network Operator -using the `oc describe` command. +[role="_abstract"] +You can inspect the status and view the details of the Cluster Network Operator by using the `oc describe` command. .Procedure diff --git a/modules/nw-cno-view.adoc b/modules/nw-cno-view.adoc index 57d5581bbc..90a818a982 100644 --- a/modules/nw-cno-view.adoc +++ b/modules/nw-cno-view.adoc @@ -6,8 +6,8 @@ [id="nw-cno-view_{context}"] = Viewing the cluster network configuration -Every new {product-title} installation has a `network.config` object named -`cluster`. +[role="_abstract"] +You can view your {product-title} cluster network configuration by using the `oc describe` command for the `network.config/cluster` resource. .Procedure @@ -32,7 +32,7 @@ Metadata: Generation: 3 Resource Version: 29821 UID: 808dd2be-5077-4ff7-b6bb-21b7110126c7 -Spec: <1> +Spec: Cluster Network: Cidr: 10.128.0.0/14 Host Prefix: 23 @@ -45,7 +45,7 @@ Spec: <1> Network Type: OVNKubernetes Service Network: 172.30.0.0/16 -Status: <2> +Status Cluster Network: Cidr: 10.128.0.0/14 Host Prefix: 23 @@ -62,9 +62,11 @@ Status: <2> 172.30.0.0/16 Events: ---- -<1> The `Spec` field displays the configured state of the cluster network. -<2> The `Status` field displays the current state of the cluster network -configuration. ++ +where: + +`spec`:: Specifies the field that displays the configured state of the cluster network. +`Status`:: Displays the current state of the cluster network configuration. //// * Use the `oc describe` command to view the cluster network configuration: diff --git a/modules/nw-operator-cr.adoc b/modules/nw-operator-cr.adoc index 10966cc6b6..8a377e89e7 100644 --- a/modules/nw-operator-cr.adoc +++ b/modules/nw-operator-cr.adoc @@ -34,7 +34,8 @@ endif::[] [id="nw-operator-cr_{context}"] = Cluster Network Operator configuration -The configuration for the cluster network is specified as part of the Cluster Network Operator (CNO) configuration and stored in a custom resource (CR) object that is named `cluster`. The CR specifies the fields for the `Network` API in the `operator.openshift.io` API group. +[role="_abstract"] +To manage cluster networking, configure the Cluster Network Operator (CNO) `Network` custom resource (CR) named `cluster` so the cluster uses the correct IP ranges and network plugin settings for reliable pod and service connectivity. Some settings and fields are inherited at the time of install or by the `default.Network.type` plugin, OVN-Kubernetes. The CNO configuration inherits the following fields during cluster installation from the `Network` API in the `Network.config.openshift.io` API group: @@ -131,7 +132,7 @@ For a cluster that needs to deploy objects across multiple networks, ensure that [id="nw-operator-cr-defaultnetwork_{context}"] -=== defaultNetwork object configuration +== defaultNetwork object configuration The values for the `defaultNetwork` object are defined in the following table: @@ -156,7 +157,7 @@ The values for the `defaultNetwork` object are defined in the following table: [id="nw-operator-configuration-parameters-for-ovn-sdn_{context}"] -==== Configuration for the OVN-Kubernetes network plugin +== Configuration for the OVN-Kubernetes network plugin The following table describes the configuration fields for the OVN-Kubernetes network plugin: diff --git a/networking/networking_operators/cluster-network-operator.adoc b/networking/networking_operators/cluster-network-operator.adoc index 6d585c096d..95c64f6453 100644 --- a/networking/networking_operators/cluster-network-operator.adoc +++ b/networking/networking_operators/cluster-network-operator.adoc @@ -6,6 +6,9 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] +With the Cluster Network Operator, you can manage networking in {product-title}, including how to view status, enable IP forwarding, and collect logs. + include::snippets/cluster-network-operator-abstract.adoc[] include::modules/nw-cluster-network-operator.adoc[leveloffset=+1]