Skip to content

Docker Deployment

Note

Docker offers an alternative way to deploy free5GC with free-ran-ue on a single machine without any network setting conflicts.

For free5GC NF images, compose will pull the latest version from free5GC's Docker Hub.

A. Prerequisites

  • Docker:

    • Install

      sudo apt update
sudo apt install apt-transport-https ca-certificates curl software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
sudo apt update
sudo apt install docker-ce
sudo systemctl start docker
sudo docker --version

    • Docker group (avoid sudo problem)

      sudo groupadd docker
sudo usermod -aG docker $USER
newgrp docker

  • gtp5g

    • Packages

      sudo apt -y update
sudo apt -y install git gcc g++ cmake autoconf libtool pkg-config libmnl-dev libyaml-dev

    • Clone, Build and Install

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

B. Build free-ran-ue Image

  • Clone

    git clone https://github.com/Alonza0314/free-ran-ue.git

  • Build Image

    cd free-ran-ue
make docker

    After building, use docker images cli to check image.

C. Start Compose

There are three types of docker compose:

  • Basic free-ran-ue

    docker compose -f docker/docker-compose.yaml up

  • Static NR-DC

    docker compose -f docker/docker-compose-dc-static.yaml up

  • Dynamic NR-DC

    docker compose -f docker/docker-compose-dc-dynamic.yaml up

D. (Only Dynamic NR-DC) Console

Start your browser, and access your host's with the port configure in the docker/config/fru-consolecfg.yaml. (defaule is 40104)

The gNBs default configuration are:

  • gNB-master:

    • IP Address: 10.0.4.3
    • Port: 40104

  • gNB-secondary:

    • IP Address: 10.0.4.5
    • Port: 40104

For console usage, please refer to: console

E. UE

After docker compose started, UE can be started by entering the ue container.

  1. Enter ue container

    docker exec -it ue bash

  2. Start UE

    ./free-ran-ue ue -c uecfg.yaml

  3. Check Network Interface

    ifconfig

    Expected output included:

    ueTun0: flags=4305<UP,POINTOPOINT,RUNNING,NOARP,MULTICAST>  mtu 1500
    inet 10.60.0.1  netmask 255.255.255.255  destination 10.60.0.1
    inet6 fe80::b1e9:2933:3c64:b981  prefixlen 64  scopeid 0x20<link>
    unspec 00-00-00-00-00-00-00-00-00-00-00-00-00-00-00-00  txqueuelen 500  (UNSPEC)
    RX packets 0  bytes 0 (0.0 B)
    RX errors 0  dropped 0  overruns 0  frame 0
    TX packets 0  bytes 0 (0.0 B)
    TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

  4. Application

    Now, the whole deployment is finished. Network interface ueTun0 can be used for any application, e.g. ICMP / iperf.