Merge pull request #28 from microsoft/matt/25.04_features

Add Significant Commits / Features

Author: matthewbalkwill

README.md

@@ -1,55 +1,70 @@
 - [1. Introduction](#1-introduction)
-- [2. Getting Started](#2-getting-started)
-  - [2.1. Prerequisites](#21-prerequisites)
-  - [2.2. Preparing the Environment](#22-preparing-the-environment)
-    - [2.2.1. Initialize submodules:](#221-initialize-submodules)
-    - [2.2.2. Set required environment variables:](#222-set-required-environment-variables)
-    - [2.2.3. There are two ways to start the srsRAN deployment:](#223-there-are-two-ways-to-start-the-srsran-deployment)
-    - [2.2.4. Start the srsRAN](#224-start-the-srsran)
-      - [2.2.4.1. Deploy RAN without jrtc:](#2241-deploy-ran-without-jrtc)
-      - [2.2.4.2. Deploy RAN with jrtc:](#2242-deploy-ran-with-jrtc)
-  - [2.3. Running the Examples](#23-running-the-examples)
-- [3. Hooks](#3-hooks)
-- [4. License](#4-license)
+- [2. Significant Commits / Features](#2-significant-commits--features)
+- [3. Getting Started](#3-getting-started)
+  - [3.1. Prerequisites](#31-prerequisites)
+  - [3.2. Preparing the Environment](#32-preparing-the-environment)
+    - [3.2.1. Initialize submodules:](#321-initialize-submodules)
+    - [3.2.2. Set required environment variables:](#322-set-required-environment-variables)
+    - [3.2.3. There are two ways to start the srsRAN deployment:](#323-there-are-two-ways-to-start-the-srsran-deployment)
+    - [3.2.4. Start the srsRAN](#324-start-the-srsran)
+      - [3.2.4.1. Deploy RAN without jrtc:](#3241-deploy-ran-without-jrtc)
+      - [3.2.4.2. Deploy RAN with jrtc:](#3242-deploy-ran-with-jrtc)
+  - [3.3. Running the Examples](#33-running-the-examples)
+- [4. Hooks and Codelets](#4-hooks-and-codelets)
+- [5. Frequently Asked Questions](#5-frequently-asked-questions)
+- [6. License](#6-license)
 
 
 # 1. Introduction
 
 This project provides a collection of sample applications for instrumenting **srsRAN** using the  
 [jbpf](https://github.com/microsoft/jbpf) and [jrt-controller](https://github.com/microsoft/jrt-controller) frameworks.
 
-# 2. Getting Started
+# 2. Significant Commits / Features
+
+[Sep 10, 2025,  commit bdc858c](https://github.com/microsoft/jrtc-apps/commit/bdc858c2f27f4d903f6466406f7514faf677d364) - srsRAN v25.04 support
+
+- Upgrade Jrtc to srsRAN v25.04
+  - Updates to flags required for building srsRAN images.
+  - Updates to numerous [codelets](./codelets) to align with latest srsRAN header files.
+  - Improvements to [Dashboard](./jrtc_apps/dashboard/).
+
+[Aug 8, 2025,  commit 0176d4c](https://github.com/microsoft/jrtc-apps/commit/0176d4cafdbc491f3948b6cb2a31864e5518b604) - Dashboard visualisations
+
+- Final update to Dashboard visualisation (Azure Log Analytics) for srsRAN v23.04
+
+# 3. Getting Started
 
 The simplest way to get started is by using Kubernetes. This is the default installation method and helps eliminate any dependency-related issues.
 However, we also support bare-metal installations.
 For bare-metal setup instructions, please follow [these instructions](docs/baremetal.md) 
 
-## 2.1. Prerequisites
+## 3.1. Prerequisites
 
 Before starting, ensure that **Kubernetes** and **Helm** are installed and configured. 
 If you are not an expert in Kubernetes, you can try one of the simple, single-node setups, such as [k3d](https://k3s.io/). 
 This guide assumes **srsRAN** will be deployed using **Helm**.
 
-## 2.2. Preparing the Environment
+## 3.2. Preparing the Environment
 
-### 2.2.1. Initialize submodules:
+### 3.2.1. Initialize submodules:
 
 ```bash
 cd ~/jbpf_apps
 ./init_submodules.sh
 ```
 
-### 2.2.2. Set required environment variables:
+### 3.2.2. Set required environment variables:
 
 ```bash
 source set_vars.sh
 ```
 
-### 2.2.3. There are two ways to start the srsRAN deployment:
+### 3.2.3. There are two ways to start the srsRAN deployment:
    - with JRTC - this will create two pods, one for srsRAN, and one for JRTC.  The JRTC pod has two containers; one for the *jrt-controller* and one running the *jrt-decoder*.
    - without JRTC - This will just create a single pod, for srsRAN.
 
-### 2.2.4. Start the srsRAN
+### 3.2.4. Start the srsRAN
 
 Move to the ***jrtc-apps/containers/Helm*** directory and make sure that parameters related to local setup, such as Core IP, RRH, Local MAC Address, and VLAN ID are correctly configured.
 These parameters are supplied from the Helm chart `values.yaml` (the default values are [here](./containers/Helm/values.yaml)). 
@@ -81,7 +96,7 @@ The easiest way to configure parameters related to local setup is to supply them
  Once the parameters are configured correctly we can deploy srsRAN
 
 
-#### 2.2.4.1. Deploy RAN without jrtc:
+#### 3.2.4.1. Deploy RAN without jrtc:
 
   ```
   ./install.sh -h . -f config.yaml
@@ -96,7 +111,7 @@ The easiest way to configure parameters related to local setup is to supply them
   srs-gnb-du1-0   3/3     Running   0          11s
   ```
 
-#### 2.2.4.2. Deploy RAN with jrtc:
+#### 3.2.4.2. Deploy RAN with jrtc:
 
   ```
   cd ~/jrtc-apps/containers/Helm
@@ -115,7 +130,7 @@ The easiest way to configure parameters related to local setup is to supply them
 
 ---
 
-## 2.3. Running the Examples
+## 3.3. Running the Examples
 
 This project includes two examples:
 
@@ -131,20 +146,20 @@ This project includes two examples:
 
 ---
 
-# 3. Hooks and Codelets
+# 4. Hooks and Codelets
 
 The available Jbpf hooks are described [here](./docs/srsran_hooks.md). Some of the codelets are documented [here](./docs/codelets.md).
 
 
-# 4. Frequently Asked Questions
+# 5. Frequently Asked Questions
 
 **Q:** Can codelets and apps be loaded from a different server or even a different folder? 
 
 **A:** No. At the moment, the [install.sh](./containers/Helm/install.sh) of the Helm chart maps local volumes `codelets_vol_mount` and `codelets_vol_mount` into the srsRAN and jrtc pods respectively, using a predefined folder structure. The loading process is triggered through REST but the apps and codelet source code and object files are loaded from the local volumes, not sent over REST. This is currently done for simplicity, but one can easily modify this design to fully support loading through REST API. 
 
 
 
-# 5. License
+# 6. License
 
 This project is licensed under the [MIT License](LICENSE.md).