grpc proxy support

.travis/linux_runner.sh

@@ -23,23 +23,39 @@ before_install() {
 
 do_install() {
     wget -qO - https://openresty.org/package/pubkey.gpg | sudo apt-key add -
+    sudo apt-get -y update --fix-missing
     sudo apt-get -y install software-properties-common
     sudo add-apt-repository -y "deb http://openresty.org/package/ubuntu $(lsb_release -sc) main"
     sudo apt-get update
     sudo apt-get install openresty-debug
 
+    sudo add-apt-repository -y ppa:longsleep/golang-backports
+    sudo apt-get update
+    sudo apt-get install golang
+
+    export GO111MOUDULE=on
+
     export_or_prefix
 
     sudo luarocks make --lua-dir=${OPENRESTY_PREFIX}luajit rockspec/apisix-dev-1.0-0.rockspec --tree=deps --only-deps --local
     sudo luarocks install --lua-dir=${OPENRESTY_PREFIX}luajit lua-resty-libr3 --tree=deps --local
 
-    git clone https://github.com/openresty/test-nginx.git test-nginx
+    git clone https://github.com/membphis/test-nginx.git test-nginx
+
+    git clone https://github.com/nic-chen/grpc_server_example.git grpc_server_example
+
+    cd grpc_server_example/
+    go build -o grpc_server_example main.go
+    cd ..
 }
 
 script() {
     export_or_prefix
     export PATH=$OPENRESTY_PREFIX/nginx/sbin:$OPENRESTY_PREFIX/luajit/bin:$OPENRESTY_PREFIX/bin:$PATH
     sudo service etcd start
+
+    ./grpc_server_example/grpc_server_example &
+
     ./bin/apisix help
     ./bin/apisix init
     ./bin/apisix init_etcd

.travis/osx_runner.sh

@@ -18,6 +18,8 @@ export_or_prefix() {
 
 before_install() {
     HOMEBREW_NO_AUTO_UPDATE=1 brew install perl cpanminus etcd luarocks openresty/brew/openresty-debug
+    brew upgrade go
+    export GO111MOUDULE=on
     sudo cpanm --notest Test::Nginx >build.log 2>&1 || (cat build.log && exit 1)
     export_or_prefix
     luarocks install --lua-dir=${OPENRESTY_PREFIX}/luajit luacov-coveralls --local --tree=deps
@@ -29,7 +31,12 @@ do_install() {
     make dev
     make dev_r3
 
-    git clone https://github.com/openresty/test-nginx.git test-nginx
+    git clone https://github.com/membphis/test-nginx.git test-nginx
+    git clone https://github.com/nic-chen/grpc_server_example.git grpc_server_example
+
+    cd grpc_server_example/
+    go build -o grpc_server_example main.go
+    cd ..
 }
 
 script() {
@@ -38,6 +45,9 @@ script() {
 
     luarocks install luacheck
     brew services start etcd
+
+    ./grpc_server_example/grpc_server_example &
+
     make help
     make init
     sudo make run

COPYRIGHT

@@ -307,3 +307,58 @@ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 %%%%%%%%%
+
+lua-resty-grpc-gateway
+https://github.com/ysugimoto/lua-resty-grpc-gateway
+
+MIT License
+
+Copyright (c) 2019 Yoshiaki Sugimoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+%%%%%%%%%
+
+lua-protobuf
+https://github.com/starwing/lua-protobuf
+
+MIT License
+
+Copyright (c) 2019 Yoshiaki Sugimoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+

Makefile

@@ -52,7 +52,8 @@ check:
 		lua/apisix/admin/*.lua \
 		lua/apisix/core/*.lua \
 		lua/apisix/http/*.lua \
-		lua/apisix/plugins/*.lua > \
+		lua/apisix/plugins/*.lua \
+		lua/apisix/plugins/grpc-proxy/*.lua > \
 		/tmp/check.log 2>&1 || (cat /tmp/check.log && exit 1)
 
 

README.md

@@ -44,6 +44,7 @@ For more detailed information, see the [White Paper](https://www.iresty.com/down
 - **[Limit-concurrency](doc/plugins/limit-conn.md)**
 - **OpenTracing: [Zipkin](doc/plugins/zipkin.md)**
 - **Monitoring and Metrics**: [Prometheus](doc/plugins/prometheus.md)
+- **[gRPC-Proxy](doc/plugins/grpc-proxy.md)**：REST <-> gRPC proxying.
 - **Custom plugins**: Allows hooking of common phases, such as `rewrite`, `access`, `header filer`, `body filter` and `log`, also allows to hook the `balancer` stage.
 - **Dashboard**: Built-in dashboard to control APISIX.
 - **CLI**: start\stop\reload APISIX through the command line.

README_CN.md

@@ -41,6 +41,7 @@ APISIX 通过插件机制，提供动态负载平衡、身份验证、限流限
 - **[限制并发](doc/plugins/limit-conn-cn.md)**
 - **OpenTracing: [Zipkin](doc/plugins/zipkin.md)**
 - **监控和指标**: [Prometheus](doc/plugins/prometheus-cn.md)
+- **[gRPC-Proxy](doc/plugins/grpc-proxy-cn.md)**：REST <-> gRPC proxying.
 - **自定义插件**: 允许挂载常见阶段，例如`rewrite`，`access`，`header filer`，`body filter`和`log`，还允许挂载 `balancer` 阶段。
 - **控制台**: 内置控制台来操作 APISIX 集群。
 - **CLI**: 使用命令行来启动、关闭和重启 APISIX。

bin/apisix

@@ -128,7 +128,7 @@ http {
             apisix.http_balancer_phase()
         }
 
-        keepalive 32;
+        keepalive 320;
     }
 
     init_by_lua_block {
@@ -231,6 +231,33 @@ http {
                 apisix.http_header_filter_phase()
             }
 
+            body_filter_by_lua_block {
+                apisix.http_body_filter_phase()
+            }
+
+            log_by_lua_block {
+                apisix.http_log_phase()
+            }
+        }
+
+        location @grpc_pass {
+
+            access_by_lua_block {
+                apisix.grpc_access_phase()
+            }
+
+            grpc_set_header   Content-Type application/grpc;
+            grpc_socket_keepalive on;
+            grpc_pass         grpc://apisix_backend;
+
+            header_filter_by_lua_block {
+                apisix.http_header_filter_phase()
+            }
+
+            body_filter_by_lua_block {
+                apisix.http_body_filter_phase()
+            }
+
             log_by_lua_block {
                 apisix.http_log_phase()
             }

conf/config.yaml

@@ -35,3 +35,4 @@ plugins:                          # plugin list
   - jwt-auth
   - zipkin
   - ip-restriction
+  - grpc-proxy

conf/nginx.conf

@@ -62,7 +62,7 @@ http {
             apisix.http_balancer_phase()
         }
 
-        keepalive 32;
+        keepalive 320;
     }
 
     init_by_lua_block {
@@ -141,9 +141,37 @@ http {
                 apisix.http_header_filter_phase()
             }
 
+            body_filter_by_lua_block {
+                apisix.http_body_filter_phase()
+            }
+
             log_by_lua_block {
                 apisix.http_log_phase()
             }
         }
+
+        location @grpc_pass {
+
+            access_by_lua_block {
+                apisix.grpc_access_phase()
+            }
+
+            grpc_set_header   Content-Type application/grpc;
+            grpc_socket_keepalive on;
+            grpc_pass         grpc://apisix_backend;
+
+            header_filter_by_lua_block {
+                apisix.http_header_filter_phase()
+            }
+
+            body_filter_by_lua_block {
+                apisix.http_body_filter_phase()
+            }
+
+            log_by_lua_block {
+                apisix.http_log_phase()
+            }
+        }
+
     }
 }

doc/plugins/grpc-proxy-cn.md

@@ -0,0 +1,90 @@
+[English](grpc-proxy.md)
+# grpc-proxy
+
+HTTP(s) -> APISIX -> gRPC server
+
+### Proto
+
+#### 参数
+* `content`: `.proto` 文件的内容
+
+#### 添加proto
+
+路径中最后的数字，会被用作 proto 的 id 做唯一标识，比如下面示例的 proto `id` 是 `1` ：
+
+```shell
+curl http://127.0.0.1:9080/apisix/admin/proto/1 -X PUT -d '
+{
+ "content" : "syntax = \"proto3\";
+   package helloworld;
+   service Greeter {
+       rpc SayHello (HelloRequest) returns (HelloReply) {}
+   }
+   message HelloRequest {
+       string name = 1;
+   }
+   message HelloReply {
+       string message = 1;
+      }"
+}'
+```
+
+### 参数
+
+* `proto_id`: `.proto`内容的id.
+* `service`:  grpc服务名.
+* `method`:   grpc服务中要调用的方法名.
+
+
+
+### 示例
+
+#### 使用 grpc-proxy 插件
+
+在指定 route 中，代理 grpc 服务接口:
+
+* 注意： 这个 route 的属性`service_protocal` 必须设置为 `grpc`
+* 例子所代理的 grpc 服务可参考：[grpc_server_example](https://github.com/nic-chen/grpc_server_example)
+
+```shell
+curl http://127.0.0.1:9080/apisix/admin/routes/111 -X PUT -d '
+{
+    "methods": ["GET"],
+    "uri": "/grpctest",
+    "service_protocol": "grpc",
+    "plugins": {
+        "grpc-proxy": {
+         "proto_id": "1",
+         "service": "helloworld.Greeter",
+         "method": "SayHello"
+        }
+    },
+    "upstream": {
+        "type": "roundrobin",
+        "nodes": {
+            "127.0.0.1:50051": 1
+        }
+    }
+}'
+```
+
+
+#### 测试
+
+访问上面配置的 route：
+
+```shell
+$ curl -i http://127.0.0.1:9080/grpctest
+HTTP/1.1 200 OK
+Date: Fri, 16 Aug 2019 11:55:36 GMT
+Content-Type: application/json
+Transfer-Encoding: chunked
+Connection: keep-alive
+Server: APISIX web server
+Proxy-Connection: keep-alive
+
+{"message":"Hello world"}
+```
+
+这表示已成功代理。
+