Merge remote-tracking branch 'origin/doc-updates' into integration_2025_w33 (!3590)

Improve MAC docs for MCS and docker for BuildKit usage See commits for details. The first one is for fixing an omission in !3281, the second to clarify docker build usage. Closes: #973
2026-07-13 04:30:28 +00:00 · 2025-08-14 16:46:44 +02:00
parent 9f5ea8beba 3ee41c3fec
commit 2c351c94d0
20 changed files with 53 additions and 35 deletions
--- a/cmake_targets/tools/build_helper
+++ b/cmake_targets/tools/build_helper
@@ -202,7 +202,7 @@ install_usrp_uhd_driver_from_source(){
            # - 3.15.0.0
            git apply $OPENAIR_DIR/cmake_targets/tools/uhd-3.15-tdd-patch.diff
            ret=$?;[[ $ret -ne 0 ]] && echo_fatal "Could not apply the TDD patch"
-        elif [[ "$UHD_VERSION" == "4.7.0.0" || "$UHD_VERSION" == "4.6.0.0" || "$UHD_VERSION" == "4.5.0.0" ]]; then
+        elif [[ "$UHD_VERSION" == "4.8.0.0" || "$UHD_VERSION" == "4.7.0.0" || "$UHD_VERSION" == "4.6.0.0" || "$UHD_VERSION" == "4.5.0.0" ]]; then
            # Tested that patch for the following versions:
            # - 4.7.0.0
            cp $OPENAIR_DIR/cmake_targets/tools/uhd-4.x-tdd-patch.diff $OPENAIR_DIR/cmake_targets/tools/uhd-4.5plus-tdd-patch.diff
--- a/doc/MAC/mac-usage.md
+++ b/doc/MAC/mac-usage.md
@@ -210,17 +210,17 @@ In the `MACRLCs` section of the gNB/DU configuration file:
  retransmission over initial transmission) to decrease MCS by 1
 * `dl_bler_target_lower` (default 0.05): lower threshold of BLER (first round
  retransmission over initial transmission) to increase MCS by 1
-* `dl_max_mcs` (default 28): maximum MCS to use
+* `dl_min_mcs` (default 0): minimum MCS to use for any UE
+* `dl_max_mcs` (default 28): maximum MCS to use for any UE
 * `ul_bler_target_upper` (default 0.15): as `dl_bler_target_upper`
 * `ul_bler_target_lower` (default 0.05): as `dl_bler_target_lower`
+* `ul_min_mcs` (default 0): as `dl_min_mcs`
 * `ul_max_mcs` (default 28): as `dl_max_mcs`
 * `dl_harq_round_max` (default 4): maximum number of HARQ rounds, i.e.,
  retransmissions to perform, in DL
 * `ul_harq_round_max` (default 4): as `dl_harq_round_max`
 * `min_grant_prb` (default 5): number of PRBs to schedule for UE after activity
  (see `ulsch_max_frame_inactivity`) or after scheduling request (SR)
-* `min_grant_mcs` (default 9): MCS to use for UE after activity (see
-  `ulsch_max_frame_inactivity`) or after scheduling request (SR)
 * `identity_precoding_matrix` (default 0=false): flag to enable to use only
  the identity precoding matrix in DL precoding
 * `set_analog_beamforming` (default 0=false): flag to enable analog
--- a/docker/Dockerfile.base.rhel9
+++ b/docker/Dockerfile.base.rhel9
@@ -32,7 +32,7 @@ ARG NEEDED_GIT_PROXY
 ARG TARGETARCH
 ENV TZ=Europe/Paris
 ENV BUILD_UHD_FROM_SOURCE=True
-ENV UHD_VERSION=4.4.0.0
+ENV UHD_VERSION=4.8.0.0

 # Copy the entitlements
 COPY ./etc-pki-entitlement /etc/pki/entitlement
--- a/docker/Dockerfile.base.rocky
+++ b/docker/Dockerfile.base.rocky
@@ -30,7 +30,7 @@ FROM $BASE_IMAGE AS ran-base
 ARG TARGETARCH
 ENV TZ=Europe/Paris
 ENV BUILD_UHD_FROM_SOURCE=True
-ENV UHD_VERSION=4.4.0.0
+ENV UHD_VERSION=4.8.0.0

 RUN dnf install 'dnf-command(config-manager)' -y && \
    dnf install epel-release -y && crb enable && \
--- a/docker/Dockerfile.base.ubuntu
+++ b/docker/Dockerfile.base.ubuntu
@@ -32,7 +32,7 @@ ARG TARGETARCH
 ENV DEBIAN_FRONTEND=noninteractive
 ENV TZ=Europe/Paris
 ENV BUILD_UHD_FROM_SOURCE=True
