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