Skip to content

Commit c14700c

Browse files
authored
Merge pull request #41108 from johnwilkins/TELCODOCS-362
TELCODOCS-362: D/S Documentation & RN: SDN-2215/MPNETWORK-4:Track Kubernetes NMstate to be GA for the bare metal platform
2 parents fbcb8f9 + 710912b commit c14700c

File tree

4 files changed

+29
-16
lines changed

4 files changed

+29
-16
lines changed

modules/ipi-install-network-requirements.adoc

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -152,18 +152,6 @@ Define a consistent clock date and time format in each cluster node's BIOS setti
152152

153153
You can reconfigure the control plane nodes to act as NTP servers on disconnected clusters, and reconfigure worker nodes to retrieve time from the control plane nodes.
154154

155-
[id='network-requirements-state-config_{context}']
156-
== State-driven network configuration requirements (Technology Preview)
157-
158-
{product-title} supports additional post-installation state-driven network configuration on the secondary network interfaces of cluster nodes using `kubernetes-nmstate`. For example, system administrators might configure a secondary network interface on cluster nodes after installation for a storage network.
159-
160-
[NOTE]
161-
====
162-
Configuration must occur before scheduling pods.
163-
====
164-
165-
State-driven network configuration requires installing `kubernetes-nmstate`, and also requires Network Manager running on the cluster nodes. See *OpenShift Virtualization > Kubernetes NMState (Tech Preview)* for additional details.
166-
167155
[id='network-requirements-out-of-band_{context}']
168156
== Port access for the out-of-band management IP address
169157

modules/virt-creating-interface-on-nodes.adoc

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You can configure multiple nmstate-enabled nodes concurrently. The configuration
1515

1616
.Procedure
1717

18-
. Create the `NodeNetworkConfigurationPolicy` manifest. The following example configures a Linux bridge on all worker nodes:
18+
. Create the `NodeNetworkConfigurationPolicy` manifest. The following example configures a Linux bridge on all worker nodes and configures the DNS resolver:
1919
+
2020
[source,yaml]
2121
----
@@ -36,18 +36,27 @@ spec:
3636
ipv4:
3737
dhcp: true
3838
enabled: true
39+
auto-dns: false
3940
bridge:
4041
options:
4142
stp:
4243
enabled: false
4344
port:
4445
- name: eth1
46+
dns-resolver: <6>
47+
config:
48+
search:
49+
- example.com
50+
- example.org
51+
server:
52+
- 8.8.8.8
4553
----
4654
<1> Name of the policy.
4755
<2> Optional: If you do not include the `nodeSelector` parameter, the policy applies to all nodes in the cluster.
4856
<3> This example uses the `node-role.kubernetes.io/worker: ""` node selector to select all worker nodes in the cluster.
4957
<4> Optional: Specifies the maximum number of nmstate-enabled nodes that the policy configuration can be applied to concurrently. This parameter can be set to either a percentage value (string), for example, `"10%"`, or an absolute value (number), such as `3`.
5058
<5> Optional: Human-readable description for the interface.
59+
<6> Optional: Specifies the search and server settings for the DNS server.
5160

5261
. Create the node network policy:
5362
+

modules/virt-example-nmstate-IP-management.adoc

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
// * virt/node_network/virt-updating-node-network-config.adoc
44
// * networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc
55

6+
:_content-type: REFERENCE
67
[id="virt-example-nmstate-IP-management_{context}"]
78
= Examples: IP management
89

@@ -90,13 +91,17 @@ The following snippet configures an Ethernet interface that uses a dynamic IP ad
9091
[id="virt-example-nmstate-IP-management-dns_{context}"]
9192
== DNS
9293

93-
The following snippet sets DNS configuration on the host.
94+
Setting the DNS configuration is analagous to modifying the `/etc/resolv.conf` file. The following snippet sets the DNS configuration on the host.
9495

9596
[source,yaml]
9697
----
9798
...
98-
interfaces:
99+
interfaces: <1>
99100
...
101+
ipv4:
102+
...
103+
auto-dns: false
104+
...
100105
dns-resolver:
101106
config:
102107
search:
@@ -106,6 +111,12 @@ The following snippet sets DNS configuration on the host.
106111
- 8.8.8.8
107112
...
108113
----
114+
<1> You must configure an interface with `auto-dns: false` or you must use static IP configuration on an interface in order for Kubernetes NMState to store custom DNS settings.
115+
116+
[IMPORTANT]
117+
====
118+
You cannot use `br-ex`, an OVNKubernetes-managed Open vSwitch bridge, as the interface when configuring DNS resolvers.
119+
====
109120

110121
[id="virt-example-nmstate-IP-management-static-routing_{context}"]
111122
== Static routing

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ toc::[]
88

99
The Kubernetes NMState Operator provides a Kubernetes API for performing state-driven network configuration across the {product-title} cluster's nodes with NMState. The Kubernetes NMState Operator provides users with functionality to configure various network interface types, DNS, and routing on cluster nodes. Additionally, the daemons on the cluster nodes periodically report on the state of each node's network interfaces to the API server.
1010

11-
include::snippets/technology-preview.adoc[]
11+
[IMPORTANT]
12+
====
13+
Red Hat supports the Kubernetes NMState Operator in production environments on bare metal platform installations only. For other platforms, the Kubernetes NMState Operator is a Technology Preview. See the following Technology Preview statement for support limitations when using Kubernetes NMState on platforms other than bare metal.
14+
====
15+
16+
include::modules/technology-preview.adoc[]
1217

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

0 commit comments

Comments
 (0)