e18d2ef6e8b35b47951318d971331cae9d45f820
[ric-app/qp-driver.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 AT&T Intellectual Property
4
5 Release Notes
6 ===============
7
8 All notable changes to this project will be documented in this file.
9
10 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
11 and this project adheres to `Semantic Versioning <http://semver.org/>`__.
12
13
14 [1.1.0] - 2020-06-29
15 --------------------
16 * Send alarm on SDL failure (`RICAPP-117 <https://jira.o-ran-sc.org/browse/RICAPP-117>`_)
17 * Define configuration properties in xapp-descriptor controls section with JSON schema
18 * Requires RMR at version 4.1.2 or later
19 * Requires xapp-frame-py at version 1.3.0 or later
20
21
22 [1.0.9] - 2020-06-02
23 --------------------
24 * Change RMR listen port to 4560 (`RICAPP-112 <https://jira.o-ran-sc.org/browse/RICAPP-112>`_)
25
26
27 [1.0.8] - 2020-05-22
28 --------------------
29 * Revise static route table (`RICAPP-108 <https://jira.o-ran-sc.org/browse/RICAPP-108>`_)
30
31
32 [1.0.7] - 2020-05-15
33 --------------------
34 * Include xapp descriptor json in repo (`RICAPP-97 <https://jira.o-ran-sc.org/browse/RICAPP-97>`_)
35   
36
37 [1.0.6] - 2020-05-12
38 --------------------
39 * Decode values from SDL as JSON (`RICAPP-104 <https://jira.o-ran-sc.org/browse/RICAPP-104>`_)
40
41
42 [1.0.5] - 2020-05-08
43 --------------------
44
45 * Upgrade to RMR version 4.0.5
46 * Upgrade to framework version 1.1.0
47 * Use constants from rmr module instead of hardcoded strings
48 * Add Dockerfile-Unit-Test to support testing
49
50
51 [1.0.4] - 2020-05-05
52 --------------------
53
54 * Upgrade to RMR version 4.0.2
55
56
57 [1.0.3] - 2020-04-22
58 --------------------
59
60 * Upgrade to RMR version 3.8.2
61
62
63 [1.0.2] - 4/8/2020
64 ------------------
65
66 * Upgrade to xapp frame 1.0.0 which includes rmr python
67
68
69 [1.0.1] - 4/3/2020
70 ------------------
71
72 * Docker now builds with an empty route file so rmr starts; it will not even start properly without this
73 * Change how fake_sdl is activated for docker convienence
74 * Create dev guide file
75 * Add instructions on how to test the rmr healthcheck in a running container
76 * Update to xapp frame 0.7.0 (which has rmr healthchecks)
77
78
79 [1.0.0] - 4/1/2020
80 ------------------
81
82 * This release is seen as the first complete implementation of QPD, although likely fixes and enhancements are needed
83 * Implement the rmr messaging
84 * Add tests for various bad scenarios like UE IDs not existing and Cell data not existing
85 * Fix UE IDs to be strings as they are in the req slides
86
87
88 [0.2.0] - 3/27/2020
89 -------------------
90
91 * Implement SDL calls and testing
92 * Small cleanups
93
94
95 [0.1.0] - 3/26/2020
96 -------------------
97
98 * Implement the core business logic of the data merge
99
100
101 [0.0.2] - 3/25/2020
102 -------------------
103
104 * Move to SI95
105 * Move to Xapp frame 0.6.0
106 * Move to py38
107 * Remove unneeded stuff from setup.py since this is a docker component and not a pypi library
108 * Add some mock data for future development
109
110
111 [0.0.1] - 3/17/2020
112 -------------------
113
114 * inital skeleton creation