|
OpenAirInterface Core Network Docker Deployment : Building the Images |
Table of Contents
- Retrieve the proper code version on the OAI-CN part
- Generic Parameters
- Build OAI-HSS Image
- Build OAI-SPGW-C Image
- Build OAI-SPGW-U Image
- Retrieve the MAGMA source code
This page is only for Ubuntu18 builds. For other distributions, see here.
CAUTION: PLEASE READ THIS SECTION VERY CAREFULLY!
This repository only has tutorials and Continuous Integration scripts.
Each 4G Network Function source code is managed in its own repository.
They are called as git sub-modules in the component folder.
Before doing anything, you SHALL retrieve the code for each git sub-module.
We recommend to synchronize with the master branches on all git sub-modules.
We also recommend that you synchronize this "tutorial" repository with a provided tag. By doing so, the docker-compose files will be aligned with feature sets of each NF.
At the time of writing (2022/02/25), the release tag is v1.2.0.
| CNF Name | Branch Name | Tag | Ubuntu 18.04 | RHEL8 (UBI8) |
|---|---|---|---|---|
| FED REPO | N/A | v1.2.0 |
||
| HSS | master |
v1.2.0 |
X | X |
| SPWG-C | master |
v1.2.0 |
X | X |
| SPGW-U-TINY | master |
v1.2.0 |
X | X |
| MAGMA-MME | master |
N/A |
X | X |
# Clone directly on the latest release tag
$ git clone --branch v1.2.0 https://github.com/OPENAIRINTERFACE/openair-epc-fed.git
$ cd openair-epc-fed
# If you forgot to clone directly to the latest release tag
$ git checkout -f v1.2.0
# Synchronize all git submodules
$ ./scripts/syncComponents.sh
---------------------------------------------------------
OAI-HSS component branch : master
OAI-SPGW-C component branch : master
OAI-SPGW-U component branch : masterAll the latest features are somehow pushed to the develop branches of each NF repository.
It means that we/you are able to build and the Continuous Integration test suite makes sure it does NOT break any existing tested feature.
Anyhow, the tutorials' docker-compose files on the latest commit of the master branch of
openair-epc-fed repository SHALL support any additional un-tested feature.
# Clone
$ git clone https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-fed.git
$ cd oai-cn5g-fed
# On an existing repository, resync to the last `master` commit
$ git fetch --prune
$ git checkout master
$ git rebase origin/master
# Synchronize all git submodules
$ ./scripts/syncComponentsLegacy.sh --hss-branch develop --spgwc-branch develop --spgwu-tiny-branch develop
---------------------------------------------------------
OAI-HSS component branch : develop
OAI-SPGW-C component branch : develop
OAI-SPGW-U component branch : develop
---------------------------------------------------------
git submodule deinit --all --force
git submodule init
git submodule updateHere in our network configuration, we need to pass the "GIT PROXY" configuration.
- If you do not need, remove the
--build-arg EURECOM_PROXY=".."option. - If you do need it, change with your proxy value.
On our CI server (a 48-CPU server), this operation takes around 13 minutes. Please be patient.
$ docker build --target oai-hss --tag oai-hss:production \
--file component/oai-hss/docker/Dockerfile.ubuntu18.04 \
# The following line about proxy is certainly not needed in your env \
--build-arg EURECOM_PROXY="http://proxy.eurecom.fr:8080" \
component/oai-hss
$ docker image prune --force
$ docker image ls
oai-hss production f478bafd7a06 1 minute ago 341MB
...On our CI server (a 48-CPU server), this operation takes around 10 minutes. Please be patient.
$ docker build --target oai-spgwc --tag oai-spgwc:production \
--file component/oai-spgwc/docker/Dockerfile.ubuntu18.04 \
# The following line about proxy is certainly not needed in your env \
--build-arg EURECOM_PROXY="http://proxy.eurecom.fr:8080" \
component/oai-spgwc
$ docker image prune --force
$ docker image ls
oai-spgwc production b1ba7dd16bc5 1 minute ago 218MB
...On our CI server (a 48-CPU server), this operation takes around 9 minutes. Please be patient.
$ docker build --target oai-spgwu-tiny --tag oai-spgwu-tiny:production \
--file component/oai-spgwu-tiny/docker/Dockerfile.ubuntu18.04 \
# The following line about proxy is certainly not needed in your env \
--build-arg EURECOM_PROXY="http://proxy.eurecom.fr:8080" \
component/oai-spgwu-tiny
$ docker image prune --force
$ docker image ls
oai-spgwu-tiny production 588e14481f2b 1 minute ago 220MB
...Important Update (2021 / 03 / 20), the NSA Support was merged into master.
$ cd ~
$ git clone https://github.com/magma/magma.git
$ cd magma
$ git log | grep -i NSAYou should see Mohit's Pull request being merged ([Converged MME]NSA-Addition (#4513)).
The .dockerignore file is meant for the image building on the Orchestrator.
It is NOT suitable for the MAGMA-MME image building. If you don't remove/rename, build won't complete.
$ rm .dockerignoreDuring the UE attachment, we have seen that when UE receives the EMM-Information NAS packet, the UE disconnects.
So at the time of writing (2021 / 02 / 01), we are disabling the sending of EMM-INFO packet.
$ git diff lte/gateway/c/core/oai/tasks/nas/emm/Attach.c
diff --git a/lte/gateway/c/core/oai/tasks/nas/emm/Attach.c b/lte/gateway/c/core/oai/tasks/nas/emm/Attach.c
index 34f353a88..b354b18b7 100644
--- a/lte/gateway/c/core/oai/tasks/nas/emm/Attach.c
+++ b/lte/gateway/c/core/oai/tasks/nas/emm/Attach.c
@@ -840,7 +840,7 @@ int emm_proc_attach_complete(
LOG_NAS_EMM,
" Sending EMM INFORMATION for ue_id = " MME_UE_S1AP_ID_FMT "\n",
ue_id);
- emm_proc_emm_informtion(ue_mm_context);
+ //emm_proc_emm_informtion(ue_mm_context);
increment_counter("ue_attach", 1, 1, "result", "attach_proc_successful");
attach_success_event(ue_mm_context->emm_context._imsi64);
}This issue is in our TODO list and we are still investigating.
Another known issue is if the UE send a TAU request to the MME. Currently the MAGMA MME with an OAI eNB
does not handle it well. We are also working on providing a fix for this issue.
Update (2021/11/22): Implementation of TAU request response in the MME has been merged in September in MAGMA master branch.
We validated it on our RAN CI bench.
On our CI server (a 48-CPU server), this operation takes around 30-35 minutes. Please be patient.
The reason: a lot of needed packages/libraries are installed from source for a very specific version.
Once again, if you need a proxy, add your proxy URL. If not, remove the option.
$ docker build --target magma-mme --tag magma-mme:master \
--file lte/gateway/docker/mme/Dockerfile.ubuntu18.04 \
# The following line about proxy is certainly not needed in your env \
--build-arg GIT_PROXY="http://proxy.eurecom.fr:8080" \
.
$ docker image ls
magma-mme nsa-support b6fb01eb0d07 1 minute ago 492MB
...If you are planning to re-build MAGMA-MME Docker image, here is is a trick:
Normally after the 35 minutes, you should get the MME image but also a dangling image that should be quite large (5+ GBytes).
$ docker image ls
magma-mme nsa-support b6fb01eb0d07 1 minute ago 492MB
<none> <none> 91259fd827ee 5 minutes ago 5.24GB
...Re-tag the dangling image:
$ docker image tag 91259fd827ee magma-dev-mme:ci-base-imageAnd use the CI docker file.
$ docker build --target magma-mme --tag magma-mme:next-image-tag --file ci-scripts/docker/Dockerfile.mme.ci.ubuntu18 .This will only take 5 to 10 minutes to re-build a MAGMA-MME image.
Normally you are ready to deploy and test.