TheArchive/tailscale
1
0
Fork 0
mirror of https://github.com/tailscale/tailscale.git synced 2024-12-04 23:45:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

cmd/k8s-operator: avoid port collision with metrics endpoint (#14185)

Browse Source 
When the operator enables metrics on a proxy, it uses the port 9001,
and in the near future it will start using 9002 for the debug endpoint
as well. Make sure we don't choose ports from a range that includes
9001 so that we never clash. Setting TS_SOCKS5_SERVER, TS_HEALTHCHECK_ADDR_PORT,
TS_OUTBOUND_HTTP_PROXY_LISTEN, and PORT could also open arbitrary ports,
so we will need to document that users should not choose ports from the
10000-11000 range for those settings.

Updates #13406

Signed-off-by: Tom Proctor <tomhjp@users.noreply.github.com>
This commit is contained in:
Tom Proctor 2024-12-03 15:02:42 +00:00 committed by GitHub
parent 9f9063e624
commit efdfd54797
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
cmd/k8s-operator/egress-services.go
View File

@ -51,12 +51,12 @@
labelSvcType = "tailscale.com/svc-type" // ingress or egress labelSvcType = "tailscale.com/svc-type" // ingress or egress
typeEgress = "egress" typeEgress = "egress"
// maxPorts is the maximum number of ports that can be exposed on a // maxPorts is the maximum number of ports that can be exposed on a
// container. In practice this will be ports in range [3000 - 4000). The // container. In practice this will be ports in range [10000 - 11000). The
// high range should make it easier to distinguish container ports from // high range should make it easier to distinguish container ports from
// the tailnet target ports for debugging purposes (i.e when reading // the tailnet target ports for debugging purposes (i.e when reading
// netfilter rules). The limit of 10000 is somewhat arbitrary, the // netfilter rules). The limit of 1000 is somewhat arbitrary, the
// assumption is that this would not be hit in practice. // assumption is that this would not be hit in practice.
maxPorts = 10000 maxPorts = 1000
indexEgressProxyGroup = ".metadata.annotations.egress-proxy-group" indexEgressProxyGroup = ".metadata.annotations.egress-proxy-group"
) )
@ -254,7 +254,7 @@ func (esr *egressSvcsReconciler) provision(ctx context.Context, proxyGroupName s
if !found { if !found {
// Calculate a free port to expose on container and add // Calculate a free port to expose on container and add
// a new PortMap to the ClusterIP Service. // a new PortMap to the ClusterIP Service.
if usedPorts.Len() == maxPorts { if usedPorts.Len() >= maxPorts {
// TODO(irbekrm): refactor to avoid extra reconciles here. Low priority as in practice, // TODO(irbekrm): refactor to avoid extra reconciles here. Low priority as in practice,
// the limit should not be hit. // the limit should not be hit.
return nil, false, fmt.Errorf("unable to allocate additional ports on ProxyGroup %s, %d ports already used. Create another ProxyGroup or open an issue if you believe this is unexpected.", proxyGroupName, maxPorts) return nil, false, fmt.Errorf("unable to allocate additional ports on ProxyGroup %s, %d ports already used. Create another ProxyGroup or open an issue if you believe this is unexpected.", proxyGroupName, maxPorts)
@ -548,13 +548,13 @@ func svcNameBase(s string) string {
} }
} }
// unusedPort returns a port in range [3000 - 4000). The caller must ensure that // unusedPort returns a port in range [10000 - 11000). The caller must ensure that
// usedPorts does not contain all ports in range [3000 - 4000). // usedPorts does not contain all ports in range [10000 - 11000).
func unusedPort(usedPorts sets.Set[int32]) int32 { func unusedPort(usedPorts sets.Set[int32]) int32 {
foundFreePort := false foundFreePort := false
var suggestPort int32 var suggestPort int32
for !foundFreePort { for !foundFreePort {
suggestPort = rand.Int32N(maxPorts) + 3000 suggestPort = rand.Int32N(maxPorts) + 10000
if !usedPorts.Has(suggestPort) { if !usedPorts.Has(suggestPort) {
foundFreePort = true foundFreePort = true
} }