-ENV UHD_VERSION=4.4.0.0
+ENV UHD_VERSION=4.8.0.0

 #install developers pkg/repo
 RUN apt-get update && \
--- a/docker/Dockerfile.eNB.rhel9
+++ b/docker/Dockerfile.eNB.rhel9
@@ -90,7 +90,7 @@ COPY --from=enb-base \

 # Now we are copying from builder-image the UHD files.
 COPY --from=enb-base /usr/local/bin/uhd_find_devices /usr/local/bin
-COPY --from=enb-base /usr/local/lib64/libuhd.so.4.4.0 /usr/local/lib64
+COPY --from=enb-base /usr/local/lib64/libuhd.so.4.8.0 /usr/local/lib64
 COPY --from=enb-base /usr/local/lib64/uhd/utils/uhd_images_downloader.py /opt/oai-enb/bin

 WORKDIR /usr/local/share/uhd/rfnoc
@@ -111,7 +111,7 @@ RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai
        /usr/local/lib/liboai_iqplayer.so \
        /usr/local/lib/libtelnetsrv.so \
        /usr/local/lib/libtelnetsrv_enb.so \
-        /usr/local/lib64/libuhd.so.4.4.0
+        /usr/local/lib64/libuhd.so.4.8.0

 WORKDIR /opt/oai-enb

--- a/docker/Dockerfile.eNB.rocky
+++ b/docker/Dockerfile.eNB.rocky
@@ -91,7 +91,7 @@ COPY --from=enb-base \

 # Now we are copying from builder-image the UHD files.
 COPY --from=enb-base /usr/local/bin/uhd_find_devices /usr/local/bin
-COPY --from=enb-base /usr/local/lib64/libuhd.so.4.4.0 /usr/local/lib64
+COPY --from=enb-base /usr/local/lib64/libuhd.so.4.8.0 /usr/local/lib64
 COPY --from=enb-base /usr/local/lib64/uhd/utils/uhd_images_downloader.py /opt/oai-enb/bin

 WORKDIR /usr/local/share/uhd/rfnoc
@@ -112,7 +112,7 @@ RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai
        /usr/local/lib/liboai_iqplayer.so \
        /usr/local/lib/libtelnetsrv.so \
        /usr/local/lib/libtelnetsrv_enb.so \
-        /usr/local/lib64/libuhd.so.4.4.0
+        /usr/local/lib64/libuhd.so.4.8.0

 WORKDIR /opt/oai-enb

--- a/docker/Dockerfile.eNB.ubuntu
+++ b/docker/Dockerfile.eNB.ubuntu
@@ -98,7 +98,7 @@ COPY --from=enb-build \

 # Now we are copying from builder-image the UHD files.
 COPY --from=enb-base /usr/local/bin/uhd_find_devices /usr/local/bin
-COPY --from=enb-base /usr/local/lib/libuhd.so.4.4.0 /usr/local/lib
+COPY --from=enb-base /usr/local/lib/libuhd.so.4.8.0 /usr/local/lib
 COPY --from=enb-base /usr/local/lib/uhd/utils/uhd_images_downloader.py /opt/oai-enb/bin

 RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai_device.so" && \
@@ -115,7 +115,7 @@ RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai
        /usr/local/lib/liboai_iqplayer.so \
        /usr/local/lib/libtelnetsrv.so \
        /usr/local/lib/libtelnetsrv_enb.so \
-        /usr/local/lib/libuhd.so.4.4.0
+        /usr/local/lib/libuhd.so.4.8.0

 WORKDIR /opt/oai-enb

--- a/docker/Dockerfile.gNB.rhel9
+++ b/docker/Dockerfile.gNB.rhel9
@@ -97,7 +97,7 @@ COPY --from=gnb-base \

 # Now we are copying from builder-image the UHD files.
 COPY --from=gnb-base /usr/local/bin/uhd_find_devices /usr/local/bin
-COPY --from=gnb-base /usr/local/lib64/libuhd.so.4.4.0 /usr/local/lib64
+COPY --from=gnb-base /usr/local/lib64/libuhd.so.4.8.0 /usr/local/lib64
 COPY --from=gnb-base /usr/local/lib64/uhd/utils/uhd_images_downloader.py /opt/oai-gnb/bin

 ## Copy E2 SM models
@@ -120,7 +120,7 @@ RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai
        /usr/local/lib/libldpc*.so \
        /usr/local/lib/libtelnetsrv.so \
        /usr/local/lib/libtelnetsrv_ci.so \
