opensourcemano/ng-ui

OSM Docker镜像技术文档

1. 镜像概述和主要用途

1.1 概述

本镜像是ETSI（欧洲电信标准协会）开源管理与编排项目（OSM, Open Source MANO）的官方Docker镜像。OSM是一套符合ETSI NFV（网络功能虚拟化）规范的开源管理和编排框架，旨在简化网络服务的设计、部署、监控及全生命周期管理。

1.2 主要用途

• 提供NFV环境下的网络服务管理与编排能力
• 支持网络功能虚拟化基础设施（NFVI）的资源调度与监控
• 实现网络服务（NS）和虚拟网络功能（VNF）的模板化定义与部署
• 作为NFV生态系统中的核心MANO（管理与编排）组件，对接底层虚拟化平台（如OpenStack、Kubernetes）

2. 核心功能和特性

• 符合ETSI MANO规范：严格遵循ETSI GS NFV-MAN 001等标准，确保与NFV生态系统兼容性。
• 开源可扩展：基于Apache License 2.0开源协议，支持社区贡献和功能定制，适应多样化场景需求。
• 全生命周期管理：覆盖网络服务从设计、实例化、升级到终止的完整生命周期。
• 多租户隔离：支持多租户架构，满足不同组织或部门的独立资源与服务管理需求。
• 模板化部署：通过TOSCA等标准化模板语言定义网络服务，简化部署流程并提升一致性。
• 跨平台集成：兼容主流NFVI（如OpenStack、Kubernetes）及SDN控制器，具备良好的互操作性。

3. 使用场景和适用范围

3.1 典型使用场景

• 电信运营商NFV部署：管理电信网络中的虚拟化网络功能（如vEPC、vCPE、vFW等）。
• 企业网络虚拟化：支持企业构建私有NFV环境，实现网络服务的灵活部署与动态调整。
• NFV开发与测试：为开发者提供标准化MANO平台，加速NFV相关应用的开发、测试与验证。
• 学术研究与教育：作为NFV/MANO技术的研究载体，支持相关技术的教学、实验与创新。

3.2 适用范围

• 电信运营商、云服务提供商、大型企业等需构建或管理NFV基础设施的组织。
• 从事NFV技术研发、测试或标准化工作的团队及个人。
• 需符合ETSI MANO规范的网络服务编排与管理场景。

4. 使用方法和配置说明

4.1 前提条件

• 已安装Docker Engine（建议版本20.10+）及Docker Compose（如采用多容器部署）。
• 系统资源满足OSM运行要求（具体请参考OSM官方文档）。

4.2 镜像获取

通过ETSI OSM官方容器仓库获取镜像，具体命令及版本标签请参考OSM官方部署指南。

4.3 部署示例

4.3.1 单容器快速启动（基础示例）

bash
docker run -d --name osm-core \
  --network host \
  etsi/osm:<tag>

说明：

• <tag>需替换为具体版本标签（如release-14）。
• --network host为示例网络配置，实际部署需根据环境调整（如自定义桥接网络）。
• 详细参数请参考OSM官方部署文档。

4.3.2 多容器部署（Docker Compose示例）

OSM通常采用多容器架构（含核心服务、数据库、UI等组件），建议通过Docker Compose部署。完整配置文件可从OSM代码库获取，以下为简化示例：

yaml
version: '3'
services:
  osm-db:
    image: etsi/osm-db:<tag>
    volumes:
      - osm-db-data:/var/lib/postgresql/data
    environment:
      - POSTGRES_PASSWORD=osm4u
      - POSTGRES_USER=osm

  osm-core:
    image: etsi/osm-core:<tag>
    depends_on:
      - osm-db
    environment:
      - DB_HOST=osm-db
      - DB_USER=osm
      - DB_PASSWORD=osm4u
    ports:
      - "8080:8080"  # API端口

volumes:
  osm-db-data:

注：以上为简化示例，完整部署需包含UI、RO（资源 orchestrator）、VCA（VNF配置代理）等组件，具体请参考OSM官方提供的docker-compose.yml。

4.4 配置说明

• 环境变量：主要用于数据库连接、日志级别、网络配置等，具体参数请参见OSM配置指南。
• 数据持久化：通过Docker卷（Volume）挂载数据库数据目录（如示例中的osm-db-data），避免容器重启导致数据丢失。
• 网络配置：根据实际需求配置端口映射（-p）或自定义网络，确保组件间通信及外部访问。

5. 许可证信息

5.1 OSM软件许可证

本镜像包含的OSM核心软件采用Apache License 2.0许可，详细条款参见OSM官方许可证页面。

5.2 第三方软件许可证

本镜像基于Linux发行版构建，可能包含其他开源软件（如Bash、PostgreSQL、Python等），这些软件的许可证由各自版权持有者确定。用户可通过镜像内文档或软件官方渠道获取详细许可信息。

5.3 使用合规责任

使用本镜像前，用户必须确保对镜像中所有软件的使用符合其各自的许可证要求。对于预构建镜像的使用，镜像用户对合规性验证负有全部责任。

6. 贡献与支持

6.1 项目资源

• 代码仓库：OSM GitLab
• 贡献指南：OSM开发者工作流
• 官方文档：OSM文档中心

6.2 支持渠道

技术支持及问题反馈请通过OSM社区论坛或项目Issue系统（GitLab Issues）提交。