free5gc/nssf

free5GC Compose

镜像概述和主要用途

free5GC Compose是free5GC stage 3的Docker Compose版本，用于简化5G核心网络（5GC）的部署流程。该方案基于Docker容器技术，通过Compose编排实现各网络功能（NF）的容器化部署，支持自定义配置，适用于5G核心网的开发、测试与教学场景。其设计参考了多个开源项目，旨在提供便捷、可复现的5G核心网部署环境。

核心功能和特性

• 完整NF支持：包含AMF、AUSF、NRF、NSSF、PCF、SMF、UDM、UDR、UPF等5G核心网关键网络功能
• Docker Compose编排：通过Docker Compose实现多NF容器的协同部署与依赖管理
• 灵活配置：支持通过config目录和docker-compose.yaml自定义网络功能参数
• 集成数据库：内置MongoDB存储用户订阅数据，支持数据清理与管理
• 日志与故障排查：提供容器日志查看工具，支持数据库数据重置等故障处理操作

使用场景和适用范围

• 5G核心网功能开发与测试环境搭建
• 5G网络教学与培训实践
• 5G核心网与eNB/UE模拟器（如UERANSIM）的集成测试
• 快速验证5G核心网功能与性能的实验场景

详细使用方法和配置说明

前提条件

GTP5G内核模块

由于UPF（用户面功能）限制，主机需使用5.0.0-23-generic内核，并安装gtp5g内核模块。主机端安装步骤：

bash
git clone https://github.com/PrinzOwO/gtp5g.git
cd gtp5g
make
sudo make install

Docker环境

• Engine：参考Docker Engine安装文档安装Docker引擎
• Compose：参考Docker Compose安装文档安装Docker Compose

部署步骤

由于需要创建隧道接口，需使用具有root权限的特权容器。部署命令如下：

bash
# 克隆仓库
git clone https://github.com/free5gc/free5gc-compose.git
cd free5gc-compose

# 构建基础镜像和服务镜像
make base
docker-compose build

# 启动服务（推荐使用tmux前台运行）
sudo docker-compose up

# 如需后台运行
sudo docker-compose up -d

故障排除

数据库数据清理

当需要重置用户订阅数据时，可执行以下命令清理MongoDB数据：

bash
# 进入MongoDB容器
docker exec -it mongodb mongo
# 切换到free5gc数据库
> use free5gc
# 删除订阅者集合
> db.subscribers.drop()
# 退出（或按Ctrl-D）
> exit

日志查看

使用docker logs命令查看各服务日志，例如查看SMF（会话管理功能）日志：

console
docker logs smf

更多故障排查信息请参考https://github.com/free5gc/free5gc/wiki%E3%80%82

与外部eNB/UE模拟器集成

• 与https://github.com/aligungr/UERANSIM%EF%BC%88eNB/UE%E6%A8%A1%E6%8B%9F%E5%99%A8%EF%BC%89%E7%9A%84%E9%9B%86%E6%88%90%E6%96%B9%E6%B3%95%E5%8F%82%E8%A7%81%E5%AE%98%E6%96%B9%E6%96%87%E6%A1%A3
• 配置UPF实现UERANSIM与数据网络（如互联网）之间流量转发的方法可参考https://github.com/free5gc/free5gc-compose/issues/26

Vagrant环境选项

若需避免主机内核版本限制，可使用Vagrant Box快速搭建环境，详情参见：https://github.com/abousselmi/vagrant-free5gc

网络功能(NF)依赖和端口

参考

• https://github.com/open5gs/nextepc/tree/master/docker
• https://github.com/abousselmi/docker-free5gc