vesoft/nebula-storaged

Nebula Graph Storaged Service 镜像文档

1. 镜像概述和主要用途

Nebula Graph Storaged Service 镜像是 Nebula Graph 图数据库的存储服务组件 Docker 化部署形式。Storaged Service 作为 Nebula Graph 的核心服务之一，负责图数据（顶点和边）的持久化存储、读写操作、数据分片管理及副本同步，是支撑 Nebula Graph 大规模图数据存储能力的底层组件。

该镜像适用于在分布式环境中快速部署 Nebula Graph 存储节点，通过与 Meta Service（元数据服务）和 Graph Service（查询引擎服务）协同工作，提供高可靠、高扩展、低延迟的图数据存储能力，支持数十亿顶点和数万亿边的超大规模图数据场景。

2. 核心功能和特性

2.1 分布式存储架构

• 采用分片（Partition）存储机制，将图数据按哈希或范围分片后分布到多个 Storaged 节点，支持数据均衡分布。
• 对称式分布式设计，无中心节点，各 Storaged 节点地位平等，避免单点瓶颈。

2.2 高可扩展性

• 支持水平扩展，通过新增 Storaged 节点动态扩容存储容量和处理能力，扩展过程不影响服务可用性。
• 自动数据重平衡，节点扩容后分片数据可自动迁移至新节点，均衡负载。

2.3 强数据一致性

• 基于 Raft 共识算法实现副本同步，支持多副本（默认 3 副本）数据存储，确保数据写入一致性和可靠性。
• 支持强一致性读（读取 Leader 副本）和最终一致性读（读取 Follower 副本），满足不同场景需求。

2.4 容错与高可用

• 副本机制保障数据可靠性，单个节点故障时，Raft 自动选举新 Leader 副本，服务无感知恢复。
• 支持节点故障检测和自动恢复，确保数据服务持续可用。

2.5 高效数据操作

• 针对图数据特性优化的存储引擎，支持顶点和边的增、删、改、查操作，毫秒级延迟处理高频读写请求。
• 支持批量数据导入和导出，适配大规模数据迁移场景。

3. 使用场景和适用范围

3.1 适用场景

• 社交网络：存储用户关系、互动行为（如关注、点赞、评论）等图数据，支撑社交推荐、关系分析。
• 推荐系统：存储用户-物品、物品-物品关联关系，支持实时推荐计算和兴趣图谱构建。
• 知识图谱：存储实体（如人物、商品、概念）和关系（如属性、所属、因果），支持复杂关联查询和推理。
• 网络拓扑：存储服务器、交换机、网络设备连接关系，支持网络结构可视化和故障定位。
• ***风控：存储用户征信、交易关系、账户关联网络，支撑实时风控模型和欺诈检测。

3.2 适用范围

• 企业级分布式系统，需管理大规模图结构数据（数十亿顶点/数万亿边）。
• 高并发读写场景，要求毫秒级响应时间。
• 对数据可靠性和一致性有严格要求的在线服务。
• 需要弹性扩展存储能力的动态业务场景。

4. 使用方法和配置说明

4.1 获取镜像

官方 Docker 镜像托管于 Docker Hub，可通过以下命令拉取最新版本（具体版本标签参考 https://hub.docker.com/r/vesoft/nebula-storaged/tags%EF%BC%89%EF%BC%9A

bash
docker pull vesoft/nebula-storaged:latest

4.2 Docker Run 部署

基本命令格式

bash
docker run -d \
  --name=nebula-storaged \
  --network=nebula-net \  # 需提前创建 Nebula 专用网络
  --ip=172.18.0.3 \       # 容器 IP（建议固定，便于其他服务访问）
  -v /path/to/storaged/data:/data/nebula \  # 挂载数据目录（持久化存储）
  -v /path/to/storaged/logs:/logs/nebula \  # 挂载日志目录
  vesoft/nebula-storaged:latest \
  --meta_server_addrs=172.18.0.2:9559 \  # Meta Service 地址（必填，格式：<ip>:<port>）
  --local_ip=172.18.0.3 \                # 本地 IP（与容器 IP 一致）
  --port=9779 \                          # Storaged 服务端口（默认 9779）
  --data_path=/data/nebula \             # 数据存储路径（容器内路径，需与挂载目录对应）
  --log_dir=/logs/nebula                 # 日志输出目录（容器内路径，需与挂载目录对应）