-        /usr/local/lib64/libuhd.so.4.4.0
+        /usr/local/lib64/libuhd.so.4.8.0

 WORKDIR /opt/oai-gnb
 #EXPOSE 2152/udp  # S1U, GTP/UDP
--- a/docker/Dockerfile.gNB.rocky
+++ b/docker/Dockerfile.gNB.rocky
@@ -94,7 +94,7 @@ COPY --from=gnb-base \

 # Now we are copying from builder-image the UHD files.
 COPY --from=gnb-base /usr/local/bin/uhd_find_devices /usr/local/bin
-COPY --from=gnb-base /usr/local/lib64/libuhd.so.4.4.0 /usr/local/lib64
+COPY --from=gnb-base /usr/local/lib64/libuhd.so.4.8.0 /usr/local/lib64
 COPY --from=gnb-base /usr/local/lib64/uhd/utils/uhd_images_downloader.py /opt/oai-gnb/bin

 WORKDIR /usr/local/share/uhd/rfnoc
@@ -114,7 +114,7 @@ RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai
        /usr/local/lib/libldpc*.so \
        /usr/local/lib/libtelnetsrv.so \
        /usr/local/lib/libtelnetsrv_ci.so \
-        /usr/local/lib64/libuhd.so.4.4.0
+        /usr/local/lib64/libuhd.so.4.8.0

 WORKDIR /opt/oai-gnb
 #EXPOSE 2152/udp  # S1U, GTP/UDP
--- a/docker/Dockerfile.gNB.ubuntu
+++ b/docker/Dockerfile.gNB.ubuntu
@@ -99,7 +99,7 @@ COPY --from=gnb-build \

 # Now we are copying from builder-image the UHD files.
 COPY --from=gnb-base /usr/local/bin/uhd_find_devices /usr/local/bin
-COPY --from=gnb-base /usr/local/lib/libuhd.so.4.4.0 /usr/local/lib
+COPY --from=gnb-base /usr/local/lib/libuhd.so.4.8.0 /usr/local/lib
 COPY --from=gnb-base /usr/local/lib/uhd/utils/uhd_images_downloader.py /opt/oai-gnb/bin
 ## Copy E2 SM models
 COPY --from=gnb-build /usr/local/lib/flexric /usr/local/lib/flexric
@@ -118,7 +118,7 @@ RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai
        /usr/local/lib/libldpc*.so \
        /usr/local/lib/libtelnetsrv.so \
        /usr/local/lib/libtelnetsrv_ci.so \
-        /usr/local/lib/libuhd.so.4.4.0
+        /usr/local/lib/libuhd.so.4.8.0

 WORKDIR /opt/oai-gnb
 #EXPOSE 2152/udp  # S1U, GTP/UDP
--- a/docker/Dockerfile.lteRU.rhel9
+++ b/docker/Dockerfile.lteRU.rhel9
@@ -80,7 +80,7 @@ COPY --from=ru-base \

 # Copying from the ran-build image the USRP needed packages
 COPY --from=ru-base /usr/local/bin/uhd_find_devices /usr/local/bin
-COPY --from=ru-base /usr/local/lib64/libuhd.so.4.4.0 /usr/local/lib64
+COPY --from=ru-base /usr/local/lib64/libuhd.so.4.8.0 /usr/local/lib64
 COPY --from=ru-base /usr/local/lib64/uhd/utils/uhd_images_downloader.py /opt/oai-lte-ru/bin

 WORKDIR /usr/local/share/uhd/rfnoc
@@ -96,7 +96,7 @@ RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai
        /usr/local/lib/liboai_usrpdevif.so \
        /usr/local/lib/libparams_libconfig.so \
        /usr/local/lib/libdfts.so \
-        /usr/local/lib64/libuhd.so.4.4.0
+        /usr/local/lib64/libuhd.so.4.8.0

 WORKDIR /opt/oai-lte-ru

--- a/docker/Dockerfile.lteRU.ubuntu
+++ b/docker/Dockerfile.lteRU.ubuntu
@@ -76,7 +76,7 @@ COPY --from=ru-build \

 # Now we are copying from builder-image the UHD files.
 COPY --from=ru-base /usr/local/bin/uhd_find_devices /usr/local/bin
-COPY --from=ru-base /usr/local/lib/libuhd.so.4.4.0 /usr/local/lib
+COPY --from=ru-base /usr/local/lib/libuhd.so.4.8.0 /usr/local/lib
 COPY --from=ru-base /usr/local/lib/uhd/utils/uhd_images_downloader.py /opt/oai-lte-ru/bin


