1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

OSDOCS-16848:NOP-7

This commit is contained in:
JoeAldinger
2026-01-29 16:19:28 -05:00
committed by openshift-cherrypick-robot
parent a53aa84d40
commit a4857b1cd2
7 changed files with 28 additions and 22 deletions

View File

@@ -5,14 +5,15 @@
[id="nw-cluster-network-operator_{context}"] [id="nw-cluster-network-operator_{context}"]
= Cluster Network Operator = Cluster Network Operator
[role="_abstract"]
The Cluster Network Operator implements the `network` API from the `operator.openshift.io` API group. 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. 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 The Cluster Network Operator is deployed during installation as a Kubernetes
`Deployment`. `Deployment`.
.Procedure
. Run the following command to view the Deployment status: . Run the following command to view the Deployment status:
+ +
[source,terminal] [source,terminal]

View File

@@ -6,20 +6,19 @@
[id="nw-cno-enable-ip-forwarding_{context}"] [id="nw-cno-enable-ip-forwarding_{context}"]
= Enabling IP forwarding globally = 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. [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.
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:
.Procedure .Procedure
. Backup the existing network configuration by running the following command: . Backup the existing network configuration by running the following command:
+ +
[source,terminal] [source,terminal]
---- ----
$ oc get network.operator cluster -o yaml > network-config-backup.yaml $ 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] [source,terminal]
---- ----
@@ -44,7 +43,7 @@ spec:
ipForwarding: Global 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: . 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] [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.
==== ====

View File

@@ -6,6 +6,7 @@
[id="nw-cno-logs_{context}"] [id="nw-cno-logs_{context}"]
= Viewing Cluster Network Operator logs = Viewing Cluster Network Operator logs
[role="_abstract"]
You can view Cluster Network Operator logs by using the `oc logs` command. You can view Cluster Network Operator logs by using the `oc logs` command.
.Procedure .Procedure

View File

@@ -6,8 +6,8 @@
[id="nw-cno-status_{context}"] [id="nw-cno-status_{context}"]
= Viewing Cluster Network Operator status = Viewing Cluster Network Operator status
You can inspect the status and view the details of the Cluster Network Operator [role="_abstract"]
using the `oc describe` command. You can inspect the status and view the details of the Cluster Network Operator by using the `oc describe` command.
.Procedure .Procedure

View File

@@ -6,8 +6,8 @@
[id="nw-cno-view_{context}"] [id="nw-cno-view_{context}"]
= Viewing the cluster network configuration = Viewing the cluster network configuration
Every new {product-title} installation has a `network.config` object named [role="_abstract"]
`cluster`. You can view your {product-title} cluster network configuration by using the `oc describe` command for the `network.config/cluster` resource.
.Procedure .Procedure
@@ -32,7 +32,7 @@ Metadata:
Generation: 3 Generation: 3
Resource Version: 29821 Resource Version: 29821
UID: 808dd2be-5077-4ff7-b6bb-21b7110126c7 UID: 808dd2be-5077-4ff7-b6bb-21b7110126c7
Spec: <1> Spec:
Cluster Network: Cluster Network:
Cidr: 10.128.0.0/14 Cidr: 10.128.0.0/14
Host Prefix: 23 Host Prefix: 23
@@ -45,7 +45,7 @@ Spec: <1>
Network Type: OVNKubernetes Network Type: OVNKubernetes
Service Network: Service Network:
172.30.0.0/16 172.30.0.0/16
Status: <2> Status
Cluster Network: Cluster Network:
Cidr: 10.128.0.0/14 Cidr: 10.128.0.0/14
Host Prefix: 23 Host Prefix: 23
@@ -62,9 +62,11 @@ Status: <2>
172.30.0.0/16 172.30.0.0/16
Events: <none> Events: <none>
---- ----
<1> The `Spec` field displays the configured state of the cluster network. +
<2> The `Status` field displays the current state of the cluster network where:
configuration.
`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: * Use the `oc describe` command to view the cluster network configuration:

View File

@@ -34,7 +34,8 @@ endif::[]
[id="nw-operator-cr_{context}"] [id="nw-operator-cr_{context}"]
= Cluster Network Operator configuration = 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: 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}"] [id="nw-operator-cr-defaultnetwork_{context}"]
=== defaultNetwork object configuration == defaultNetwork object configuration
The values for the `defaultNetwork` object are defined in the following table: 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}"] [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: The following table describes the configuration fields for the OVN-Kubernetes network plugin:

View File

@@ -6,6 +6,9 @@ include::_attributes/common-attributes.adoc[]
toc::[] 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::snippets/cluster-network-operator-abstract.adoc[]
include::modules/nw-cluster-network-operator.adoc[leveloffset=+1] include::modules/nw-cluster-network-operator.adoc[leveloffset=+1]