代理 gRPC 流量
Google Remote Procedure Call(gRPC)是一个基于 HTTP/2 协议的开源高性能远程过程调用(RPC)框架,使用 Protocol Buffers(protobuf)作为接口描述语言(IDL)。API7 企业版提供协议转换、负载均衡、身份认证和授权等关键功能,扩展 gRPC 的应用能力。
本指南介绍如何使用 API7 企业版代理 gRPC 服务流量。
以下交互演示介绍如何使用 API7 企业版代理 gRPC 流量。
前提条件
- 安装 API7 企业版。
- 如有需要,完成在 Kubernetes 上部署 API7 Ingress Controller。
- 安装 gRPCurl,用于向 gRPC 服务发送请求进行验证。
部署示例 gRPC 服务器
API7 提供了一个用于测试的示例 gRPC 服务。你可以根据 API7 的安装方式,在 Docker 或 Kubernetes 中启动该服务。
启动服务器
- 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 服务器的 Deployment 和 Service 创建 Kubernetes 清单文件。
apiVersion: apps/v1
kind: Deployment
metadata:
namespace: api7
name: grpc-service
spec:
replicas: 1
selector:
matchLabels:
app: grpc-service
template:
metadata:
labels:
app: grpc-service
spec:
containers:
- name: grpc-service
image: api7/grpc-server-example:1.0.0
ports:
- containerPort: 50051
---
apiVersion: v1
kind: Service
metadata:
namespace: api7
name: grpc-service
spec:
type: ClusterIP
selector:
app: grpc-service
ports:
- name: grpc
port: 50051
targetPort: 50051
将配置应用到集群。
kubectl apply -f grpc-server.yaml
验证 gRPC 服务器启动成功
- Docker
- Kubernetes
将 Service 的 50051 端口转发到本机端口。
kubectl port-forward svc/grpc-service 50051:50051 &
列出所有可用的 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 服务。
- 控制台
- ADC
- Ingress Controller
新增服务
- 在侧边导航栏选择网关组的已发布服务,然后点击新增服务。
- 选择手动新增。
- 在对话框中完成以下操作。
- 在名称字段中输入
grpc-example。 - 在服务类型字段中选择
HTTP(七层代理)。 - 在上游协议字段中选择
gRPC。 - 在如何找到上游字段中选择使用节点。
- 点击新增节点。
- 在新增节点对话框中完成以下操作。
- 在主机字段中输入你的私有 IP 地址,例如
192.168.2.103。 - 在端口字段中输入
50051。 - 在权重字段中使用默认值
100。
- 在主机字段中输入你的私有 IP 地址,例如
- 点击新增。
创建一条路由
- 在上一步创建的服务中,点击新增路由。
- 在对话框中完成以下操作。
- 在名称字段中输入
helloworld.Greeter。 - 在路径字段中输入
helloworld.Greeter/SayHello。 - 在方法字段中选择
GET和POST。 - 点击新增。
创建 ADC 配置文件,为 gRPC 服务配置路由。
services:
- name: grpc-example
upstream:
name: gRPC Upstream
scheme: grpc
type: roundrobin
nodes:
- host: 192.168.2.103
port: 50051
weight: 100
routes:
- uris:
- /helloworld.Greeter/SayHello
name: helloworld.Greeter
methods:
- GET
- POST
将配置同步到 API7 网关。
adc sync -f adc.yaml
- Gateway API
- APISIX CRD
创建 Kubernetes 清单文件,为 gRPC 服务配置 GRPCRoute。
apiVersion: gateway.networking.k8s.io/v1
kind: GRPCRoute
metadata:
namespace: api7
name: grpc-route
spec:
parentRefs:
- name: apisix
rules:
- matches:
- method:
service: helloworld.Greeter
method: SayHello
backendRefs:
- name: grpc-service
port: 50051
创建 Kubernetes 清单文件,为 gRPC 服务配置路由,并将上游协议配置为 grpc。
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
namespace: api7
name: grpc-service
spec:
ingressClassName: apisix
scheme: grpc
---
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
namespace: api7
name: grpc-route
spec:
ingressClassName: apisix
http:
- name: helloworld-greeter
match:
paths:
- /helloworld.Greeter/SayHello
methods:
- GET
- POST
backends:
- serviceName: grpc-service
servicePort: 50051
将配置应用到集群。
kubectl apply -f grpc-route.yaml
更新 API7 网关实例以支持 HTTP/2
默认情况下,API7 网关实例在 9443 端口支持 TLS 加密的 HTTP/2。对于未加密的 HTTP/2,可以在网关配置中新增端口。
本节将更新 API7 网关的配置和部署,以在 9081 端口支持未加密的 HTTP/2。
- Docker
- Kubernetes
由于 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
更新网关 HTTP2 配置前,先导出所有配置值,包括默认值。
helm get values -n api7 api7-ee-3-gateway --all > values.yaml
在 values 文件中,将以下部分更新为所示配置值。
gateway:
http:
enabled: true
ip: 0.0.0.0
servicePort: 80
containerPort: 9080
additionalContainerPorts:
- port: 9081
enable_http2: true
升级 release。
helm upgrade --install -n api7 api7-ee-3-gateway api7/gateway -f values.yaml
验证 gRPC 服务
下载 helloworld.proto 文件。
本示例使用 helloworld.proto 文件,确保 gRPCurl CLI 工具的请求和响应格式与 gRPC 服务定义一致。
- Docker
- Kubernetes
如果网关实例安装在 Docker 中,并使用控制台或 ADC 进行配置,请向路由发送请求。
如果网关实例安装在 Kubernetes 上,并使用 Ingress Controller 进行配置,请先通过端口转发将 Service 端口暴露到本机。
kubectl port-forward svc/api7-ee-3-gateway-gateway 9081:9081 &
向路由发送请求。
grpcurl -plaintext \
-proto helloworld.proto \
-d '{"name":"API7"}' \
"127.0.0.1:9081" \
"helloworld.Greeter.SayHello"
你应该看到以下输出。
{
"message": "Hello API7"
}