@@ -90,7 +90,7 @@ RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai
        /usr/local/lib/liboai_usrpdevif.so \
        /usr/local/lib/libparams_libconfig.so \
        /usr/local/lib/libdfts.so \
-        /usr/local/lib/libuhd.so.4.4.0
+        /usr/local/lib/libuhd.so.4.8.0

 WORKDIR /opt/oai-lte-ru

--- a/docker/Dockerfile.lteUE.rhel9
+++ b/docker/Dockerfile.lteUE.rhel9
@@ -95,7 +95,7 @@ COPY --from=lte-ue-base \

 # Now we are copying from builder-image the UHD files.
 COPY --from=lte-ue-base /usr/local/bin/uhd_find_devices /usr/local/bin
-COPY --from=lte-ue-base /usr/local/lib64/libuhd.so.4.4.0 /usr/local/lib64
+COPY --from=lte-ue-base /usr/local/lib64/libuhd.so.4.8.0 /usr/local/lib64
 COPY --from=lte-ue-base /usr/local/lib64/uhd/utils/uhd_images_downloader.py /opt/oai-lte-ue/bin

 WORKDIR /usr/local/share/uhd/rfnoc
@@ -113,7 +113,7 @@ RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai
        /usr/local/lib/libparams_libconfig.so \
        /usr/local/lib/libdfts.so \
        /usr/local/lib/libtelnetsrv.so \
-        /usr/local/lib64/libuhd.so.4.4.0
+        /usr/local/lib64/libuhd.so.4.8.0

 WORKDIR /opt/oai-lte-ue
 COPY --from=lte-ue-base /tini /tini
--- a/docker/Dockerfile.lteUE.rocky
+++ b/docker/Dockerfile.lteUE.rocky
@@ -96,7 +96,7 @@ COPY --from=lte-ue-base \

 # Now we are copying from builder-image the UHD files.
 COPY --from=lte-ue-base /usr/local/bin/uhd_find_devices /usr/local/bin
-COPY --from=lte-ue-base /usr/local/lib64/libuhd.so.4.4.0 /usr/local/lib64
+COPY --from=lte-ue-base /usr/local/lib64/libuhd.so.4.8.0 /usr/local/lib64
 COPY --from=lte-ue-base /usr/local/lib64/uhd/utils/uhd_images_downloader.py /opt/oai-lte-ue/bin

 WORKDIR /usr/local/share/uhd/rfnoc
@@ -114,7 +114,7 @@ RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai
        /usr/local/lib/libparams_libconfig.so \
        /usr/local/lib/libdfts.so \
        /usr/local/lib/libtelnetsrv.so \
-        /usr/local/lib64/libuhd.so.4.4.0
+        /usr/local/lib64/libuhd.so.4.8.0

 WORKDIR /opt/oai-lte-ue
 COPY --from=lte-ue-base /tini /tini
--- a/docker/Dockerfile.lteUE.ubuntu
+++ b/docker/Dockerfile.lteUE.ubuntu
@@ -101,7 +101,7 @@ COPY --from=lte-ue-build \

 # Now we are copying from builder-image the UHD files.
 COPY --from=lte-ue-base /usr/local/bin/uhd_find_devices /usr/local/bin
-COPY --from=lte-ue-base /usr/local/lib/libuhd.so.4.4.0 /usr/local/lib
+COPY --from=lte-ue-base /usr/local/lib/libuhd.so.4.8.0 /usr/local/lib
 COPY --from=lte-ue-base /usr/local/lib/uhd/utils/uhd_images_downloader.py /opt/oai-lte-ue/bin

 RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai_device.so" && \
@@ -116,7 +116,7 @@ RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai
        /usr/local/lib/libparams_libconfig.so \
        /usr/local/lib/libdfts.so \
        /usr/local/lib/libtelnetsrv.so \
-        /usr/local/lib/libuhd.so.4.4.0
+        /usr/local/lib/libuhd.so.4.8.0

 WORKDIR /opt/oai-lte-ue
 COPY --from=lte-ue-base /tini /tini
--- a/docker/Dockerfile.nrUE.rhel9
+++ b/docker/Dockerfile.nrUE.rhel9
@@ -99,7 +99,7 @@ COPY --from=nr-ue-base \

 # Now we are copying from builder-image the UHD files.
 COPY --from=nr-ue-base /usr/local/bin/uhd_find_devices /usr/local/bin
-COPY --from=nr-ue-base /usr/local/lib64/libuhd.so.4.4.0 /usr/local/lib64
+COPY --from=nr-ue-base /usr/local/lib64/libuhd.so.4.8.0 /usr/local/lib64
 COPY --from=nr-ue-base /usr/local/lib64/uhd/utils/uhd_images_downloader.py /opt/oai-nr-ue/bin

 WORKDIR /usr/local/share/uhd/rfnoc
