From 60560827fc07869b47f4be97b087f65f67dc90ae Mon Sep 17 00:00:00 2001
From: Larry Peterson <llp@cs.princeton.edu>
Date: Wed, 4 Dec 2024 13:17:12 -0700
Subject: [PATCH] srsran update

Signed-off-by: Larry Peterson <llp@cs.princeton.edu>
---
 onramp/blueprints.rst | 18 +++++++++---------
 onramp/ref.rst        | 23 +++++++++++++++++++++++
 2 files changed, 32 insertions(+), 9 deletions(-)

diff --git a/onramp/blueprints.rst b/onramp/blueprints.rst
index 811f90f..146455d 100644
--- a/onramp/blueprints.rst
+++ b/onramp/blueprints.rst
@@ -665,13 +665,13 @@ srsRAN 5G
 ~~~~~~~~~~~~~~~~~~~~
 
 Aether can be configured to work with the open source gNB from srsRAN.
-The blueprint runs in simulation mode (currently work in progress to
-support USRP radio)
+The blueprint runs in simulation mode. (Support for USRP radio is
+currently work-in-progress.)
 
 The following assumes familiarity with the srsRAN 5G stack, but it is
-**not** necessary to separately install the srsRAN stack. OnRamp installs
-both the Aether Core and the srsRAN, plus the networking needed to
-interconnect the two.
+**not** necessary to separately install the srsRAN stack. OnRamp
+installs both the Aether Core and srsRAN, plus the networking needed
+to interconnect the two.
 
 .. _reading_srsran:
 .. admonition:: Further Reading
@@ -686,10 +686,10 @@ The blueprint includes the following:
 
 * Inventory file ``hosts.ini`` uses label ``[srsran_nodes]`` to denote
   the server(s) that host the gNB and (when configured in simulation
-  mode) the UE. srsRAN deployment installs the gNB and UE on one server,
-  with the 5G Core running on a separate server. (Although not necessary
-  in principle, the current playbooks require the gNB and simulated UE be
-  located on the same server.)
+  mode) the UE. The srsRAN blueprint installs the gNB and UE on one
+  server, with the 5G Core running on a separate server. (Although not
+  necessary in principle, the current playbooks require the gNB and
+  simulated UE be located on the same server.)
 
 * New make targets, ``srsran-gnb-install`` and ``srsran-gnb-uninstall``, to
   be executed along with the standard SD-Core installation (see  below).
diff --git a/onramp/ref.rst b/onramp/ref.rst
index 6cae6c0..c893fc7 100644
--- a/onramp/ref.rst
+++ b/onramp/ref.rst
@@ -68,6 +68,10 @@ repo. The groovy files can be found in the `aether-jenkins
      - `main-oai.yml`
      - `oai.groovy`
      - OAI software radio connected to 5G Core.
+   * - `srsRAN 5G <https://docs.aetherproject.org/master/onramp/blueprints.html#srsran-5g>`__
+     - `main-srsran.yml`
+     - `srsran.groovy`
+     - srsRAN software radio connected to 5G Core.
 
 
 Ansible Variables
@@ -106,6 +110,9 @@ the list is not comprehensive.
    * - `oai.simulation`
      - `true`
      - Run UE in simulation mode; set to `false` to connect real UEs.
+   * - `srsran.simulation`
+     - `true`
+     - Run UE in simulation mode; set to `false` to connect real UEs.
    * - `*.helm.local_charts`
      - `false`
      - Loads Helm Charts from public repo; set to `true` to utilize
@@ -141,6 +148,10 @@ substitute custom config files.
      - `deps/oai/roles/gNb/templates/gnb.sa.band78.fr1.106PRB.usrpb210.conf`
    * - `oai.ue.conf_file`
      - `deps/oai/roles/uEsimulator/templates/ue.conf`
+   * - `srsran.gnb.conf_file`
+     - `deps/srsran/roles/gNb/templates/gnb_zmq.conf`
+   * - `srsran.ue.conf_file`
+     - `deps/srsran/roles/uEsimulator/templates/ue_zmq.conf`
    * - `ueransim.servers`
      - `deps/ueransim/config/custom-gnb.yaml`
    * -
@@ -170,6 +181,8 @@ Ansible inventory file (``hosts.ini``). The following identifies the
      - Servers hosting UERANSIM process.
    * - `[oai_nodes]`
      - Servers hosting OAI gNB (and optionally UE) container(s).
+   * - `[srsran_nodes]`
+     - Servers hosting srsRAN gNB (and optionally UE) container(s).
 
 The `[worker_nodes]` group can be empty, but must be present.  The
 other groups are blueprint-specific, and with the exception of
@@ -258,6 +271,16 @@ other blueprints.)
      - Start container running OAI simulated UE.
    * - `oai-uesim-stop`
      - Stop container running OAI simulated UE.
+   * - **srsRAN 5G Blueprint**
+     -
+   * - `srsran-gnb-install`
+     - Install container running srsRAN 5G radio; assumes Core already deployed.
+   * - `srsran-gnb-uninstall`
+     - Uninstall srsRAN 5G radio container.
+   * - `srsran-uesim-start`
+     - Start container running srsRAN simulated UE.
+   * - `srsran-uesim-stop`
+     - Stop container running srsRAN simulated UE.
    * - **Multi-UPF Blueprint**
      -
    * - `5gc-upf-install`