voltha/bbsim-sadis-server

bbsim-sadis-server 镜像文档

镜像概述

bbsim-sadis-server是一个轻量级Docker镜像，专为BBSIM（Broadband Simulation）网络模拟环境设计，实现了SADIS（Simple Autonomous Device Information Service）协议服务。该镜像提供标准化的设备信息管理接口，支持网络设备在模拟环境中的身份识别、配置数据查询与更新，是构建BBSIM网络测试环境的核心组件之一。

核心功能和特性

• SADIS协议支持：完整实现SADIS规范，支持设备信息的RESTful API查询与管理
• 设备信息管理：提供设备基础信息（如IP地址、MAC地址、设备类型）、配置参数的存储与检索
• 数据持久化：支持通过挂载卷实现设备信息数据的持久化存储，避免容器重启后数据丢失
• 轻量化设计：基于Alpine Linux构建，镜像体积小，启动速度快，资源占用低
• 配置灵活性：支持通过环境变量或配置文件自定义服务端口、日志级别等参数

使用场景和适用范围

• BBSIM网络模拟环境：作为BBSIM的配套服务，为模拟网络中的虚拟设备提供SADIS信息服务
• 网络设备测试：在开发或测试阶段，为网络设备软件提供标准化的SADIS服务依赖
• 教学与研究：用于网络协议教学或SADIS协议相关的研究实验环境搭建
• CI/CD流水线：集成到网络设备软件的自动化测试流程，提供稳定的SADIS服务环境

使用方法和配置说明

基本使用（docker run）

bash
docker run -d \
  --name bbsim-sadis-server \
  -p 8080:8080 \
  -v ./sadis-data:/app/data \
  -e SADIS_PORT=8080 \
  -e LOG_LEVEL=info \
  bbsim-sadis-server:latest

docker-compose配置示例

yaml
version: '3'
services:
  sadis-server:
    image: bbsim-sadis-server:latest
    container_name: bbsim-sadis-server
    ports:
      - "8080:8080"
    volumes:
      - ./sadis-data:/app/data
    environment:
      - SADIS_PORT=8080
      - LOG_LEVEL=info
      - DATA_STORE_PATH=/app/data
    restart: unless-stopped

环境变量说明

核心API接口

服务启动后，可通过以下RESTful API管理设备信息：

• 获取所有设备信息
  GET http://<host>:<port>/sadis/devices

• 获取单个设备信息
  GET http://<host>:<port>/sadis/devices/{device-id}

• 添加/更新设备信息
  POST http://<host>:<port>/sadis/devices
  请求体示例：

  json
  {
    "deviceId": "device-1",
    "ipAddress": "192.168.1.1",
    "macAddress": "aa:bb:cc:dd:ee:ff",
    "deviceType": "router",
    "config": {"enable": true, "priority": 1}
  }
  

• 删除设备信息
  DELETE http://<host>:<port>/sadis/devices/{device-id}

数据持久化

通过挂载宿主机目录到容器内/app/data路径（如示例中的-v ./sadis-data:/app/data），可实现设备信息数据的持久化存储。容器重启后，数据将从挂载目录中恢复。

日志查看

容器日志可通过docker logs bbsim-sadis-server命令查看，日志内容包含服务启动状态、API访问记录及错误信息，便于问题排查。