k2let

README

k2let项目简介

这是一个自研的项目，基于 go-zero@v1.1.8 的二次开发，它的目标如下：

• 基于protobuf来生成rpc模板，使用gorm来重构model的代码生成模板。
• 支持基于dns的resolver，让其能使用k8s service自带的负载均衡和服务发现能力。
• 去除api模板生成功能，封装apisix的gRPC transcoding功能，作为grpc服务的网关。

主要技术栈和技术难点：

• service name遵循DNS标签的命名规范[RFC 1123]。

apisix gRPC transcoding

HTTP(s)->APISIX->gRPC server

1. 往apisix中添加一个Proto:

$ curl http://127.0.0.1:9080/apisix/admin/proto/:proto_id -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -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;
    }"
}'

1. 启动apisix grpc transcoding插件

$ curl http://127.0.0.1:9080/apisix/admin/routes/111 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/grpctest",
    "plugins": {
        "grpc-transcode": {
            "proto_id": "1",
            "service": "helloworld.Greeter",
            "method": "SayHello"
        }
    },
    "upstream": {
        "scheme": "grpc",
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:50051": 1
        }
    }
}'

Name	Type	Requirement	Default	Valid	Description
proto_id	string/integer	required			.proto content id
service	string	required			the grpc service name
method	string	required			the method name of grpc service
deadline	number	required			deadline for grpc,ms
pb_option	array[string(pb_option_def)]	option			protobuf options

支持如下的pb_option_def:

enum as result: 
	enum_as_name,        enum_as_value
int64 as result: 
	int64_as_number,     int64_as_string,   int64_as_hexstring
default values option: 
	auto_default_values, no_default_values, use_default_values, use_default_metatable
hooks option: 
	enable_hooks,        disable_hooks

1. 测试

$ curl -i http://127.0.0.1:9080/grpctest?name=world
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"}

1. 关闭apisix grpc transcoding插件

$ curl http://127.0.0.1:9080/apisix/admin/routes/111 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "uri": "/grpctest",
    "plugins": {},
    "upstream": {
        "scheme": "grpc",
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:50051": 1
        }
    }
}'