From ba78dc3581e5bf41d3215a67942f80244b096d84 Mon Sep 17 00:00:00 2001 From: Robert Schmidt Date: Mon, 18 Nov 2024 16:42:24 +0100 Subject: [PATCH 1/3] Reformulate section on standalone mode Since tag 2024.w45/commit f54ca5714ed85d1dee2a112fbd3a497e2287cd40, standalone mode/--sa is the default and does not exist. Correspondingly, it has been removed from the documentation. For users reading recent documentation, but running an older version of OAI, there might be a mismatch in that --sa is necessary to run OAI, but not given in the documentation. Provide explanatory text to make users aware of this. --- doc/RUNMODEM.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/RUNMODEM.md b/doc/RUNMODEM.md index f20e5829dc..e6a715a29a 100644 --- a/doc/RUNMODEM.md +++ b/doc/RUNMODEM.md @@ -83,7 +83,12 @@ You should see the X2 messages in Wireshark and at the eNB. The standalone mode is the default mode. -It is not necessary to run either the gNB or the UE using the `--sa` flag in the command line for standalone mode. +Before tag `2024.w45`, the default mode was NSA. Thus, in the past, to run +either the gNB or the UE in standalone mode, it was necessary to provide the +`--sa` flag in the command line. This is not necessary anymore; if in doubt, +you can provide `--sa` on the command line. The gNB will ignore this option if +not relevant; the UE might complain that it does not know this option, which +means that standalone is already active. The default (SA) mode does the following: - At the gNB: From 75cde75fa430be9826d5efcb52ea2b8c9756b662 Mon Sep 17 00:00:00 2001 From: Romain Beurdouche Date: Tue, 19 Nov 2024 09:11:02 +0100 Subject: [PATCH 2/3] Add notes around sample SA gNB and nrUE commands in most basic tutorials 'NR_SA_Tutorial_COTS_UE.md' and 'NR_SA_Tutorial_OAI_nrUE.md'. The notes mention that for versions previous to 2024.w45, the --sa argument should be added to run in SA mode. --- doc/NR_SA_Tutorial_COTS_UE.md | 4 ++++ doc/NR_SA_Tutorial_OAI_nrUE.md | 13 +++++++++++++ 2 files changed, 17 insertions(+) diff --git a/doc/NR_SA_Tutorial_COTS_UE.md b/doc/NR_SA_Tutorial_COTS_UE.md index 41bce3ecf2..14012339ab 100644 --- a/doc/NR_SA_Tutorial_COTS_UE.md +++ b/doc/NR_SA_Tutorial_COTS_UE.md @@ -103,6 +103,10 @@ docker compose up -d ## 4.2 Run OAI gNB +**Note:** From tag `2024.w45`, OAI gNB runs by default in standalone (SA) mode. +In earlier versions the default mode was non-standalone (NSA). +If you are using an earlier version than `2024.w45`, you should add the `--sa` argument to the sample commands below to obtain a correct behavior. + ### USRP B210 ```bash cd ~/openairinterface5g/cmake_targets/ran_build/build diff --git a/doc/NR_SA_Tutorial_OAI_nrUE.md b/doc/NR_SA_Tutorial_OAI_nrUE.md index 34f36c6bf6..70a981174c 100644 --- a/doc/NR_SA_Tutorial_OAI_nrUE.md +++ b/doc/NR_SA_Tutorial_OAI_nrUE.md @@ -94,6 +94,10 @@ docker compose up -d ## 4.2 Run OAI gNB +**Note:** From tag `2024.w45`, OAI gNB runs by default in standalone (SA) mode. +In earlier versions the default mode was non-standalone (NSA). +If you are using an earlier version than `2024.w45`, you should add the `--sa` argument to the sample commands below to obtain a correct behavior. + ### USRP B210 ```bash cd ~/openairinterface5g/cmake_targets/ran_build/build @@ -126,6 +130,11 @@ sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band # 5. OAI UE ## 5.1 Run OAI nrUE + +**Note:** From tag `2024.w45`, OAI nrUE runs by default in standalone (SA) mode. +In earlier versions the default mode was non-standalone (NSA). +If you are using an earlier version than `2024.w45`, you should add the `--sa` argument to the sample commands below to obtain a correct behavior. + ### USRP B210 Important notes: - This should be run in a second Ubuntu 22.04 host, other than gNB @@ -194,6 +203,10 @@ The CL option `--uicc0.imsi` can override the IMSI value in the configuration f More details available at [ci-scripts/yaml_files/5g_rfsimulator/README.md](../ci-scripts/yaml_files/5g_rfsimulator/README.md). +**Note:** From tag `2024.w45`, OAI nrUE runs by default in standalone (SA) mode. +In earlier versions the default mode was non-standalone (NSA). +If you are using an earlier version than `2024.w45`, you should add the `--sa` argument to the sample commands above to obtain a correct behavior. + ## 5.2 End-to-end connectivity test - Ping test from the UE host to the CN5G ```bash From f885bd336abb8a31d22e9ff28a47ae00d821a981 Mon Sep 17 00:00:00 2001 From: Romain Beurdouche Date: Tue, 19 Nov 2024 09:33:20 +0100 Subject: [PATCH 3/3] Add note to 'doc/README.md' to insight readers to checkout the documentation at their version of the repository. --- doc/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/README.md b/doc/README.md index 3219c849cb..1c9e1dc784 100644 --- a/doc/README.md +++ b/doc/README.md @@ -12,6 +12,15 @@ +This is the general overview page of the OpenAirInterface documentation. +This page groups links to general information, tutorials, design documents, radio integration, and special-purpose libraries. + +**IMPORTANT NOTE:** +Before reading this documentation, we strongly advise you to keep your own repository rebased on `develop` +or at least to checkout the documentation on the version of the repository you are using. +Then the documentation will better reflect the features available in your repository so that you may avoid some errors. +Beware if you previously pulled the `develop` branch that your repository may be now behind `develop`. + [[_TOC_]] # General