Skip to content

Commit 769f37d

Browse files
committed
OCPBUGS-55174: Updated the changing-cluster-network-mtu file with NIC info
1 parent 5f2ef82 commit 769f37d

File tree

2 files changed

+25
-41
lines changed

2 files changed

+25
-41
lines changed

modules/nw-cluster-mtu-change.adoc

Lines changed: 22 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ ifndef::outposts[= Changing the cluster network MTU]
2323
ifdef::outposts[= Changing the cluster network MTU to support AWS Outposts]
2424

2525
ifdef::outposts[]
26-
During installation, the maximum transmission unit (MTU) for the cluster network is detected automatically based on the MTU of the primary network interface of nodes in the cluster.
27-
You might need to decrease the MTU value for the cluster network to support an AWS Outposts subnet.
26+
During installation, the maximum transmission unit (MTU) for the cluster network is detected automatically based on the MTU of the primary network interface of nodes in the cluster. You might need to decrease the MTU value for the cluster network to support an AWS Outposts subnet.
2827
endif::outposts[]
2928

3029
ifndef::outposts[As a cluster administrator, you can increase or decrease the maximum transmission unit (MTU) for your cluster.]
@@ -72,60 +71,42 @@ Status:
7271

7372
ifndef::local-zone,wavelength-zone,post-aws-zones,outposts[]
7473
. Prepare your configuration for the hardware MTU:
75-
76-
** If your hardware MTU is specified with DHCP, update your DHCP configuration such as with the following dnsmasq configuration:
74+
+
75+
.. If your hardware MTU is specified with DHCP, update your DHCP configuration such as with the following dnsmasq configuration:
7776
+
7877
[source,text]
7978
----
80-
dhcp-option-force=26,<mtu>
79+
dhcp-option-force=26,<mtu> <1>
8180
----
81+
<1> Where `<mtu>` specifies the hardware MTU for the DHCP server to advertise.
82+
+
83+
.. If your hardware MTU is specified with a kernel command line with PXE, update that configuration accordingly.
84+
+
85+
.. If your hardware MTU is specified in a NetworkManager connection configuration, complete the following steps. This approach is the default for {product-title} if you do not explicitly specify your network configuration with DHCP, a kernel command line, or some other method. Your cluster nodes must all use the same underlying network configuration for the following procedure to work unmodified.
8286
+
83-
--
84-
where:
85-
86-
`<mtu>`:: Specifies the hardware MTU for the DHCP server to advertise.
87-
--
88-
89-
** If your hardware MTU is specified with a kernel command line with PXE, update that configuration accordingly.
90-
91-
** If your hardware MTU is specified in a NetworkManager connection configuration, complete the following steps. This approach is the default for {product-title} if you do not explicitly specify your network configuration with DHCP, a kernel command line, or some other method. Your cluster nodes must all use the same underlying network configuration for the following procedure to work unmodified.
92-
9387
... Find the primary network interface by entering the following command:
94-
9588
+
9689
[source,terminal]
9790
----
98-
$ oc debug node/<node_name> -- chroot /host nmcli -g connection.interface-name c show ovs-if-phys0
91+
$ oc debug node/<node_name> -- chroot /host nmcli -g connection.interface-name c show ovs-if-phys0 <1>
9992
----
93+
<1> where `<node_name>` specifies the name of a node in your cluster.
10094
+
101-
--
102-
where:
103-
104-
`<node_name>`:: Specifies the name of a node in your cluster.
105-
--
106-
10795
... Create the following NetworkManager configuration in the `<interface>-mtu.conf` file:
10896
+
10997
.Example NetworkManager connection configuration
11098
[source,ini]
11199
----
112100
[connection-<interface>-mtu]
113-
match-device=interface-name:<interface>
114-
ethernet.mtu=<mtu>
101+
match-device=interface-name:<interface> <1>
102+
ethernet.mtu=<mtu> <2>
115103
----
104+
<1> Where `<interface>` specifies the primary network interface name.
105+
<2> Where `<mtu>` specifies the new hardware MTU value.
116106
+
117-
--
118-
where:
119-
120-
`<mtu>`:: Specifies the new hardware MTU value.
121-
`<interface>`:: Specifies the primary network interface name.
122-
--
123-
124-
... Create two `MachineConfig` objects, one for the control plane nodes and another for the worker nodes in your cluster:
125-
126-
.... Create the following Butane config in the `control-plane-interface.bu` file:
107+
... Create the following Butane config in the `control-plane-interface.bu` file, which is the `MachineConfig` object for the control plane nodes:
127108
+
128-
[source,yaml, subs="attributes+"]
109+
[source,yaml,subs="attributes+"]
129110
----
130111
variant: openshift
131112
version: {product-version}.0
@@ -142,10 +123,10 @@ storage:
142123
----
143124
<1> Specify the NetworkManager connection name for the primary network interface.
144125
<2> Specify the local filename for the updated NetworkManager configuration file from the previous step.
145-
146-
.... Create the following Butane config in the `worker-interface.bu` file:
147126
+
148-
[source,yaml, subs="attributes+"]
127+
... Create the following Butane config in the `worker-interface.bu` file, which is the `MachineConfig` object for the compute nodes:
128+
+
129+
[source,yaml,subs="attributes+"]
149130
----
150131
variant: openshift
151132
version: {product-version}.0
@@ -162,8 +143,8 @@ storage:
162143
----
163144
<1> Specify the NetworkManager connection name for the primary network interface.
164145
<2> Specify the local filename for the updated NetworkManager configuration file from the previous step.
165-
166-
.... Create `MachineConfig` objects from the Butane configs by running the following command:
146+
+
147+
... Create `MachineConfig` objects from the Butane configs by running the following command:
167148
+
168149
[source,terminal]
169150
----

networking/changing-cluster-network-mtu.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ toc::[]
99
[role="_abstract"]
1010
As a cluster administrator, you can change the MTU for the cluster network after cluster installation. This change is disruptive as cluster nodes must be rebooted to finalize the MTU change.
1111

12+
// About the cluster MTU
1213
include::modules/nw-cluster-mtu-change-about.adoc[leveloffset=+1]
14+
15+
// Changing the cluster network MTU or Changing the cluster network MTU to support AWS Outposts
1316
include::modules/nw-cluster-mtu-change.adoc[leveloffset=+1]
1417

1518
[role="_additional-resources"]

0 commit comments

Comments
 (0)