Skip to content

Commit 149b01f

Browse files
yboaronskitt
authored andcommitted
Add documentation for TCP MSS clamping customization
Add a new section under Cable Drivers Topology Overview explaining how to customize TCP MSS clamping to resolve MTU issues. Signed-off-by: Yossi Boaron <yboaron@redhat.com>
1 parent d8be014 commit 149b01f

File tree

1 file changed

+14
-0
lines changed
  • src/content/getting-started/architecture/gateway-engine

1 file changed

+14
-0
lines changed

src/content/getting-started/architecture/gateway-engine/_index.en.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,20 @@ a second cluster) when Submariner is used.
9292
![Figure 3 - Clusters inter-connected using VXLAN tunnels](/images/cable-drivers/vxlan_cable.png)
9393
<!-- Image Source (draw.io): src/static/images/cable-drivers/cable_driver_networking.drawio -->
9494

95+
#### Customize TCP MSS Clamping
96+
97+
In network topologies where MTU issues are observed, the encapsulation overhead added by Submariner can cause packet drops.
98+
To resolve this, you can force a specific MSS clamping value by adding an annotation to the Gateway nodes,
99+
which instructs Submariner to rewrite the TCP Maximum Segment Size.
100+
101+
Use the following commands to apply the configuration and restart the route-agent pods to pick up the change:
102+
103+
```bash
104+
kubectl annotate node <gw_node_name> submariner.io/tcp-clamp-mss=<value>
105+
106+
kubectl delete pod -n submariner-operator -l app=submariner-routeagent
107+
```
108+
95109
### Gateway Failover
96110

97111
If the active Gateway Engine fails, another Gateway Engine on one of the

0 commit comments

Comments
 (0)