docs/user-guide.rst

   1
   2
   3 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   4 .. SPDX-License-Identifier: CC-BY-4.0
   5 ..
   6 .. CAUTION: this document is generated from source in doc/src/*
   7 .. To make changes edit the source and recompile the document.
   8 .. Do NOT make changes directly to .rst or .md files.
   9
  10
  11 ============
  12 User's Guide
  13 ============
  14 ---------------------
  15 Traffic Steering xAPP
  16 ---------------------
  17
  18 Introduction
  19 ============
  20
  21 The Traffic Steering Use Case demonstrates intelligent inferences in the Near-RT RIC and E2 interaction in order to execute on the inferences.
  22
  23 The current Use Case is comprised of three xApps:
  24 * 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.
  25 * 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
  26 * 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
  27
  28 A1 Policy
  29 =========
  30
  31 A1 Policy is sent to Traffic Steering xApp to define the Intent which will drive the Traffic Steering behavior.
  32
  33 Policy Type ID is 20008.
  34
  35 Currently, there is only one parameter that can be provided in A1 Policy: threshold
  36
  37 An example Policy follows:
  38 {"threshold" : 5}
  39
  40 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.
  41
  42 Sending QoE Prediction Request
  43 ==============================
  44
  45 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:
  46
  47 {"UEPredictionSet" : ["12345"]}
  48
  49 Receiving QoE Prediction
  50 ========================
  51
  52 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:
  53
  54 {"12345" : { "310-680-200-555001" : [ 2000000 , 1200000 ] , "310-680-200-555002" : [ 800000 , 400000 ] , "310-680-200-555003" : [ 800000 , 400000 ]  } }
  55
  56 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.
  57
  58 Traffic Steering xApp checks for the Service Cell ID for UE ID, and determines whether the predicted throughput is higher in a neighbor cell.
  59
  60 If predicted throughput is higher in a neighbor cell, Traffic Steering logs its intention to send a CONTROL message to do handover.
  61