Skip to content

Commit 5e85870

Browse files
committed
OCPBUGS-6800: change the MTU in Local Zones deployments
Add section to change the the cluster network MTU on the manifest stage due the limitation of AWS Local Zones communication with the parent region. Adding OpenShift-SDN and "important" note Apply suggestions from code review Co-authored-by: Kathryn Alexander <[email protected]> Update modules/installation-localzone-generate-k8s-manifest.adoc Apply suggestions from code review Co-authored-by: Kathryn Alexander <[email protected]> pr review - making correct reference Update modules/installation-localzone-generate-k8s-manifest.adoc Update modules/installation-localzone-generate-k8s-manifest.adoc PR review for important notes on MTU
1 parent 1449cfd commit 5e85870

File tree

2 files changed

+52
-1
lines changed

2 files changed

+52
-1
lines changed

installing/installing_aws/installing-aws-localzone.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,12 @@ include::modules/installation-generate-aws-user-infra-install-config.adoc[levelo
7878

7979
include::modules/installation-localzone-generate-k8s-manifest.adoc[leveloffset=+2]
8080

81+
[role="_additional-resources"]
82+
.Additional resources
83+
84+
* xref:../../networking/changing-cluster-network-mtu.adoc#mtu-value-selection_changing-cluster-network-mtu[Changing the MTU for the cluster network]
85+
* xref:../../networking/changing-cluster-network-mtu.adoc#nw-ovn-ipsec-enable_configuring-ipsec-ovn[Enabling IPsec encryption]
86+
8187
include::modules/installation-launching-installer.adoc[leveloffset=+1]
8288

8389
include::modules/cli-installing-cli.adoc[leveloffset=+1]

modules/installation-localzone-generate-k8s-manifest.adoc

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,53 @@ $ ./openshift-install create manifests --dir <installation_directory> <1>
2626
<1> For `<installation_directory>`, specify the installation directory that
2727
contains the `install-config.yaml` file you created.
2828

29-
. Create the machine set manifests for the worker nodes in your Local Zone.
29+
. Set the default Maximum Transmission Unit (MTU) according to the network plugin:
30+
+
31+
[IMPORTANT]
32+
====
33+
Generally, the Maximum Transmission Unit (MTU) between an Amazon EC2 instance in a Local Zone and an Amazon EC2 instance in the Region is 1300. See link:https://docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html[How Local Zones work] in the AWS documentation.
34+
The cluster network MTU must be always less than the EC2 MTU to account for the overhead. The specific overhead is determined by your network plugin, for example:
35+
36+
- OVN-Kubernetes: `100 bytes`
37+
- OpenShift SDN: `50 bytes`
38+
39+
The network plugin could provide additional features, like IPsec, that also must be decreased the MTU. Check the documentation for additional information.
40+
41+
====
42+
43+
.. If you are using the `OVN-Kubernetes` network plugin, enter the following command:
44+
+
45+
[source,terminal]
46+
----
47+
$ cat <<EOF > <installation_directory>/manifests/cluster-network-03-config.yml
48+
apiVersion: operator.openshift.io/v1
49+
kind: Network
50+
metadata:
51+
name: cluster
52+
spec:
53+
defaultNetwork:
54+
ovnKubernetesConfig:
55+
mtu: 1200
56+
EOF
57+
----
3058
59+
.. If you are using the `OpenShift SDN` network plugin, enter the following command:
60+
+
61+
[source,terminal]
62+
----
63+
$ cat <<EOF > <installation_directory>/manifests/cluster-network-03-config.yml
64+
apiVersion: operator.openshift.io/v1
65+
kind: Network
66+
metadata:
67+
name: cluster
68+
spec:
69+
defaultNetwork:
70+
openshiftSDNConfig:
71+
mtu: 1250
72+
EOF
73+
----
74+
75+
. Create the machine set manifests for the worker nodes in your Local Zone.
3176
.. Export a local variable that contains the name of the Local Zone that you opted your AWS account into by running the following command:
3277
+
3378
[source,terminal]

0 commit comments

Comments
 (0)