Merge "Add full unit tests for listener"
[ric-app/mc.git] / 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 Amber 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 | 2019-11-25         | 1.0.0              |   Vlad Shkapenyuk  | First draft        |
25 |                    |                    |                    |                    |
26 +--------------------+--------------------+--------------------+--------------------+
27
28
29
30 Summary
31 -------
32
33 The Amber release of the MC xAPP supports calculation of a number of metrics and KPIs 
34 based on X2 messages received from UEEC.
35
36
37 Release Data
38 ------------
39
40 +--------------------------------------+--------------------------------------+
41 | **Project**                          | RAN Intelligent Controller           |
42 |                                      |                                      |
43 +--------------------------------------+--------------------------------------+
44 | **Repo/commit-ID**                   |        ric-app/mc                    |
45 |                                      |                                      |
46 +--------------------------------------+--------------------------------------+
47 | **Release designation**              |              Amber                   |
48 |                                      |                                      |
49 +--------------------------------------+--------------------------------------+
50 | **Release date**                     |      2019-11-14                      |
51 |                                      |                                      |
52 +--------------------------------------+--------------------------------------+
53 | **Purpose of the delivery**          | open-source measurement campaign xApp|
54 |                                      |                                      |
55 |                                      |                                      |
56 +--------------------------------------+--------------------------------------+
57
58 Components
59 ----------
60
61 - mc-core/* contains the source of core MC xApp container.
62   + *mc-core/mc/queries/* contains a set of queries computing the output metrics and KPIs.
63   + *mc-core/mc/data_gen/* contains a generator of X2 messages to run MC in standalone simulation mode without UEEC.
64   
65 - *sidecars/* contains the source code the RMR listener container responsible for listeting to UEEC messages and forwarding them to mc-core.
66
67 - *docs/* contains the documentation.
68   
69
70 Dependencies
71 ------------
72 - MC xApp relies the GS-lite stream processing engine (com/gs-lite).