https://github.com/ameidance/paster_facade
Paster facade module using KiteX
https://github.com/ameidance/paster_facade
consul go grpc kitex microservice redis rpc
Last synced: about 2 months ago
JSON representation
Paster facade module using KiteX
- Host: GitHub
- URL: https://github.com/ameidance/paster_facade
- Owner: ameidance
- License: mit
- Created: 2021-07-15T18:53:06.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-08-30T14:06:17.000Z (over 2 years ago)
- Last Synced: 2024-06-20T11:29:52.137Z (almost 2 years ago)
- Topics: consul, go, grpc, kitex, microservice, redis, rpc
- Language: Go
- Homepage:
- Size: 138 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# paster_facade
[Paster](https://github.com/ameidance/paster) 服务端门面模块，使用字节跳动开源的微服务 RPC 框架 [KiteX](https://github.com/cloudwego/kitex)
通过 [gRPC](https://github.com/grpc/grpc-go) 协议与下游核心模块 [paster_core](https://github.com/ameidance/paster_core) 通信，
接入 [APISIX](https://github.com/apache/apisix) 作为 API Gateway，实现 gRPC-HTTP 协议转换。
时序图
### 环境 & 运行
> ⚠️ 由于 [KiteX](https://github.com/cloudwego/kitex) 框架依赖网络库 [Netpoll](https://github.com/cloudwego/netpoll) **不支持 Windows**，目前项目只能在 **Linux**, **macOS** 环境下构建。
本服务模块依赖以下组件：
- [Redis](https://github.com/redis/redis)
- [Consul](https://github.com/hashicorp/consul)
首先复制 `conf` 目录下所有 `*.example.yml` 配置文件并重命名为 `*.yml`，之后逐一配置。
- `kitex.yml` 为 KiteX 框架服务启动配置，默认端口号为 5000
- `redis.yml` 为 Redis 连接配置
- `consul.yml` 为 Consul 连接配置
配置完成后在项目根目录下执行以下命令来构建、运行项目。
```bash
sh build.sh
sh output/bootstrap.sh
```
> ⚠️ 请确保在运行项目前已经按照配置信息启动 Redis 和 Consul 服务端。