代理 TCP 流量
API7 网关可以单独处理传输层(四层)的 TCP 和 UDP 流量,也可以同时处理应用层(七层)流量。
本教程介绍如何在已发布服务中配置四层路由,代理客户端与 MySQL 服务器之间的四层流量。
前提条件
- 安装 API7 企业版。
- 在你的网关组中至少有一个网关实例。
- 安装一个 MySQL 客户端以验证四层代理路由。
启动 MySQL 服务器
- Docker
- Kubernetes
如果你在 Docker 中安装了网关实例,并使用控制台或 ADC 进行配置,请在 API7 企业版的默认网络 api7-ee_api7 中启动 MySQL 服务器。
docker run -d \
--name mysql \
--network=api7-ee_api7 \
-p 3306:3306 \
-e MYSQL_ROOT_PASSWORD=password \
mysql:8.4 \
mysqld --mysql-native-password=ON
如果你在 Kubernetes 上安装了网关实例,并使用 Ingress Controller 进行配置,请在 Kubernetes 上启动 MySQL 服务器。
kubectl run mysql --image mysql:8.4 --port 3306 --env="MYSQL_ROOT_PASSWORD=password"
通过服务暴露服务器端口。
kubectl expose pod mysql --port 3306
启用传输层(四层)代理
默认情况下,API7 网关(数据面)只启用应用层(七层)代理。要同时接收传输层(四层)流量,请按以下示例在 config.yaml 配置文件中配置 proxy_mode 和 stream_proxy。
docker exec {container_name} /bin/sh -c "echo '
apisix:
proxy_mode: http&stream
stream_proxy:
tcp:
- 2000
' > /usr/local/apisix/conf/config.yaml"
❶ proxy_mode 指定同时接收传输层(四层)和应用层(七层)流量。
❷ stream_proxy 用于配置传输层(四层)代理的接口。
重新加载 API7 网关,使配置更改生效。
- Docker
- Kubernetes
docker exec {container_name} apisix reload
kubectl edit configmap $YOUR_GATEWAY_CONFIGMAP
kubectl rollout restart deployment $YOUR_GATEWAY_DEPLOYMENT
添加带有四层路由的服务
- 控制台
- ADC
- Ingress Controller
- 从侧边栏选择网关组的已发布服务,然后点击新增服务。
- 选择手动新增。
- 在对话框中完成以下操作。
- 在名称字段中输入
MySQL。 - 在服务类型字段中选择
Stream(四层代理)。 - 在上游 Scheme 字段中选择
TCP。 - 在如何找到上游字段中选择
使用节点。 - 点击新增节点。
- 在新增节点对话框中完成以下操作。
- 在主机字段中输入你的私有 IP 地址,例如
192.168.2.103。 - 在端口字段中输入
3306。 - 权重字段使用默认值
100。 - 点击新增。这会创建一个处于「无版本」状态的服务。
- 在主机字段中输入你的私有 IP 地址,例如
- 在服务内点击新增四层路由。
- 在服务内点击新增四层路由。
- 在名称字段中输入
stream-route-mysql。 - 在服务器地址字段中输入
127.0.0.1。 - 在服务器端口字段中输入
2000。 - 点击新增。
要使用 ADC 创建四层路由,请使用以下配置。
services:
- name: MySQL
upstream:
name: default
scheme: tcp
nodes:
- host: 127.0.0.1
port: 3306
weight: 100
stream_routes:
- name: stream-route-mysql
server_addr: 127.0.0.1
server_port: 2000
将配置同步到 API7 企业版。
adc sync -f adc.yaml
创建 Kubernetes 清单文件,使用 ApisixRoute 自定义资源配置四层路由。
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
name: stream-route-mysql
namespace: api7
spec:
stream:
- name: stream-route-mysql
protocol: TCP
match:
ingressPort: 2000
backend:
serviceName: mysql
servicePort: 3306
将配置应用到集群。
kubectl apply -f stream-route.yaml
你应该会看到以下响应。
apisixroute.apisix.apache.org/stream-route-mysql created
验证四层路由
- Docker
- Kubernetes
如果你在 Docker 中安装了网关实例,并使用控制台或 ADC 进行配置,请先将服务器端口 2000 暴露到主机(-p2000:2000),然后再进行验证。
如果你在 Kubernetes 上安装了网关实例,并使用 Ingress Controller 进行配置,请编辑服务以添加服务端口。
kubectl edit svc/api7-ee-3-gateway-gateway
添加 MySQL 的服务端口。
spec:
ports:
...
- name: apisix-gateway-mysql
port: 2000
protocol: TCP
targetPort: 2000
...
为服务转发端口 2000。
kubectl port-forward svc/api7-ee-3-gateway-gateway 2000:2000 &
使用 MySQL 客户端通过 API7 网关连接 MySQL 服务器。使用前面配置的密码以 root 用户身份连接。
mysql --host=127.0.0.1 --port=2000 -u root -p
你应该会看到以下 MySQL 提示符。
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 9
Server version: 8.4.0 MySQL Community Server - GPL
Copyright (c) 2000, 2024, Oracle and/or its affiliates.
Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
mysql>