From c5af115703bcf22d6b689bea0258a8836eed8f03 Mon Sep 17 00:00:00 2001 From: Aaron U'Ren Date: Wed, 2 Feb 2022 15:50:37 -0600 Subject: [PATCH] docs: clarify auto-mtu flag purpose --- docs/user-guide.md | 2 +- pkg/options/options.go | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/user-guide.md b/docs/user-guide.md index 0dde9680..62429d8c 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -44,7 +44,7 @@ Usage of kube-router: --advertise-external-ip Add External IP of service to the RIB so that it gets advertised to the BGP peers. --advertise-loadbalancer-ip Add LoadbBalancer IP of service status as set by the LB provider to the RIB so that it gets advertised to the BGP peers. --advertise-pod-cidr Add Node's POD cidr to the RIB so that it gets advertised to the BGP peers. (default true) - --auto-mtu Auto detect and set the largest possible MTU for pod interfaces. (default true) + --auto-mtu Auto detect and set the largest possible MTU for kube-bridge and pod interfaces (also accounts for IPIP overlay network when enabled). (default true) --bgp-graceful-restart Enables the BGP Graceful Restart capability so that routes are preserved on unexpected restarts --bgp-graceful-restart-deferral-time duration BGP Graceful restart deferral time according to RFC4724 4.1, maximum 18h. (default 6m0s) --bgp-graceful-restart-time duration BGP Graceful restart time according to RFC4724 3, maximum 4095s. (default 1m30s) diff --git a/pkg/options/options.go b/pkg/options/options.go index 6da6cbd2..dfc65d75 100644 --- a/pkg/options/options.go +++ b/pkg/options/options.go @@ -103,7 +103,8 @@ func (s *KubeRouterConfig) AddFlags(fs *pflag.FlagSet) { fs.BoolVar(&s.AdvertiseNodePodCidr, "advertise-pod-cidr", true, "Add Node's POD cidr to the RIB so that it gets advertised to the BGP peers.") fs.BoolVar(&s.AutoMTU, "auto-mtu", true, - "Auto detect and set the largest possible MTU for pod interfaces.") + "Auto detect and set the largest possible MTU for kube-bridge and pod interfaces (also accounts for "+ + "IPIP overlay network when enabled).") fs.BoolVar(&s.BGPGracefulRestart, "bgp-graceful-restart", false, "Enables the BGP Graceful Restart capability so that routes are preserved on unexpected restarts") fs.DurationVar(&s.BGPGracefulRestartDeferralTime, "bgp-graceful-restart-deferral-time",