跳到主要内容
版本:3.8.x

代理 gRPC 流量

Google Remote Procedure Call(gRPC)是一个基于 HTTP/2 协议的开源高性能远程过程调用(RPC)框架,使用 Protocol Buffers(protobuf)作为接口描述语言(IDL)。API7 企业版提供协议转换、负载均衡、身份认证和授权等关键功能,扩展 gRPC 的应用能力。

本指南介绍如何使用 API7 企业版代理 gRPC 服务流量。

以下交互演示介绍如何使用 API7 企业版代理 gRPC 流量。

前提条件​

  1. 安装 API7 企业版。
  2. 如有需要,完成在 Kubernetes 上部署 API7 Ingress Controller。
  3. 安装 gRPCurl,用于向 gRPC 服务发送请求进行验证。

部署示例 gRPC 服务器​

API7 提供了一个用于测试的示例 gRPC 服务。你可以根据 API7 的安装方式,在 Docker 或 Kubernetes 中启动该服务。

启动服务器​

在 Docker 中启动监听 50051 端口的示例 gRPC 服务器。

docker run -d \
--name grpc-service \
--network=api7-ee_api7 \
-p 50051:50051 \
--restart always api7/grpc-server-example:1.0.0

验证 gRPC 服务器启动成功​

列出所有可用的 gRPC 服务和方法,验证 gRPC 服务器是否成功启动。

grpcurl -plaintext 127.0.0.1:50051 list

你应该看到以下输出。

grpc.reflection.v1alpha.ServerReflection
helloworld.Greeter
helloworld.TestImport

列出 helloworld.Greeter 服务的所有可用方法。

grpcurl -plaintext 127.0.0.1:50051 list helloworld.Greeter

你应该看到以下输出。

helloworld.Greeter.GetErrResp
helloworld.Greeter.Plus
helloworld.Greeter.SayHello
helloworld.Greeter.SayHelloAfterDelay
helloworld.Greeter.SayHelloBidirectionalStream
helloworld.Greeter.SayHelloClientStream
helloworld.Greeter.SayHelloServerStream

创建服务和路由​

本节将创建一个服务及其路由,将流量代理到示例 gRPC 服务。

新增服务

  1. 在侧边导航栏选择网关组的已发布服务,然后点击新增服务。
  2. 选择手动新增。
  3. 在对话框中完成以下操作。
  • 在名称字段中输入 grpc-example。
  • 在服务类型字段中选择 HTTP(七层代理)。
  • 在上游协议字段中选择 gRPC。
  • 在如何找到上游字段中选择使用节点。
  • 点击新增节点。
  • 在新增节点对话框中完成以下操作。
    • 在主机字段中输入你的私有 IP 地址,例如 192.168.2.103。
    • 在端口字段中输入 50051。
    • 在权重字段中使用默认值 100。
  • 点击新增。

创建一条路由

  1. 在上一步创建的服务中,点击新增路由。
  2. 在对话框中完成以下操作。
  • 在名称字段中输入 helloworld.Greeter。
  • 在路径字段中输入 helloworld.Greeter/SayHello。
  • 在方法字段中选择 GET 和 POST。
  • 点击新增。

更新 API7 网关实例以支持 HTTP/2​

默认情况下,API7 网关实例在 9443 端口支持 TLS 加密的 HTTP/2。对于未加密的 HTTP/2,可以在网关配置中新增端口。

本节将更新 API7 网关的配置和部署,以在 9081 端口支持未加密的 HTTP/2。

由于 Docker 不支持在容器运行时更新端口映射,请先移除安装时启动的 api7-ee-gateway-1 网关容器。

接着,在 Docker 中启动新的网关实例。运行生成的部署命令前,添加 -p 9081:9081 参数。修改后的命令应类似以下内容。

docker run -d -e API7_CONTROL_PLANE_ENDPOINTS='["https://<YOUR_IP_ADDR>:7943"]' \
-e API7_GATEWAY_GROUP_SHORT_ID=default \
-e API7_CONTROL_PLANE_CERT="-----BEGIN CERTIFICATE-----
<CERT_CONTENT>
-----END CERTIFICATE-----
" \
-e API7_CONTROL_PLANE_KEY="-----BEGIN PRIVATE KEY-----
<PRIVATE_KEY_VALUE>
-----END PRIVATE KEY-----
" \
-e API7_CONTROL_PLANE_CA="-----BEGIN CERTIFICATE-----
<CERT_CONTENT>
-----END CERTIFICATE-----
" \
-e API7_CONTROL_PLANE_SNI="api7ee3-dp-manager" \
-p 9080:9080 \
-p 9081:9081 \
-p 9443:9443 \
api7/api7-ee-3-gateway:<VERSION>

运行命令启动网关。

网关运行后,更新网关配置,使其在 9081 端口支持 HTTP/2。

docker exec <api7-ee-gateway-container-name> /bin/sh -c "echo '
nginx_config:
error_log_level: warn

apisix:
node_listen:
- port: 9080
enable_http2: true
- port: 9081
enable_http2: true
' > /usr/local/apisix/conf/config.yaml"

重新加载容器,使配置变更生效。

docker exec <api7-ee-gateway-container-name> apisix reload

验证 gRPC 服务​

下载 helloworld.proto 文件。

本示例使用 helloworld.proto 文件,确保 gRPCurl CLI 工具的请求和响应格式与 gRPC 服务定义一致。

如果网关实例安装在 Docker 中,并使用控制台或 ADC 进行配置,请向路由发送请求。

grpcurl -plaintext \
-proto helloworld.proto \
-d '{"name":"API7"}' \
"127.0.0.1:9081" \
"helloworld.Greeter.SayHello"

你应该看到以下输出。

{
"message": "Hello API7"
}

相关阅读​