docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2019 AT&T
   4
   5
   6 Release Notes
   7 =============
   8
   9
  10 This document provides the release notes for the Bronze Release of the Measurement Campaign xAPP.
  11
  12 .. contents::
  13    :depth: 3
  14    :local:
  15
  16
  17 Version history
  18 ---------------
  19
  20 +--------------------+--------------------+--------------------+--------------------+
  21 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  22 |                    |                    |                    |                    |
  23 +--------------------+--------------------+--------------------+--------------------+
  24 | 2020-05-01         | 1.0.5              |   Vlad Shkapenyuk  | Bronze release     |
  25 |                    |                    |                    |                    |
  26 +--------------------+--------------------+--------------------+--------------------+
  27 | 2019-11-25         | 1.0.0              |   Vlad Shkapenyuk  | First draft        |
  28 |                    |                    |                    |                    |
  29 +--------------------+--------------------+--------------------+--------------------+
  30
  31
  32
  33 Summary
  34 -------
  35
  36 The Bronze release of the MC xAPP supports calculation of a number of metrics and KPIs
  37 based on X2 messages received from UEEC.
  38
  39
  40 Release Data
  41 ------------
  42
  43 +--------------------------------------+--------------------------------------+
  44 | **Project**                          | RAN Intelligent Controller           |
  45 |                                      |                                      |
  46 +--------------------------------------+--------------------------------------+
  47 | **Repo/commit-ID**                   | ric-app/mc                           |
  48 |                                      |                                      |
  49 +--------------------------------------+--------------------------------------+
  50 | **Release designation**              | Bronze                               |
  51 |                                      |                                      |
  52 +--------------------------------------+--------------------------------------+
  53 | **Release date**                     | 2020-05-01                           |
  54 |                                      |                                      |
  55 +--------------------------------------+--------------------------------------+
  56 | **Purpose of the delivery**          | open-source measurement campaign xApp|
  57 |                                      |                                      |
  58 |                                      |                                      |
  59 +--------------------------------------+--------------------------------------+
  60
  61 Components
  62 ----------
  63
  64 - mc-core/* contains the source of core MC xApp container.
  65   + *mc-core/mc/queries/* contains a set of queries computing the output metrics and KPIs.
  66   + *mc-core/mc/data_gen/* contains a generator of X2 messages to run MC in standalone simulation mode without UEEC.
  67
  68 - *sidecars/* contains the source code the RMR listener container responsible for listeting to UEEC messages and forwarding them to mc-core.
  69
  70 - *docs/* contains the documentation.
  71
  72
  73 Dependencies
  74 ------------
  75 - MC xApp relies the GS-lite stream processing engine (com/gs-lite).