DevFW-CICD/ingress-nginx-helm
16
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Docs: Clarify external & service port in TCP/UDP services explanation. (#12194)

Browse source 
Co-authored-by: Fedello <31769405+pvillaverde@users.noreply.github.com>
This commit is contained in:
k8s-infra-cherrypick-robot 2024-10-15 06:34:22 -07:00 committed by GitHub
parent 2c8f64928c
commit 35f5902ac8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/user-guide/exposing-tcp-udp-services.md
View file

@ -3,7 +3,7 @@
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.
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:
`<service port>:<namespace/service name>:[PROXY]:[PROXY]`
`<external port>:<namespace/service name>:<service port/name>:[PROXY]:[PROXY]`
It is also possible to use a number or the name of the port. The two last fields are optional.
Adding `PROXY` in either or both of the two last fields we can use [Proxy Protocol](https://www.nginx.com/resources/admin-guide/proxy-protocol) decoding (listen) and/or encoding (proxy_pass) in a TCP service.