Skip to main content
Version: 2.8

TCP/UDP 动态代理

众多的闻名的应用和服务，像 LDAP、 MYSQL 和 RTMP ，选择 TCP 作为通信协议。 但是像 DNS、 syslog 和 RADIUS 这类非事务性的应用，他们选择了 UDP 协议。

APISIX 可以对 TCP/UDP 协议进行代理并实现动态负载均衡。 在 nginx 世界，称 TCP/UDP 代理为 stream 代理，在 APISIX 这里我们也遵循了这个声明.

如何开启 Stream 代理?#

在 conf/config.yaml 配置文件设置 stream_proxy 选项， 指定一组需要进行动态代理的 IP 地址。默认情况不开启 stream 代理。

apisix:  stream_proxy: # TCP/UDP proxy    tcp: # TCP proxy address list      - 9100      - "127.0.0.1:9101"    udp: # UDP proxy address list      - 9200      - "127.0.0.1:9211"

如果你需要同时启用 HTTP 和 stream 代理，设置 only 为 false：

apisix:  stream_proxy: # TCP/UDP proxy    only: false    tcp: # TCP proxy address list      - 9100

如何设置 route ?#

简例如下:

curl http://127.0.0.1:9080/apisix/admin/stream_routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "remote_addr": "127.0.0.1",    "upstream": {        "nodes": {            "127.0.0.1:1995": 1        },        "type": "roundrobin"    }}'

例子中 APISIX 对客户端 IP 为 127.0.0.1 的请求代理转发到上游主机 127.0.0.1:1995。 更多用例，请参照 test case.

更多 route 匹配选项#

我们可以添加更多的选项来匹配 route 。

例如

curl http://127.0.0.1:9080/apisix/admin/stream_routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "server_addr": "127.0.0.1",    "server_port": 2000,    "upstream": {        "nodes": {            "127.0.0.1:1995": 1        },        "type": "roundrobin"    }}'

例子中 APISIX 会把服务器地址为 127.0.0.1, 端口为 2000 代理到上游地址 127.0.0.1:1995。

完整的匹配选项列表参见 Admin API 的 Stream Route。

接收 TLS over TCP#

APISIX 支持接收 TLS over TCP。

首先，我们需要给对应的 TCP 地址启用 TLS：

apisix:  stream_proxy: # TCP/UDP proxy    tcp: # TCP proxy address list      - addr: 9100        tls: true

接着，我们需要为给定的 SNI 配置证书。 具体步骤参考 Admin API 的 SSL。

然后，我们需要配置一个 route，匹配连接并代理到上游：

curl http://127.0.0.1:9080/apisix/admin/stream_routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "remote_addr": "127.0.0.1",    "upstream": {        "nodes": {            "127.0.0.1:1995": 1        },        "type": "roundrobin"    }}'

当连接为 TLS over TCP 时，我们可以通过 SNI 来匹配路由，比如：

curl http://127.0.0.1:9080/apisix/admin/stream_routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "sni": "a.test.com",    "upstream": {        "nodes": {            "127.0.0.1:5991": 1        },        "type": "roundrobin"    }}'

在这里，握手时发送 SNI a.test.com 的连接会被代理到 127.0.0.1:5991。