Skip to content

Commit 6331910

Browse files
machtyk8s-infra-cherrypick-robot
authored andcommitted
Clarify TCP/UDP service docs
In the current state, the docs on TCP/UDP aren't really clear on exactly whether/how TCP/UDP traffic is supported. This is an attempt to clarify the limitations inherent to k8s Ingress resources vs what can be accomplished with this controller.
1 parent ab99e23 commit 6331910

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/user-guide/exposing-tcp-udp-services.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Exposing TCP and UDP services
22

3-
Ingress does not support TCP or UDP services. For this reason this Ingress controller uses the flags `--tcp-services-configmap` and `--udp-services-configmap` to point to an existing config map where the key is the external port to use and the value indicates the service to expose using the format:
3+
While the Kubernetes Ingress resource only officially supports routing external HTTP(s) traffic to services, ingress-nginx can be configured to receive external TCP/UDP traffic from non-HTTP protocols and route them to internal services using TCP/UDP port mappings that are specified within a ConfigMap.
4+
5+
To support this, the `--tcp-services-configmap` and `--udp-services-configmap` flags can be used to point to an existing config map where the key is the external port to use and the value indicates the service to expose using the format:
46
`<namespace/service name>:<service port>:[PROXY]:[PROXY]`
57

68
It is also possible to use a number or the name of the port. The two last fields are optional.

0 commit comments

Comments
 (0)