Added documentation

Signed-off-by: Ron Shacham <rshacham@research.att.com>
Change-Id: I140e47ae0566b860937be66034509aa51cf5b5fd

diff --git a/README b/README
index a5ef7ae..49bfd96 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,5 @@
 
 ==================================================================================
-       Copyright (c) 2020 Nokia
        Copyright (c) 2020 AT&T Intellectual Property.
 
    Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,5 +16,36 @@
 ==================================================================================
 
 Traffic Steering
+================
 
 This repository contains the source for the RIC traffic steering application.
+
+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.
+
+In order for Traffic Steering xApp to carry out the Traffic Steering Use Case,
+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
+
+Mock network data
+=================
+
+Currently, there is no xapp available to receive RAN metrics and write to SDL.
+
+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
+
+chmod a+x populate_db.sh
+
+./populate_db.sh
+
+This script will build a docker image locally and also install a helm chart in the kubernetes cluster to run the image.
+
+The code that is run will write the necessary data to SDL
+

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 68ceddf..98c3a18 100644 (file)
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -18,4 +18,44 @@ Traffic Steering xAPP
 Introduction 
 ============
 
-Some text about the traffic steering xAPP will eventually be added here.
+The Traffic Steering Use Case demonstrates intelligent inferences in the Near-RT RIC and E2 interaction in order to execute on the inferences. 
+
+The current Use Case is comprised of three xApps:
+* Traffic Steering xApp (this one): Consume A1 Policy Intent, regularly monitor RAN metrics and request prediction for badly performing UEs, and listen for messages that show UE throughput predictions in different cells, in order to make a decision about UE Handover.
+* QoE Prediction (QP) xApp: Receive a feature set of metrics for a given UE, and output Throughput predictions on the Serving and any Neighbor cells
+* QoE Prediction Driver (QP Driver) xApp: Generate a feature set of metrics to input to QoE Prediction, based on SDL lookups in UE-Metric and Cell-Metric namespaces
+
+A1 Policy
+=========
+
+A1 Policy is sent to Traffic Steering xApp to define the Intent which will drive the Traffic Steering behavior.
+
+Policy Type ID is 20008.
+
+Currently, there is only one parameter that can be provided in A1 Policy: threshold
+
+An example Policy follows:
+{"threshold" : 5}
+
+This Policy instructs Traffic Steering xApp to monitor current RAN metrics and request a QoE Prediction for any UE whose Serving Cell RSRP is less than 5.
+
+Sending QoE Prediction Request
+==============================
+
+Traffic Steering xApp loops repeatedly.  After every sleep, it queries the SDL UE-Metric namespace.  When it identifies a UE whose RSRP is below the threshold, it generates a QoE Prediction message.  The RMR Message Type is 30000.  The following is an example message body:
+
+{"UEPredictionSet" : ["12345"]}
+
+Receiving QoE Prediction
+========================
+
+Traffic Steering xApp defines a callback for QoE Prediction received from QP xApp.  The RMR message type is 30002.  The following is an example message body:
+
+{"12345" : { "310-680-200-555001" : [ 2000000 , 1200000 ] , "310-680-200-555002" : [ 800000 , 400000 ] , "310-680-200-555003" : [ 800000 , 400000 ]  } }
+
+This message provides predictions for UE ID 12345.  For its service cell and neighbor cells, it lists an array containing two elements: DL Throughput and UL Throughput predictions.
+
+Traffic Steering xApp checks for the Service Cell ID for UE ID, and determines whether the predicted throughput is higher in a neighbor cell. 
+
+If predicted throughput is higher in a neighbor cell, Traffic Steering logs its intention to send a CONTROL message to do handover.
+