Skip to content

Commit 3bfab5a

Browse files
authored
Merge pull request #69749 from kquinn1204/TELCODOCS-1678
TELCODOCS-1678 Adding note to clarify that the Kubernetes NMState Operator
2 parents ae8d3c7 + b67fb99 commit 3bfab5a

7 files changed

+21
-12
lines changed

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1515,9 +1515,7 @@ Topics:
15151515
Topics:
15161516
- Name: About the Kubernetes NMState Operator
15171517
File: k8s-nmstate-about-the-k8s-nmstate-operator
1518-
- Name: Observing node network state
1519-
File: k8s-nmstate-observing-node-network-state
1520-
- Name: Updating node network configuration
1518+
- Name: Observing and updating node network state and configuration
15211519
File: k8s-nmstate-updating-node-network-config
15221520
- Name: Troubleshooting node network configuration
15231521
File: k8s-nmstate-troubleshooting-node-network

modules/virt-about-nmstate.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,5 @@ Node networking is monitored and updated by the following objects:
2727
2828
[NOTE]
2929
====
30-
If your {product-title} cluster uses OVN-Kubernetes as the network plugin, you cannot make configuration changes to the `br-ex` bridge or its underlying interfaces. As a workaround, use a secondary network interface connected to your host or switch to the OpenShift SDN network plugin.
30+
You cannot make configuration changes to the `br-ex` bridge or its underlying interfaces. As a workaround, use a secondary network interface connected to your host or switch.
3131
====
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:_mod-docs-content-type: CONCEPT
22
[id="virt-node-network-config-console_{context}"]
33
= Managing policy from the web console
4-
You can manage the policy from the web console by accessing the list of created policies in *NodeNetworkConfigurationPolicy* page under *Networking* menu. This page enables you to create, update, monitor, and delete the policies.
5-
4+
You can update the node network configuration, such as adding or removing interfaces from nodes, by applying `NodeNetworkConfigurationPolicy` manifests to the cluster.
5+
Manage the policy from the web console by accessing the list of created policies in the *NodeNetworkConfigurationPolicy* page under the *Networking* menu. This page enables you to create, update, monitor, and delete the policies.

modules/virt-viewing-network-state-of-node.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="virt-viewing-network-state-of-node_{context}"]
77
= Viewing the network state of a node by using the CLI
88

9-
A `NodeNetworkState` object exists on every node in the cluster. This object is periodically updated and captures the state of the network for that node.
9+
Node network state is the network configuration for all nodes in the cluster. A `NodeNetworkState` object exists on every node in the cluster. This object is periodically updated and captures the state of the network for that node.
1010

1111
.Procedure
1212

networking/k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,19 @@ Red Hat supports the Kubernetes NMState Operator in production environments on b
1616

1717
Before you can use NMState with {product-title}, you must install the Kubernetes NMState Operator.
1818

19+
[NOTE]
20+
====
21+
The Kubernetes NMState Operator updates the network configuration of a secondary NIC. It cannot update the network configuration of the primary NIC or the `br-ex` bridge.
22+
====
23+
24+
{product-title} uses link:https://nmstate.github.io/[`nmstate`] to report on and configure the state of the node network. This makes it possible to modify the network policy configuration, such as by creating a Linux bridge on all nodes, by applying a single configuration manifest to the cluster.
25+
26+
Node networking is monitored and updated by the following objects:
27+
28+
`NodeNetworkState`:: Reports the state of the network on that node.
29+
`NodeNetworkConfigurationPolicy`:: Describes the requested network configuration on nodes. You update the node network configuration, including adding and removing interfaces, by applying a `NodeNetworkConfigurationPolicy` manifest to the cluster.
30+
`NodeNetworkConfigurationEnactment`:: Reports the network policies enacted upon each node.
31+
1932
[id="installing-the-kubernetes-nmstate-operator-cli"]
2033
== Installing the Kubernetes NMState Operator
2134

networking/k8s_nmstate/k8s-nmstate-observing-node-network-state.adoc

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

1010
Node network state is the network configuration for all nodes in the cluster.
1111

12-
include::modules/virt-about-nmstate.adoc[leveloffset=+1]
13-
1412
include::modules/virt-viewing-network-state-of-node.adoc[leveloffset=+1]
1513

1614
include::modules/virt-viewing-network-state-of-node-console.adoc[leveloffset=+1]

networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="k8s-nmstate-updating-node-network-config"]
3-
= Updating node network configuration
3+
= Observing and updating the node network state and configuration
44
include::_attributes/common-attributes.adoc[]
55
:VirtProductName: OpenShift Container Platform
66
:context: k8s_nmstate-updating-node-network-config
77

88
toc::[]
99

10-
You can update the node network configuration, such as adding or removing interfaces from nodes, by applying `NodeNetworkConfigurationPolicy` manifests to the cluster.
1110

12-
include::modules/virt-about-nmstate.adoc[leveloffset=+1]
11+
include::modules/virt-viewing-network-state-of-node.adoc[leveloffset=+1]
1312

13+
include::modules/virt-viewing-network-state-of-node-console.adoc[leveloffset=+1]
1414

1515
include::modules/virt-node-network-config-console.adoc[leveloffset=+1]
1616
include::modules/virt-monitor-node-network-config-console.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)