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