digiserve/ab-definition-manager

ab_service_definition_manager 镜像文档

镜像概述与主要用途

基本信息

• 镜像名称：ab_service_definition_manager
• 所属项目：AppBuilder 平台

核心用途

ab_service_definition_manager 是 AppBuilder 平台的核心服务组件，主要用于管理运行中 AppBuilder 平台的各类定义信息（如应用配置、模块定义、流程规则等），支持定义的创建、更新、存储、检索及版本控制，确保 AppBuilder 平台在运行时能够准确加载和应用最新定义。

核心功能与特性

核心功能

• 定义全生命周期管理：支持 AppBuilder 平台所需定义信息的创建、读取、更新、删除（CRUD）操作，覆盖定义从设计到退役的完整生命周期。
• 平台集成支持：与 AppBuilder 平台其他组件（如执行引擎、前端控制台）无缝集成，提供标准化 API 接口供平台内部调用。
• 持久化存储：支持将定义数据持久化至指定存储介质（如数据库、分布式存储），确保定义信息的可靠性与可恢复性。

主要特性

• 轻量高效：镜像体积精简，运行时资源占用低，适合在各类环境（开发、测试、生产）中部署。
• 平台原生集成：针对 AppBuilder 平台架构设计，无需额外适配即可直接接入平台生态。
• 可扩展性：支持通过配置扩展定义存储类型或集成第三方配置管理工具（如etcd、Consul）。

使用场景与适用范围

典型使用场景

1. AppBuilder 平台部署：作为平台基础服务组件，随 AppBuilder 平台一同部署，提供定义管理能力。
2. 运行时定义管理：在平台运行过程中，动态接收并应用新的定义配置（如更新应用模块规则、调整流程参数）。
3. 多环境定义同步：在开发、测试、生产等多环境间同步定义信息，确保跨环境配置一致性。

适用范围

• 用户：使用 AppBuilder 平台进行应用开发、部署或运维的团队。
• 环境：与 AppBuilder 平台兼容的各类环境（物理机、虚拟机、容器集群如 Kubernetes）。

详细使用方法与配置说明

前置条件

• 已安装 Docker 或 Docker Compose（版本 19.03+）。
• 已部署 AppBuilder 平台基础环境（如依赖的数据库、API 网关等，具体依赖需根据 AppBuilder 平台版本确认）。

环境变量说明

以下为运行该服务常用的环境变量（具体变量可能因版本调整，建议参考 AppBuilder 平台官方文档）：

Docker 运行命令示例

通过 docker run 直接启动服务：

bash
docker run -d \
  --name ab-definition-manager \
  -p 8081:8081 \
  -e APPBUILDER_API_URL="http://appbuilder-core:8080" \
  -e DB_CONNECTION="postgresql://user:pass@db:5432/def_db" \
  -e PORT=8081 \
  -e LOG_LEVEL=INFO \
  ab_service_definition_manager:latest

Docker Compose 配置示例

在 AppBuilder 平台部署架构中，可通过 docker-compose.yml 集成该服务：

yaml
version: '3.8'

services:
  ab-definition-manager:
    image: ab_service_definition_manager:latest
    container_name: ab-definition-manager
    ports:
      - "8081:8081"
    environment:
      - APPBUILDER_API_URL=http://appbuilder-core:8080
      - DB_CONNECTION=postgresql://user:pass@db:5432/def_db
      - PORT=8081
      - LOG_LEVEL=INFO
    depends_on:
      - appbuilder-core  # 依赖 AppBuilder 核心服务
      - db               # 依赖数据库服务
    restart: unless-stopped

使用步骤

1. 拉取镜像：从指定镜像仓库拉取最新版本（或指定版本）镜像：

   bash
   docker pull ab_service_definition_manager:latest
   

2. 配置环境变量：根据实际部署环境，准备并配置必要的环境变量（如数据库连接、API 地址等）。

3. 启动服务：通过 docker run 或 docker-compose up -d 启动服务。

4. 验证服务状态：检查服务日志或访问健康检查接口（如 http://localhost:8081/health）确认服务正常运行。

注意事项

• 环境变量 APPBUILDER_API_URL 和 DB_CONNECTION 为核心配置，需确保指向可用的 AppBuilder 核心服务与数据库实例。
• 该服务需与 AppBuilder 平台其他组件（如核心引擎、数据库）协同工作，部署时需注意组件版本兼容性。
• 生产环境中建议通过 Docker 网络隔离、数据卷挂载（持久化配置/日志）等方式增强安全性与可维护性。