2525290fd936b580d2fcb72b17d8a35c96d978b7
[ric-app/hw-python.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) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.Copyright (C) 2020
4
5
6 Release Notes
7 =============
8
9
10 This document provides the release notes for the Bronze Release of the HelloWorld (HW) 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 | -                  | -                  |   Rahul Banerji    | -                  |
25 |                    |                    |                    |                    |
26 +--------------------+--------------------+--------------------+--------------------+
27
28
29
30 Summary
31 -------
32
33 This release of the Python HW xAPP demonstrates the following:
34
35 -E2, A1 interfaces interactions.
36
37 -Read-write operations into a persistent storage.
38
39 -xAPP Configuration management
40
41 -RMR Health Check
42
43 -xAPP Health Check
44
45 -Raising alarms
46
47 -Generating metrics
48
49
50 Release Data
51 ------------
52
53 +--------------------------------------+--------------------------------------+
54 | **Project**                          | RAN Intelligent Controller           |
55 |                                      |                                      |
56 +--------------------------------------+--------------------------------------+
57 | **Repo/commit-ID**                   |      TBD                             |
58 |                                      |                                      |
59 +--------------------------------------+--------------------------------------+
60 | **Release designation**              |      TBD                             |
61 |                                      |                                      |
62 +--------------------------------------+--------------------------------------+
63 | **Release date**                     |      TBD                             |
64 |                                      |                                      |
65 +--------------------------------------+--------------------------------------+
66 | **Purpose of the delivery**          | open-source Python Hello World xAPP  |
67 |                                      |                                      |
68 |                                      |                                      |
69 +--------------------------------------+--------------------------------------+
70
71 Components
72 ----------
73
74 TBD
75
76   
77     
78
79 Limitations
80 -----------
81 - The HW xAPP doesn't have any usecase in particular to display SDL capabilities.
82
83 - The subscription process assumes, on sending subscription request results in valid subscription response. 
84
85 - The HW xAPP doesn't address any RIC usecase in particular.