Update TS xApp for Release D use case
Issue-ID: RICAPP-170
Change-Id: I436624ce9db05af005eb660817cbd0a59dd7e0fe
Signed-off-by: Alexandre Huff <alexandrehuff@utfpr.edu.br>
diff --git a/README b/README
index 49bfd96..49d4989 100644
--- a/README
+++ b/README
@@ -20,7 +20,7 @@
This repository contains the source for the RIC traffic steering application.
-This xApp can be onboarded through the xApp Onboarder. The xapp descriptor
+This xApp can be onboarded through the xApp Onboarder. The xapp descriptor
is under the xapp-descriptor/ directory.
Then the xapp can be deployed through the App Manager.
@@ -29,14 +29,14 @@
the following needs to be done:
* QP xApp needs to be onboarded and deployed (see xapp descriptor in that repo)
* QP Driver xApp needs to be onboarded and deployed (see xapp descriptor in that repo)
-* SDL must contain network data
+* SDL must contain network data which required by the QP Driver xApp
Mock network data
=================
-Currently, there is no xapp available to receive RAN metrics and write to SDL.
+KPIMON xApp is in charge of collecting RAN metrics and write to SDL.
-The Traffic Steering Use Case can be run with mock data. Everything needed to write this
+However, the Traffic Steering Use Case can be run with mock data. Everything needed to write this
mock data is included in this repo. Directions are as follows:
cd test/populatedb
@@ -49,3 +49,24 @@
The code that is run will write the necessary data to SDL
+Mock applications (Release D)
+=============================
+
+There are sample applications in the test/app/ directory that demonstrate a dummy message exchange
+among AD, QP Driver, QP, and TS xApps. Currently, there is no Dockerfile to run those mock applications,
+but they can be built according to the following:
+
+1. Build the TS xApp
+2. $cd test/app/
+3. $cmake -S . -B build
+4. $cd build/
+5. $make
+
+Run xApps in the following order:
+1. TS xApp
+2. qp_xapp
+3. ad_xapp
+
+There is an additional application that mocks a Rest server to demonstrate all control messages
+issued by the TS xApp. It is implemented in Python and echoes all messages it receives. This
+application is located at the test/app directory.