ganomede/registry

ganomede-registry 镜像文档

镜像概述

ganomede-registry是一个服务注册与代理模块，主要功能包括维护运行中服务列表、定期检查服务健康状态，以及使用"bouncy"工具将请求代理到正确的服务实例。该镜像适用于微服务架构中服务的动态发现与请求路由场景。

核心功能与特性

• 服务列表维护：运行中的服务列表存储在内存中，实时更新服务状态
• 服务发现机制：通过环境变量自动发现服务，识别格式为SERVICE_*_PORT的环境变量
• 健康检查：定期向服务发送HTTP请求检查"/about"端点，验证服务是否正常运行
• 请求代理：使用"bouncy"代理工具，将请求路由到匹配的服务实例

使用场景

• 微服务架构中服务的动态注册与发现
• 服务健康状态监控与自动故障转移
• 统一入口的请求路由与负载分发

使用方法与配置说明

环境变量配置

服务通过环境变量进行发现，需定义格式为SERVICE_*_PORT的环境变量，例如：

• SERVICE_users_1_PORT=8000：表示类型为"users"的服务实例1运行在端口8000
• SERVICE_invitations_2_PORT=8001：表示类型为"invitations"的服务实例2运行在端口8001

端口映射

• 8080：代理端口，接收并路由外部请求到相应服务
• 8000：API端口，提供服务列表查询接口

Docker部署示例

基本运行命令

bash
docker run -d \
  -p 8080:8080 \
  -p 8000:8000 \
  -e SERVICE_users_1_PORT=8000 \
  -e SERVICE_invitations_1_PORT=8000 \
  j3k0/ganomede-registry

健康检查机制

registry会定期执行以下检查流程：

1. 扫描所有匹配SERVICE_*_PORT的环境变量
2. 向每个服务发送HTTP请求访问"/about"端点
3. 期望接收包含以下结构的JSON响应：

json
{
  "type": "服务类型",
  "version": "服务版本",
  "startDate": "启动时间（ISO格式）"
}

4. 验证通过的服务将被添加到可用服务列表

请求代理规则

符合以下格式的请求将被代理到相应服务： /{service-name}/{version}/...

示例：

• 请求/users/v1/login将被代理到类型为"users"、版本为"v1"的服务实例

API参考

GET /registry/v1/services

功能

获取当前所有可用服务的列表

参数

• type（可选）：按服务类型过滤结果（功能待实现）

响应

• 状态码：200 OK
• 响应体：服务列表数组，每个元素包含以下字段：
  • type：服务类型
  • version：服务版本
  • host：服务主机IP地址
  • port：服务端口
  • pingMs：健康检查响应时间（毫秒）

响应示例

json
[
  {
    "type": "users",
    "version": "1.0.1",
    "host": "192.168.1.2",
    "port": 8000,
    "pingMs": 12
  },
  {
    "type": "invitations",
    "version": "1.0.3",
    "host": "192.168.1.4",
    "port": 8000,
    "pingMs": 15
  }
]