Bouncer/docs/release-notes.rst

   1 # ==================================================================================
   2 # Copyright (c) 2020 HCL Technologies Limited.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at
   7 #
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15 # ==================================================================================
  16
  17 Release Notes
  18 =============
  19
  20
  21 This document provides the release notes for the Bronze Release of the Bouncer xAPP.
  22
  23 .. contents::
  24    :depth: 3
  25    :local:
  26
  27
  28 Version history
  29 ---------------
  30
  31 +--------------------+--------------------+--------------------+--------------------+
  32 | **Date**           | **Ver.**           | **Organization**   | **Comment**        |
  33 |                    |                    |                    |                    |
  34 +--------------------+--------------------+--------------------+--------------------+
  35 | 2020-11-18         | 1.0.0              |  HCL Technologies  | First draft        |
  36 |                    |                    |                    |                    |
  37 +--------------------+--------------------+--------------------+--------------------+
  38
  39
  40
  41 Summary
  42 -------
  43
  44 The Bronze release of the Bouncer xAPP demonstrates E2 interface interactions, persistent storage read-write, RMR and E2 Subscription handling.
  45 Bouncer xAPP uses its Bouncer E2SM (can be found at /src/xapp-asn/e2sm/) for ASN PDUs.
  46
  47
  48 Release Data
  49 ------------
  50
  51 +--------------------------------------+--------------------------------------+
  52 | **Project**                          | RAN Intelligent Controller           |
  53 |                                      |                                      |
  54 +--------------------------------------+--------------------------------------+
  55 | **Repo/commit-ID**                   | ric-app/benchmarking                 |
  56 |                                      |                                      |
  57 +--------------------------------------+--------------------------------------+
  58 | **Release designation**              |              Cherry                  |
  59 |                                      |                                      |
  60 +--------------------------------------+--------------------------------------+
  61 | **Release date**                     |      2020-11-18                      |
  62 |                                      |                                      |
  63 +--------------------------------------+--------------------------------------+
  64 | **Purpose of the delivery**          | open-source Bouncer xAPP             |
  65 |                                      |                                      |
  66 |                                      |                                      |
  67 +--------------------------------------+--------------------------------------+
  68
  69 Components
  70 ----------
  71
  72 - *src/* contains the main source code. Under that directory :
  73
  74   + *xapp.hpp, xapp.cc* is generic class which implements all the xAPP functionalities for xapp developer to pick and choose.
  75   + *xapp-utils/* contains generic classes for - persistent data management, configuration management, RMR send/receive etc.
  76   + *xapp-asn/* contains generic classes for generating/processing ASN1  E2AP and E2SM messages.
  77   + *xapp-mgmt/* contains code specific xapp management of subscriptions and received messages.
  78
  79
  80
  81
  82 Limitations
  83 -----------
  84 - The Bouncer xAPP target RIC Benchmarking usecase to determine the latency/thoughput in the RAN-RIC interaction.
  85
  86 - The subscription process assumes, on sending subscription request results in valid subscription response and receiving the message indication.
  87
  88 - The Bouncer xAPP address RIC Benchmarking usecase doesn't address A1 policy and SDL persistent data storage in particular.