redpointgames/configstore

configstore

configstore是一个Go语言编写的服务器，允许你通过JSON定义数据实体的schema，自动生成包含List/Get/Create/Update/Delete方法的gRPC API，用于访问和修改Google Cloud Firestore中的这些实体。

本质上，configstore提供了一个gRPC CRUD接口，针对你描述的实体类型。你只需用JSON指定实体类型的schema，configstore就会生成一个.proto文件，可用于生成多种语言的客户端。

configstore完全无状态，所有数据都存储在Google Cloud Firestore上。这使得它更容易以高可用的配置运行，无需自行管理状态。

核心功能

1. 基于JSON schema自动生成gRPC CRUD接口
2. 无状态设计，依赖Google Cloud Firestore存储数据
3. 支持通过生成的.proto文件创建多语言客户端

使用场景

适用于需要快速构建基于Firestore的CRUD服务的开发场景，尤其适合原型开发（注意：该镜像处于早期原型阶段，暂不适合生产环境使用）。

配置说明

运行镜像需配置以下环境变量和挂载文件：

• 环境变量：
  • CONFIGSTORE_GOOGLE_CLOUD_PROJECT_ID：Google Cloud项目ID
  • CONFIGSTORE_GRPC_PORT：gRPC服务端口
  • CONFIGSTORE_HTTP_PORT：HTTP服务端口
  • CONFIGSTORE_SCHEMA_PATH：schema文件在容器内的路径
  • GOOGLE_APPLICATION_CREDENTIALS：Google服务账号密钥文件在容器内的路径
• 挂载文件：
  • schema.json：数据实体的schema定义文件
  • 服务账号密钥文件（如adc.json）：用于访问Google Cloud Firestore的凭证

部署示例

构建镜像

bash
docker build . --tag=configstore

运行容器

bash
docker run --rm -p 13389:13389 -p 13390:13390 \
  -v your_schema.json:/schema.json \
  -e CONFIGSTORE_GOOGLE_CLOUD_PROJECT_ID="your-cloud-project" \
  -e CONFIGSTORE_GRPC_PORT=13389 \
  -e CONFIGSTORE_HTTP_PORT=13390 \
  -e CONFIGSTORE_SCHEMA_PATH="/schema.json" \
  -v your_service_account.json:/adc.json \
  -e GOOGLE_APPLICATION_CREDENTIALS=/adc.json \
  --name=configstore docker.xuanyuan.run/configstore

截图

!https://github.com/hach-que/configstore/raw/master/screenshots/server.PNG !https://github.com/hach-que/configstore/raw/master/screenshots/client.PNG

许可证

MIT License

Copyright (c) 2019 June Rhodes

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.