flsi/registry

Registry服务

项目地址

通过HTTP REST提供服务注册功能。

镜像概述和主要用途

该镜像提供服务注册功能，允许通过HTTP REST API管理网络中的服务。支持服务的注册、更新、删除以及网络扫描发现，适用于需要集中管理服务信息的场景。

核心功能和特性

• 通过HTTP REST API提供服务注册管理
• 支持服务添加、更新、删除操作
• 可配置网络扫描功能，自动发现服务
• 基于MAC地址唯一标识服务
• 支持自定义服务属性（props）

安装与部署

前提条件

• 已安装Docker环境
• 如需网络扫描，确保容器具有相应网络访问权限

安装步骤

1. 移除旧容器（如存在）

   bash
   docker rm -f registry
   

2. 拉取最新镜像

   bash
   docker pull flsi/registry:latest
   

3. 创建网络（如不存在）

   bash
   docker network create controls
   

4. 启动容器

   bash
   docker run --name=registry \
     --network=controls \
     --log-opt max-size=10m \
     -e SUBNETS="172.28.1.0" \  # 要扫描的网络子网，多个子网用逗号分隔
     -e SCAN_INTERVAL=0 \       # 自动扫描间隔（秒），0表示禁用自动扫描
     --restart=unless-stopped \
     -it \
     -p 8510:8510 \             # 映射端口
     -v /var/run/docker.sock:/var/run/docker.sock \  # 挂载Docker socket（如需要）
     -d flsi/registry:latest
   

API接口说明

获取注册服务列表

• 端点：<host>/registry
• 方法：GET
• 描述：返回已注册服务的JSON数组
• 响应示例：

  json
  [
    {
      "ip4": "192.168.1.100",
      "mac": "aa:bb:cc:dd:ee:ff",
      "servname": "SampleService",
      "servtype": "FDP",
      "props": {
        "port": 8080,
        "status": "active"
      }
    }
  ]
  

添加服务

• 端点：<host>/rest/service/add
• 方法：POST
• 描述：注册新服务，MAC地址必须唯一
• 请求体示例：

  json
  {
    "ip4": "192.168.1.101",
    "mac": "aa:bb:cc:dd:ee:01",
    "servname": "NewService",
    "servtype": "Custom",
    "props": {
      "version": "1.0.0"
    }
  }
  

更新服务

• 端点：<host>/rest/service/update
• 方法：POST
• 描述：通过MAC地址更新已注册服务，将替换原有服务信息
• 请求体示例：（同添加服务，需包含目标MAC地址）

删除服务

• 端点：<host>/rest/service/remove
• 方法：POST
• 描述：通过MAC地址删除已注册服务
• 请求体示例：（同添加服务，需包含目标MAC地址）

网络扫描

• 端点：<host>/scan
• 方法：POST
• 描述：扫描指定子网以发现已知服务并添加到注册列表

支持的服务类型

• FDP
• 任何实现Service API的服务（待定义）