opensourcemano/prometheus

OSM Docker镜像技术文档

1. 镜像概述和主要用途

1.1 概述

本镜像基于ETSI OSM（Open Source MANO）项目构建，封装了OSM核心组件及运行依赖。OSM是一个开源的管理编排（MANO）框架，旨在支持网络功能虚拟化（NFV）环境中的网络服务生命周期管理。

1.2 主要用途

提供OSM组件的容器化部署方式，简化OSM在NFV基础设施中的安装、配置和运维流程，支持快速搭建符合ETSI NFV标准的MANO环境。

2. 核心功能和特性

2.1 核心功能

• 支持NFV MANO架构，涵盖网络服务设计、实例化、监控和终止全生命周期管理
• 兼容ETSI NFV规范，提供标准化的接口（如OS-Ma-nfvo、OS-Vi-nfvo）
• 集成多VIM（Virtualized Infrastructure Manager）适配能力，支持OpenStack、VMware等主流虚拟化平台

2.2 特性

• 容器化部署：基于Docker容器封装，支持跨环境一致性运行
• 模块化设计：包含OSM UI、RO（Resource Orchestrator）、VCA（VNF Configuration Agent）等独立组件
• 开源合规：遵循OSM项目许可证及开源社区规范

3. 使用场景和适用范围

3.1 典型使用场景

• 电信运营商NFV部署：用于管理虚拟化网络功能（VNF）和网络服务（NS）的生命周期
• NFV实验环境搭建：为研究机构、高校提供标准化的MANO测试平台
• 企业级网络虚拟化：支持企业私有云环境中的网络服务编排

3.2 适用范围

• 需部署ETSI NFV MANO框架的场景
• 支持Docker容器化部署的Linux环境（如Ubuntu、CentOS）
• 具备NFV基础设施（计算、存储、网络资源）的环境

4. 使用方法和配置说明

4.1 前提条件

• 已安装Docker Engine（20.10+）及Docker Compose（v2+）
• 满足OSM组件运行的资源要求（参考https://osm.etsi.org/docs/%EF%BC%89

4.2 基础部署（docker run）

说明：具体启动命令需根据目标OSM组件（如UI、RO）调整，以下为通用示例：

bash
# 拉取镜像（示例，实际标签需参考OSM官方仓库）
docker pull docker.xuanyuan.run/osm/osm-[component]:[tag]

# 启动容器（以OSM UI为例，需映射端口并挂载配置文件）
docker run -d \
  --name osm-ui \
  -p 80:80 \
  -v /path/to/local/config:/etc/osm/ui \
  docker.xuanyuan.run/osm/osm-ui:latest

4.3 配置说明

4.3.1 环境变量

OSM组件支持通过环境变量自定义配置，常用参数包括：

• OSM_DB_HOST：数据库服务地址
• OSM_RO_HOST：RO组件通信地址
• LOG_LEVEL：日志级别（DEBUG/INFO/WARN/ERROR）

4.3.2 卷挂载

建议挂载以下目录以持久化数据或自定义配置：

• /var/lib/osm：OSM数据存储目录
• /etc/osm：配置文件目录

4.4 扩展部署（docker-compose）

对于多组件协同部署，推荐使用docker-compose。示例配置（需根据实际组件调整）：

yaml
version: '3'
services:
  osm-ui:
    image: docker.xuanyuan.run/osm/osm-ui:latest
    ports:
      - "80:80"
    environment:
      - OSM_RO_HOST=osm-ro
    depends_on:
      - osm-ro

  osm-ro:
    image: docker.xuanyuan.run/osm/osm-ro:latest
    environment:
      - OSM_DB_HOST=osm-db
    depends_on:
      - osm-db

  osm-db:
    image: docker.xuanyuan.run/postgres:13
    volumes:
      - osm-db-data:/var/lib/postgresql/data

volumes:
  osm-db-data:

5. 许可证信息

5.1 OSM软件许可证

本镜像包含的OSM软件遵循ETSI OSM许可证，详细条款见：https://osm.etsi.org/about/osm-license%E3%80%82

5.2 第三方软件说明

镜像可能包含基础系统组件（如Bash、glibc）及依赖库，其许可证由 respective 上游项目定义。用户需确保对镜像的使用符合所有包含软件的许可证要求。

5.3 合规责任

作为镜像使用者，您有责任确认其使用场景符合所有相关许可证条款。

6. 参考资源

• OSM项目代码仓库：https://osm.etsi.org/gitlab/osm/
• 贡献指南：https://osm.etsi.org/docs/developer-guide/01-workflow-osm-tools.html
• 官方部署文档：https://osm.etsi.org/docs/