mirror of
https://gitee.com/iresty/apisix.git
synced 2024-12-04 13:07:34 +08:00
113 lines
3.4 KiB
Markdown
113 lines
3.4 KiB
Markdown
---
|
||
title: gRPC Proxy
|
||
---
|
||
|
||
<!--
|
||
#
|
||
# Licensed to the Apache Software Foundation (ASF) under one or more
|
||
# contributor license agreements. See the NOTICE file distributed with
|
||
# this work for additional information regarding copyright ownership.
|
||
# The ASF licenses this file to You under the Apache License, Version 2.0
|
||
# (the "License"); you may not use this file except in compliance with
|
||
# the License. You may obtain a copy of the License at
|
||
#
|
||
# http://www.apache.org/licenses/LICENSE-2.0
|
||
#
|
||
# Unless required by applicable law or agreed to in writing, software
|
||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
# See the License for the specific language governing permissions and
|
||
# limitations under the License.
|
||
#
|
||
-->
|
||
|
||
proxying gRPC traffic:
|
||
gRPC client -> APISIX -> gRPC/gRPCS server
|
||
|
||
## Parameters
|
||
|
||
* `scheme`: the `scheme` of the route's upstream must be `grpc` or `grpcs`.
|
||
* `uri`: format likes /service/method, Example：/helloworld.Greeter/SayHello
|
||
|
||
### Example
|
||
|
||
#### create proxying gRPC route
|
||
|
||
Here's an example, to proxying gRPC service by specified route:
|
||
|
||
* attention: the `scheme` of the route's upstream must be `grpc` or `grpcs`.
|
||
* attention: APISIX use TLS‑encrypted HTTP/2 to expose gRPC service, so need to [config SSL certificate](https.md)
|
||
* attention: APISIX also support to expose gRPC service with plaintext HTTP/2, which does not rely on TLS, usually used to proxy gRPC service in intranet environment
|
||
* the grpc server example：[grpc_server_example](https://github.com/iresty/grpc_server_example)
|
||
|
||
```shell
|
||
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
|
||
{
|
||
"methods": ["POST", "GET"],
|
||
"uri": "/helloworld.Greeter/SayHello",
|
||
"upstream": {
|
||
"scheme": "grpc",
|
||
"type": "roundrobin",
|
||
"nodes": {
|
||
"127.0.0.1:50051": 1
|
||
}
|
||
}
|
||
}'
|
||
```
|
||
|
||
#### testing HTTP/2 with TLS‑encrypted
|
||
|
||
Invoking the route created before：
|
||
|
||
```shell
|
||
$ grpcurl -insecure -import-path /pathtoprotos -proto helloworld.proto -d '{"name":"apisix"}' 127.0.0.1:9443 helloworld.Greeter.SayHello
|
||
{
|
||
"message": "Hello apisix"
|
||
}
|
||
```
|
||
|
||
This means that the proxying is working.
|
||
|
||
#### testing HTTP/2 with plaintext
|
||
|
||
By default, the APISIX only listens to `9443` for TLS‑encrypted HTTP/2. You can support HTTP/2 with plaintext via the `node_listen` section under `apisix` in `conf/config.yaml`:
|
||
|
||
```yaml
|
||
apisix:
|
||
node_listen:
|
||
- port: 9080
|
||
enable_http2: false
|
||
- port: 9081
|
||
enable_http2: true
|
||
```
|
||
|
||
Invoking the route created before：
|
||
|
||
```shell
|
||
$ grpcurl -plaintext -import-path /pathtoprotos -proto helloworld.proto -d '{"name":"apisix"}' 127.0.0.1:9081 helloworld.Greeter.SayHello
|
||
{
|
||
"message": "Hello apisix"
|
||
}
|
||
```
|
||
|
||
This means that the proxying is working.
|
||
|
||
### gRPCS
|
||
|
||
If your gRPC service encrypts with TLS by itself (so called `gPRCS`, gPRC + TLS), you need to change the `scheme` to `grpcs`. The example above runs gRPCS service on port 50052, to proxy gRPC request, we need to use the configuration below:
|
||
|
||
```shell
|
||
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
|
||
{
|
||
"methods": ["POST", "GET"],
|
||
"uri": "/helloworld.Greeter/SayHello",
|
||
"upstream": {
|
||
"scheme": "grpcs",
|
||
"type": "roundrobin",
|
||
"nodes": {
|
||
"127.0.0.1:50052": 1
|
||
}
|
||
}
|
||
}'
|
||
```
|