csm-topology Docker镜像文档

1. 镜像概述和主要用途

1.1 镜像概述

csm-topology是Dell Container Storage Modules (CSM)体系中的核心组件，专注于提供存储阵列平台的拓扑信息。作为CSM for Observability的关键模块，该镜像旨在通过标准化接口输出存储基础设施的拓扑数据，支撑企业级存储环境的可观测性需求。

***资源：

• 完整文档：[***]
• 源代码：[***]

1.2 主要用途

核心功能是采集并暴露所有Dell支持的存储阵列平台的拓扑结构信息，包括设备层级关系、连接路径、资源分布等关键数据，为存储监控、故障排查和性能优化提供基础数据支撑。

2. 核心功能和特性

2.1 核心功能

• 拓扑信息采集：自动发现并采集Dell支持的存储阵列平台（如PowerFlex、PowerMax等）的拓扑结构数据；
• 标准化数据输出：通过统一格式（如JSON/Metrics）暴露拓扑信息，支持与监控平台（如Prometheus、Grafana）集成。

2.2 关键特性

• 多平台支持：兼容Dell主流存储阵列平台（具体支持列表见***文档）；
• 轻量化部署：基于容器化设计，资源占用低，支持Kubernetes或独立Docker环境部署；
• CSM生态集成：与CSM其他模块（如karavi-metrics、karavi-logging）无缝协同，构建端到端存储可观测性体系；
• 动态更新：支持拓扑数据的实时/近实时更新，反映存储环境的动态变化。

2. 使用场景和适用范围

2.1 典型使用场景

• 存储拓扑监控：在企业数据中心中，通过拓扑信息监控存储阵列的物理/逻辑设备层级关系（如控制器、存储池、卷、主机映射等）；
• 故障定位辅助：结合拓扑数据快速定位存储路径故障、资源拥塞等问题的根源；
• 容量规划支持：基于拓扑结构分析存储资源分布，优化容量分配策略；
• 合规审计：输出标准化拓扑报告，满足存储架构合规性检查需求。

2.2 适用范围

• 目标用户：采用Dell存储阵列（如PowerFlex、PowerMax、PowerStore等）且部署了CSM的企业用户；
• 环境要求：运行Docker或Kubernetes的Linux环境，且需具备存储阵列的访问权限（通过API/管理接口）；
• 集成场景：需与CSM for Observability体系中的监控、日志模块联动，或对接第三方可观测性平台（如Prometheus、Datadog）。

3. 使用方法和配置说明

3.1 前提条件

• 已安装Docker Engine（20.10+）或Kubernetes集群（1.21+）；
• 已获取存储阵列的访问凭证（如用户名、密码、API端点）；
• 网络连通性：容器需能访问目标存储阵列的管理接口（如HTTPS端口）及CSM控制平面。

3.2 Docker部署示例

3.2.1 基于docker run部署

bash
docker run -d \
  --name csm-topology \
  --restart=always \
  -e ARRAY_ENDPOINT="https://<storage-array-ip>:443" \  # 存储阵列管理接口地址
  -e ARRAY_USERNAME="<username>" \                      # 阵列访问用户名
  -e ARRAY_PASSWORD="<password>" \                      # 阵列访问密码
  -e LOG_LEVEL="info" \                                 # 日志级别（可选，默认info）
  -p 8080:8080 \                                        # 暴露拓扑数据接口端口
  dellemc/csm-topology:latest                           # 镜像名称及版本（需替换为实际版本）

注意：实际部署时需根据目标阵列类型调整环境变量（如ARRAY_TYPE），完整参数列表见***文档。

3.2.2 基于docker-compose部署

创建docker-compose.yml文件：

yaml
version: "3.8"
services:
  csm-topology:
    image: dellemc/csm-topology:latest
    container_name: csm-topology
    restart: always
    environment:
      - ARRAY_ENDPOINT="https://<storage-array-ip>:443"
      - ARRAY_USERNAME="<username>"
      - ARRAY_PASSWORD="<password>"
      - ARRAY_TYPE="powermax"  # 阵列类型（如powermax/powerflex，根据实际环境填写）
      - LOG_LEVEL="info"
    ports:
      - "8080:8080"
    volumes:
      - ./config:/app/config  # 挂载本地配置文件（如需自定义配置）
    networks:
      - csm-network  # 需提前创建CSM专用网络（如`docker network create csm-network`）

networks:
  csm-network:
    driver: bridge

启动服务：

bash
docker-compose up -d

3.3 配置说明

核心配置通过环境变量或配置文件（如config.yaml）实现，关键参数说明如下（详细参数见***文档）：

3.3 数据访问与验证

部署后，可通过容器暴露的端口访问拓扑数据接口（默认http://<container-ip>:8080/topology），返回JSON格式的拓扑信息，示例：

json
{
  "arrayId": "000123456789",
  "topology": {
    "controllers": [...],
    "storagePools": [...],
    "volumes": [...],
    "hostMappings": [...]
  }
}

4. 支持与反馈

如遇部署或功能问题，可通过CSM支持流程提交反馈：
[]