@@ -119,7 +119,7 @@ RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai
        /usr/local/lib/libldpc*.so \
        /usr/local/lib/libtelnetsrv.so \
        /usr/local/lib/libtelnetsrv_5Gue.so \
-        /usr/local/lib64/libuhd.so.4.4.0
+        /usr/local/lib64/libuhd.so.4.8.0

 WORKDIR /opt/oai-nr-ue
 COPY --from=nr-ue-base /tini /tini
--- a/docker/Dockerfile.nrUE.rocky
+++ b/docker/Dockerfile.nrUE.rocky
@@ -96,7 +96,7 @@ COPY --from=nr-ue-base \

 # Now we are copying from builder-image the UHD files.
 COPY --from=nr-ue-base /usr/local/bin/uhd_find_devices /usr/local/bin
-COPY --from=nr-ue-base /usr/local/lib64/libuhd.so.4.4.0 /usr/local/lib64
+COPY --from=nr-ue-base /usr/local/lib64/libuhd.so.4.8.0 /usr/local/lib64
 COPY --from=nr-ue-base /usr/local/lib64/uhd/utils/uhd_images_downloader.py /opt/oai-nr-ue/bin

 WORKDIR /usr/local/share/uhd/rfnoc
@@ -116,7 +116,7 @@ RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai
        /usr/local/lib/libldpc*.so \
        /usr/local/lib/libtelnetsrv.so \
        /usr/local/lib/libtelnetsrv_5Gue.so \
-        /usr/local/lib64/libuhd.so.4.4.0
+        /usr/local/lib64/libuhd.so.4.8.0

 WORKDIR /opt/oai-nr-ue
 COPY --from=nr-ue-base /tini /tini
--- a/docker/Dockerfile.nrUE.ubuntu
+++ b/docker/Dockerfile.nrUE.ubuntu
@@ -98,7 +98,7 @@ COPY --from=nr-ue-build \

 # Now we are copying from builder-image the UHD files.
 COPY --from=nr-ue-base /usr/local/bin/uhd_find_devices /usr/local/bin
-COPY --from=nr-ue-base /usr/local/lib/libuhd.so.4.4.0 /usr/local/lib
+COPY --from=nr-ue-base /usr/local/lib/libuhd.so.4.8.0 /usr/local/lib
 COPY --from=nr-ue-base /usr/local/lib/uhd/utils/uhd_images_downloader.py /opt/oai-nr-ue/bin

 RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai_device.so" && \
@@ -116,7 +116,7 @@ RUN /bin/bash -c "ln -s /usr/local/lib/liboai_usrpdevif.so /usr/local/lib/liboai
        /usr/local/lib/libtelnetsrv.so \
        /usr/local/lib/libtelnetsrv_ciUE.so \
        /usr/local/lib/libtelnetsrv_5Gue.so \
-        /usr/local/lib/libuhd.so.4.4.0
+        /usr/local/lib/libuhd.so.4.8.0

 WORKDIR /opt/oai-nr-ue
 COPY --from=nr-ue-base /tini /tini
--- a/docker/README.md
+++ b/docker/README.md
@@ -91,6 +91,24 @@ For more details regarding the build on an Openshift Cluster, see [OpenShift REA
 * `docker-ce` installed
 * Pulling `ubuntu:jammy` from DockerHub

+The docker files in this directory rely on [automatic Docker platform
+arguments](https://docs.docker.com/reference/dockerfile/#automatic-platform-args-in-the-global-scope)
+`TARGETARCH` and `TARGETPLATFORM` to be defined. This is the case when using
+[BuildKit](https://docs.docker.com/build/buildkit/), which is automatically
+enabled in newer (v23.0+) docker versions.
+
+If you are running an older version of docker that does not have BuildKit
+enabled and do not wish to upgrade to a newer docker version, you have two
+possibilities:
+
+1. [Enable BuildKit](https://docs.docker.com/build/buildkit/#getting-started)
+   when building: `DOCKER_BUILDKIT=1 docker build ...`
+2. You should be able to define these variables manually.
+   - x86: `docker build --build-arg TARGETARCH=amd64 --build-arg
+     TARGETPLATFORM=linux/amd64 ...`
+   - arm: `docker build --build-arg TARGETARCH=arm64 --build-arg
+     TARGETPLATFORM=linux/arm64 ...`
+
 ## 3.2. Building the shared images ##

 There are two shared images: one that has all dependencies, and a second that compiles all targets (eNB, gNB, [nr]UE).