Skip to content

Commit 611abe4

Browse files
author
Steven Smith
committed
Modularizes complex procedure
1 parent fd294ca commit 611abe4

12 files changed

+552
-393
lines changed

installing/installing_aws/aws-compute-edge-zone-tasks.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,11 @@ You might need to change the maximum transmission unit (MTU) value for the clust
3030
include::modules/nw-cluster-mtu-change-about.adoc[leveloffset=+2]
3131

3232
// Changing the cluster network MTU
33-
include::modules/nw-cluster-mtu-change.adoc[leveloffset=+3]
33+
include::modules/nw-cluster-mtu-change.adoc[leveloffset=+2]
34+
include::modules/nw-cluster-mtu-checking.adoc[leveloffset=+3]
35+
include::modules/nw-cluster-mtu-migration.adoc[leveloffset=+3]
36+
include::modules/nw-cluster-mtu-verifying-configuration.adoc[leveloffset=+3]
37+
include::modules/nw-cluster-mtu-finalizing-migration.adoc[leveloffset=+3]
3438

3539
// Opting in to AWS Local Zones or Wavelength Zones
3640
include::modules/installation-aws-add-zone-locations.adoc[leveloffset=+2]

installing/installing_aws/ipi/installing-aws-outposts.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ To extend your VPC cluster into an Outpost, you must complete the following netw
4242

4343
//Changing the Cluster Network MTU to support AWS Outposts
4444
include::modules/nw-cluster-mtu-change.adoc[leveloffset=+2]
45+
include::modules/nw-cluster-mtu-checking.adoc[leveloffset=+3]
46+
include::modules/nw-cluster-mtu-migration.adoc[leveloffset=+3]
47+
include::modules/nw-cluster-mtu-verifying-configuration.adoc[leveloffset=+3]
48+
include::modules/nw-cluster-mtu-finalizing-migration.adoc[leveloffset=+3]
4549
[role="_additional-resources"]
4650
.Additional resources
4751
* xref:../../../networking/advanced_networking/changing-cluster-network-mtu.adoc#changing-cluster-network-mtu[Changing the MTU for the cluster network]
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/changing-cluster-network-mtu.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="nw-cluster-mtu-applying-mtu-value_{context}"]
7+
= Applying the new hardware MTU value
8+
9+
Use the following procedure to apply the new hardware maximum transmission unit (MTU) value.
10+
11+
.Procedure
12+
13+
. Update the underlying network interface MTU value:
14+
15+
** If you are specifying the new MTU with a NetworkManager connection configuration, enter the following command. The MachineConfig Operator automatically performs a rolling reboot of the nodes in your cluster.
16+
+
17+
[source,terminal]
18+
----
19+
$ for manifest in control-plane-interface worker-interface; do
20+
oc create -f $manifest.yaml
21+
done
22+
----
23+
24+
** If you are specifying the new MTU with a DHCP server option or a kernel command line and PXE, make the necessary changes for your infrastructure.
25+
26+
. As the Machine Config Operator updates machines in each machine config pool, the Operator reboots each node one by one. You must wait until all the nodes are updated. Check the machine config pool status by entering the following command:
27+
+
28+
[source,terminal]
29+
----
30+
$ oc get machineconfigpools
31+
----
32+
+
33+
A successfully updated node has the following status: `UPDATED=true`, `UPDATING=false`, `DEGRADED=false`.
34+
+
35+
[NOTE]
36+
====
37+
By default, the Machine Config Operator updates one machine per pool at a time, causing the total time the migration takes to increase with the size of the cluster.
38+
====
39+
40+
. Confirm the status of the new machine configuration on the hosts:
41+
42+
.. To list the machine configuration state and the name of the applied machine configuration, enter the following command:
43+
+
44+
[source,terminal]
45+
----
46+
$ oc describe node | egrep "hostname|machineconfig"
47+
----
48+
+
49+
.Example output
50+
[source,text]
51+
----
52+
kubernetes.io/hostname=master-0
53+
machineconfiguration.openshift.io/currentConfig: rendered-master-c53e221d9d24e1c8bb6ee89dd3d8ad7b
54+
machineconfiguration.openshift.io/desiredConfig: rendered-master-c53e221d9d24e1c8bb6ee89dd3d8ad7b
55+
machineconfiguration.openshift.io/reason:
56+
machineconfiguration.openshift.io/state: Done
57+
----
58+
+
59+
Verify that the following statements are true:
60+
+
61+
--
62+
* The value of `machineconfiguration.openshift.io/state` field is `Done`.
63+
* The value of the `machineconfiguration.openshift.io/currentConfig` field is equal to the value of the `machineconfiguration.openshift.io/desiredConfig` field.
64+
--
65+
66+
.. To confirm that the machine config is correct, enter the following command:
67+
+
68+
[source,terminal]
69+
----
70+
$ oc get machineconfig <config_name> -o yaml | grep path:
71+
----
72+
+
73+
--
74+
where:
75+
76+
`<config_name>`:: Specifies the name of the machine config from the `machineconfiguration.openshift.io/currentConfig` field.
77+
--
78+
+
79+
If the machine config is successfully deployed, the previous output contains the `/etc/NetworkManager/conf.d/99-<interface>-mtu.conf` file path and the `ExecStart=/usr/local/bin/mtu-migration.sh` line.

modules/nw-cluster-mtu-change-about.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Only the OVN-Kubernetes cluster network plugin supports changing the MTU value.
1919
[id="service-interruption-considerations_{context}"]
2020
== Service interruption considerations
2121

22-
When you initiate an MTU change on your cluster the following effects might impact service availability:
22+
When you initiate a maximum transmission unit (MTU) change on your cluster the following effects might impact service availability:
2323

2424
* At least two rolling reboots are required to complete the migration to a new MTU. During this time, some nodes are not available as they restart.
2525

@@ -28,7 +28,7 @@ When you initiate an MTU change on your cluster the following effects might impa
2828
[id="mtu-value-selection_{context}"]
2929
== MTU value selection
3030

31-
When planning your MTU migration there are two related but distinct MTU values to consider.
31+
When planning your maximum transmission unit (MTU) migration there are two related but distinct MTU values to consider.
3232

3333
* *Hardware MTU*: This MTU value is set based on the specifics of your network infrastructure.
3434
* *Cluster network MTU*: This MTU value is always less than your hardware MTU to account for the cluster network overlay overhead. The specific overhead is determined by your network plugin. For OVN-Kubernetes, the overhead is `100` bytes.

0 commit comments

Comments
 (0)