free5gc/n3iwf

Free5GC Compose

镜像概述和主要用途

Free5GC Compose是基于Docker Compose的free5GC stage 3部署方案，用于简化5G核心网（5GC）的容器化部署与管理。该方案参考了多个开源项目，支持自定义配置，可快速搭建包含各网络功能（NF）的5G核心网环境，适用于5G核心网的测试、开发与教学场景。

核心功能和特性

• 容器化部署：通过Docker Compose编排多个5G核心网网络功能（AMF、SMF、UPF、NRF等），简化部署流程。
• 自定义配置：支持通过config文件夹和docker-compose.yaml文件配置网络功能参数。
• 依赖管理：集成MongoDB数据库存储用户订阅信息，自动处理网络功能间的依赖关系。
• 外部集成：支持与UERANSIM等eNB/UE模拟器集成，实现端到端5G网络测试。
• 灵活部署：提供前台/后台运行模式，支持Vagrant Box选项以规避内核版本限制。

使用场景和适用范围

• 5G核心网功能测试与验证。
• 5G网络架构学习与教学演示。
• 与eNB/UE模拟器联动的端到端通信测试。
• 5G核心网网络功能（NF）交互逻辑研究。

详细使用方法和配置说明

前提条件

GTP5G内核模块

由于UPF功能依赖，主机需使用5.0.0-23-generic内核，并安装gtp5g内核模块。安装步骤如下：

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

Docker环境

• Docker Engine：参考Docker官方安装文档安装适合操作系统的Docker引擎。
• Docker Compose：参考Docker Compose安装文档安装Docker Compose工具。

启动Free5GC

由于需要创建隧道接口，部署需使用具有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()
> exit  # 或按Ctrl+D退出

服务日志查看

使用docker logs命令查看各服务日志，例如查看SMF日志：

bash
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%E9%9B%86%E6%88%90%EF%BC%8C%E8%AF%A6%E7%BB%86%E6%AD%A5%E9%AA%A4%E8%A7%81%E5%AE%98%E6%96%B9%E6%96%87%E6%A1%A3%E3%80%82%E5%85%B3%E4%BA%8EUPF%E8%BD%AC%E5%8F%91UERANSIM%E4%B8%8EDN%EF%BC%88%E5%A6%82%E4%BA%92%E8%81%94%E7%BD%91%EF%BC%89%E6%B5%81%E9%87%8F%E7%9A%84%E9%85%8D%E7%BD%AE%EF%BC%8C%E5%8F%AF%E5%8F%82%E8%80%83https://github.com/free5gc/free5gc-compose/issues/26%E3%80%82

Vagrant Box选项

若主机内核版本不兼容，可使用Vagrant Box快速搭建兼容环境，无需手动升级内核。详见https://github.com/abousselmi/vagrant-free5gc%E3%80%82

NF依赖和端口

参考

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