OpenAirInterface 5G Core Network Deployment : Pulling Container Images¶
This page is only valid for a Ubuntu host.¶
If you are using any other distributions, please refer to Build your own images.
If you want to use a specific branch or commit, please refer to Build your own images.
Pulling the images from Docker Hub¶
The images are hosted under the oai account oaisoftwarealliance.
All images that are currently pushed to Docker-Hub have an Ubuntu-22.04 base image.
But they should be working on any recent Ubuntu host (such as 20.04) or newer versions (`23.xx1).
Once again you may need to log on docker-hub if your organization has the reached pulling limit as anonymous.
$ docker login
Login with your Docker ID to push and pull images from Docker Hub. If you don't have a Docker ID, head over to https://hub.docker.com to create one.
Username:
Password:
The OAI CI/CD team has automated more frequent pushes to Docker-Hub on oaisoftwarealliance account. Two important things to be noted:
- We will keep pushing to the latest tag when a milestone is reached. Currently, the latest tag corresponds to v1.5.0 release.
- We are making pushes on the develop tag whenever a contribution has been accepted. These images are EXPERIMENTAL.
- Release tag vx.x.x contains the release code
Now pull images according to your requirement,
#!/bin/bash
docker pull oaisoftwarealliance/oai-amf:v2.1.0
docker pull oaisoftwarealliance/oai-nrf:v2.1.0
docker pull oaisoftwarealliance/oai-upf:v2.1.0
docker pull oaisoftwarealliance/oai-smf:v2.1.0
docker pull oaisoftwarealliance/oai-udr:v2.1.0
docker pull oaisoftwarealliance/oai-udm:v2.1.0
docker pull oaisoftwarealliance/oai-ausf:v2.1.0
docker pull oaisoftwarealliance/oai-upf-vpp:v2.1.0
docker pull oaisoftwarealliance/oai-nssf:v2.1.0
docker pull oaisoftwarealliance/oai-pcf:v2.1.0
docker pull oaisoftwarealliance/oai-lmf:v2.1.0
# Utility image to generate traffic
docker pull oaisoftwarealliance/trf-gen-cn5g:latest
Finally you may logoff –> your token is stored in plain text..
$ docker logout
We will push new versions when new features are validated.
Synchronizing the tutorials¶
CAUTION: PLEASE READ THIS SECTION VERY CAREFULLY!
This repository only has tutorials and Continuous Integration scripts.
At the time of writing (2024/08), the release tag is v2.1.0.
| CNF Name | Branch Name | Tag | Ubuntu 22.04 | RHEL9 (UBI9) |
|---|---|---|---|---|
| FED REPO | N/A | v2.1.0 |
||
| AMF | master |
v2.1.0 |
X | X |
| SMF | master |
v2.1.0 |
X | X |
| NRF | master |
v2.1.0 |
X | X |
| UPF | master |
v2.1.0 |
X | X |
| UDR | master |
v2.1.0 |
X | X |
| UDM | master |
v2.1.0 |
X | X |
| AUSF | master |
v2.1.0 |
X | X |
| UPF-VPP | master |
v2.1.0 |
X | X |
| NSSF | master |
v2.1.0 |
X | X |
| LMF | master |
v2.1.0 |
X | X |
| PCF | master |
v2.1.0 |
X | X |
# Clone directly on the latest release tag
$ git clone --branch v2.1.0 https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-fed.git
$ cd oai-cn5g-fed
# If you forgot to clone directly to the latest release tag
$ git checkout -f v2.1.0
# Synchronize all git submodules
$ ./scripts/syncComponents.sh
---------------------------------------------------------
OAI-NRF component branch : master
OAI-AMF component branch : master
OAI-SMF component branch : master
OAI-UPF component branch : master
OAI-AUSF component branch : master
OAI-UDM component branch : master
OAI-UDR component branch : master
OAI-UPF-VPP component branch : master
OAI-NSSF component branch : master
OAI-NEF component branch : master
OAI-PCF component branch : master
OAI-LMF component branch : master
---------------------------------------------------------
git submodule deinit --all --force
git submodule init
git submodule update
If you are using the develop images¶
If you want to pull the develop tags of the published images:
#!/bin/bash
docker pull oaisoftwarealliance/oai-amf:develop
docker pull oaisoftwarealliance/oai-nrf:develop
docker pull oaisoftwarealliance/oai-upf:develop
docker pull oaisoftwarealliance/oai-smf:develop
docker pull oaisoftwarealliance/oai-udr:develop
docker pull oaisoftwarealliance/oai-udm:develop
docker pull oaisoftwarealliance/oai-ausf:develop
docker pull oaisoftwarealliance/oai-upf-vpp:develop
docker pull oaisoftwarealliance/oai-nssf:develop
docker pull oaisoftwarealliance/oai-pcf:develop
docker pull oaisoftwarealliance/oai-nef:develop
docker pull oaisoftwarealliance/oai-lmf:develop
# Utility image to generate traffic
docker pull oaisoftwarealliance/trf-gen-cn5g:latest
Now these development images will NOT work with the master versions of the tutorials. You SHALL switch to the develop versions.
# Clone directly on the latest release tag
$ git clone --branch develop https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-fed.git
$ cd oai-cn5g-fed
# If you forgot to clone directly to the latest release tag
$ git checkout -f develop
$ git rebase origin/develop
You are ready to Configure the Containers.
You can also go back to the list of tutorials.