参数说明

4.3 Docker Compose 部署

推荐使用 docker-compose 管理多服务协同部署（包含 Meta Service、Graph Service 和 Storaged Service），以下为简化示例：

yaml
version: '3.8'

services:
  metad:
    image: vesoft/nebula-metad:latest
    container_name: nebula-metad
    network_mode: host
    volumes:
      - ./metad/data:/data/nebula
      - ./metad/logs:/logs/nebula
    command:
      - --meta_server_addrs=127.0.0.1:9559
      - --local_ip=127.0.0.1
      - --port=9559
      - --data_path=/data/nebula
      - --log_dir=/logs/nebula

  storaged:
    image: vesoft/nebula-storaged:latest
    container_name: nebula-storaged
    network_mode: host
    volumes:
      - ./storaged/data:/data/nebula
      - ./storaged/logs:/logs/nebula
    command:
      - --meta_server_addrs=127.0.0.1:9559  # 连接本地 Meta Service
      - --local_ip=127.0.0.1
      - --port=9779
      - --data_path=/data/nebula
      - --log_dir=/logs/nebula
    depends_on:
      - metad

  graphd:
    image: vesoft/nebula-graphd:latest
    container_name: nebula-graphd
    network_mode: host
    volumes:
      - ./graphd/logs:/logs/nebula
    command:
      - --meta_server_addrs=127.0.0.1:9559
      - --local_ip=127.0.0.1
      - --port=9669
      - --log_dir=/logs/nebula
    depends_on:
      - storaged

说明：

• network_mode: host 用于简化本地部署，生产环境建议使用自定义网络并分配固定 IP。
• 需提前创建 metad/data、storaged/data、graphd/logs 等本地目录，确保权限正确。
• 通过 depends_on 控制服务启动顺序，确保 Meta Service 先于 Storaged 和 Graph Service 启动。

4.4 配置文件自定义

Storaged Service 支持通过配置文件自定义参数，配置文件默认路径为 /usr/local/nebula/etc/nebula-storaged.conf（容器内）。可通过挂载本地配置文件覆盖默认配置：

bash
docker run -d \
  --name=nebula-storaged \
  -v /path/to/local/nebula-storaged.conf:/usr/local/nebula/etc/nebula-storaged.conf \  # 挂载自定义配置文件
  -v /path/to/storaged/data:/data/nebula \
  -v /path/to/storaged/logs:/logs/nebula \
  vesoft/nebula-storaged:latest

配置文件示例（关键参数）：

conf
# 元数据服务地址
meta_server_addrs=172.18.0.2:9559,172.18.0.3:9559,172.18.0.4:9559
# 本地 IP 地址
local_ip=172.18.0.5
# 服务端口
port=9779
# 数据存储路径
data_path=/data/nebula
# 日志目录
log_dir=/logs/nebula
# 分片副本数
replica_factor=3
# Raft 选举超时时间（毫秒）
raft_election_timeout_ms=2000

5. 许可协议

Nebula Graph Storaged Service 镜像基于 Apache License 2.0 许可协议开源。为防止云服务提供商未经贡献而商业化该项目，额外添加了 Commons Clause 1.0 条款。详细许可说明参见 https://github.com/vesoft-inc/nebula%E3%80%82

6. 联系方式

• Bug 反馈与功能请求：通过 https://github.com/vesoft-inc/nebula/issues 提交。
• 社区交流：加入 Nebula Slack 社区 参与讨论。