castbuild/imagingneo4j-v3

CAST Imaging图数据库镜像文档

镜像概述

CAST Imaging图数据库镜像是CAST Imaging平台的核心组件，专为存储和管理应用程序架构的图结构数据设计。该镜像基于图数据库技术优化，提供高效的图数据存储、查询及关系分析能力，作为CAST Imaging平台的数据层，支撑软件架构可视化、依赖关系分析及软件结构洞察等核心功能。

核心功能与特性

核心功能

• 图数据存储：支持节点（如组件、服务、接口）、关系（如依赖、调用、继承）及属性（如名称、类型、版本）的图数据模型，完整记录应用程序架构元素及其关联。
• 高效图查询：优化的图数据库引擎，支持复杂路径遍历、多关系联合查询及深度依赖分析，满足架构可视化场景下的实时数据检索需求。
• CAST Imaging集成：与CAST Imaging平台无缝对接，提供标准化数据接口，支持平台的架构图谱生成、组件依赖展示及变更影响分析。

关键特性

• 数据持久化：支持数据持久化存储，确保容器重启或升级后架构数据不丢失。
• 可配置性能：通过参数调整内存分配、查询缓存及并发连接数，适应不同规模应用的架构数据负载。
• 安全访问：支持基础认证机制，限制数据库访问权限，保护架构数据安全。
• 轻量级部署：容器化设计，简化部署流程，支持与CAST Imaging平台的容器化集群协同部署。

使用场景

• CAST Imaging平台部署：作为平台标配数据组件，为架构可视化功能提供底层数据存储。
• 软件架构分析：存储大型应用的架构图数据，支持开发/运维团队通过CAST Imaging平台分析组件依赖、识别架构债务。
• 应用依赖可视化：辅助展示跨系统、跨模块的调用关系，支持微服务架构或遗留系统的依赖网络梳理。
• 软件结构洞察：通过图数据查询，快速定位架构瓶颈（如过度耦合组件）或合规性问题（如未授权的跨层调用）。

使用方法与配置说明

前提条件

• Docker Engine 19.03+ 环境
• CAST Imaging平台部署包（需与图数据库版本匹配）
• 至少2GB可用内存（推荐4GB以上，根据架构数据量调整）

镜像获取

从CAST官方镜像仓库拉取（需联系CAST获取访问权限）：

bash
docker pull [CAST_REGISTRY]/cast-imaging-graphdb:[VERSION]

注：[CAST_REGISTRY]为CAST官方镜像仓库地址，[VERSION]为具体版本号（如2.0.0）。

基础部署命令

bash
docker run -d \
  --name cast-imaging-graphdb \
  -p 7474:7474 \  # HTTP API端口（用于管理和查询）
  -p 7687:7687 \  # Bolt协议端口（CAST Imaging平台连接端口）
  -e DB_USER=neo4j \  # 数据库访问用户名
  -e DB_PASSWORD=<strong_password> \  # 数据库访问密码（必填，建议强密码）
  -e MAX_HEAP_SIZE=4G \  # JVM最大堆内存（根据数据量调整）
  -e MIN_HEAP_SIZE=2G \  # JVM最小堆内存
  -v /host/path/to/graphdb-data:/data \  # 持久化存储目录（主机路径需提前创建）
  [CAST_REGISTRY]/cast-imaging-graphdb:[VERSION]

环境变量配置

持久化配置

为避免数据丢失，需将容器内数据目录挂载至主机目录：

bash
# 主机提前创建目录
mkdir -p /host/path/to/graphdb-data
# 启动容器时挂载
-v /host/path/to/graphdb-data:/data

网络配置

与CAST Imaging平台协同部署

若图数据库与CAST Imaging平台分离部署，需确保网络互通：

1. 创建自定义网络（如已存在可跳过）：

   bash
   docker network create cast-imaging-network
   

2. 将图数据库加入该网络：

   bash
   docker run -d --name cast-imaging-graphdb --network cast-imaging-network ...
   

3. CAST Imaging平台容器需配置图数据库连接地址（示例）：

   bash
   -e GRAPHDB_URL=bolt://cast-imaging-graphdb:7687 \  # 容器名作为主机名（同一网络内）
   -e GRAPHDB_USER=neo4j \
   -e GRAPHDB_PASSWORD=<strong_password>
   

健康检查

通过Bolt端口或HTTP端口验证数据库状态：

bash
# 检查Bolt端口连通性（需安装neo4j-client）
neo4j-client -u $DB_USER -p $DB_PASSWORD bolt://localhost:7687

# 或通过HTTP API检查
curl -u $DB_USER:$DB_PASSWORD http://localhost:7474/db/data/
# 返回JSON格式的数据库元信息表示正常运行

注意事项

• 密码安全：生产环境中DB_PASSWORD需使用强密码，并通过环境变量注入（避免明文写在启动命令中），推荐使用容器编排工具（如Kubernetes）的密钥管理功能。
• 性能调优：根据架构数据量（节点/关系数量）调整MAX_HEAP_SIZE（建议设置为物理内存的50%），避免内存不足导致查询缓慢或容器崩溃。
• 数据备份：定期备份持久化目录（/host/path/to/graphdb-data），可通过tar命令打包或使用CAST Imaging平台的备份工具。
• 版本兼容性：图数据库版本需与CAST Imaging平台版本严格匹配，版本不兼容可能导致数据接口异常（具体参考CAST Imaging平台版本说明）。
• 资源限制：生产部署时建议通过--memory和--cpus参数限制容器资源，避免影响主机其他服务。