opensourcemano/pla

ETSI OSM Docker镜像文档

1. 镜像概述和主要用途

1.1 概述

本镜像为ETSI OSM（Open Source MANO）项目的官方Docker封装，包含OSM核心组件，用于网络功能虚拟化（NFV）环境中的管理与编排（MANO）。OSM是符合ETSI NFV标准的开源项目，旨在提供网络服务（NS）和虚拟网络功能（VNF）的全生命周期管理能力。

1.2 主要用途

• 支持NFV基础设施中网络服务的设计、实例化、缩放、更新及终止
• 管理虚拟网络功能（VNF）的部署、配置与监控
• 集成NFV架构中的VIM（虚拟化基础设施管理器）、EMS（元素管理系统）等组件

2. 核心功能和特性

2.1 核心功能

• 服务生命周期管理：网络服务（NS）和VNF的全生命周期编排（创建、激活、修改、终止）
• 模板管理：解析与管理ETSI标准的NSD（网络服务描述符）和VNFD（VNF描述符）
• 资源编排：与VIM交互，动态分配/释放计算、存储及网络资源
• 多维度监控：收集NS/VNF性能指标、状态信息及告警数据

2.2 特性

• 标准化兼容：严格遵循ETSI NFV MANO架构规范（GS NFV 001/002等）
• 容器化部署：基于Docker容器化封装，简化环境一致性与快速部署
• 模块化设计：核心组件（NFVO、VNFM、UI等）解耦，支持独立扩展
• 多租户支持：内置租户隔离机制，适配多租户NFV部署场景

3. 使用场景和适用范围

3.1 使用场景

• 电信运营商NFV部署：5G核心网、边缘计算等网络服务的自动化编排
• 企业网络虚拟化：SDN/NFV环境中虚拟网络功能的生命周期管理
• 云服务商NFaaS：集成云平台提供网络功能即服务（NFaaS）
• NFV开发测试：验证NSD/VNFD模板合规性及VNF生命周期流程

3.2 适用范围

• 环境：开发、测试及生产环境的NFV基础设施
• 用户：电信运营商、云服务商、企业IT团队及NFV解决方案开发者
• 兼容性：需配合符合ETSI标准的VIM（如OpenStack）、NSD/VNFD模板及VNF镜像

4. 使用方法和配置说明

4.1 前提条件

• Docker Engine 19.03+ 或兼容容器运行时（如containerd）
• 网络：容器需访问外部VIM/数据库，建议开放API端口（默认8080）
• 存储：建议挂载外部卷以持久化配置、数据及日志

4.2 镜像获取

通过ETSI官方仓库或Docker Hub拉取（假设镜像名为etsi/osm）：

bash
# 拉取最新版本
docker pull docker.xuanyuan.run/etsi/osm:latest  

# 拉取指定版本（如Release 14）
docker pull docker.xuanyuan.run/etsi/osm:14.0  

4.3 容器部署示例

4.3.1 基础运行命令（docker run）

bash
docker run -d \
  --name osm \
  --restart always \
  -p 8080:8080 \  # API端口映射
  -p 9090:9090 \  # 监控端口映射
  -v /host/osm/config:/etc/osm \  # 配置文件挂载
  -v /host/osm/data:/var/lib/osm \  # 数据持久化
  -v /host/osm/logs:/var/log/osm \  # 日志挂载
  -e OSM_LOG_LEVEL=INFO \  # 日志级别
  -e OSM_VIM_URL=http://openstack-vim:5000 \  # VIM API地址
  -e OSM_DB_HOST=osm-db \  # 数据库主机
  -e OSM_DB_PASSWORD=StrongPassword123 \  # 数据库密码
  etsi/osm:latest  

4.3.2 Docker Compose配置（含数据库）

yaml
version: '3'
services:
  osm:
    image: docker.xuanyuan.run/etsi/osm:latest
    container_name: osm-core
    restart: always
    ports:
      - "8080:8080"
      - "9090:9090"
    volumes:
      - ./osm/config:/etc/osm
      - ./osm/data:/var/lib/osm
      - ./osm/logs:/var/log/osm
    environment:
      - OSM_LOG_LEVEL=INFO
      - OSM_VIM_URL=http://openstack-vim:5000
      - OSM_DB_HOST=osm-db
      - OSM_DB_PORT=5432
      - OSM_DB_USER=osm_user
      - OSM_DB_PASSWORD=StrongPassword123
      - OSM_DB_NAME=osm_db
    depends_on:
      - osm-db

  osm-db:
    image: docker.xuanyuan.run/postgres:13
    container_name: osm-db
    restart: always
    environment:
      - POSTGRES_USER=osm_user
      - POSTGRES_PASSWORD=StrongPassword123
      - POSTGRES_DB=osm_db
    volumes:
      - postgres-data:/var/lib/postgresql/data

volumes:
  postgres-data:

4.4 配置参数说明

4.4.1 环境变量

4.4.2 卷挂载

5. 许可证信息

• OSM核心软件许可证：镜像包含的ETSI OSM软件遵循https://osm.etsi.org/about/osm-license%E3%80%82
• 第三方软件许可证：镜像可能包含基础系统组件（如Bash、libc）及依赖库，其许可证由各自上游项目定义（如Ubuntu基础镜像的MIT许可证、GNU组件的GPL许可证等）。
• 用户责任：使用本镜像时，需确保对所有包含软件的使用符合其许可证要求。

6. 参考链接

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