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 [3.2.2] - 2023-06-08
  14 --------------------
  15 * update RMR version to 4.9.1
  16
  17 [3.2.1] - 2022-12-12
  18 --------------------
  19 * small permission fix in python init files
  20
  21 [3.2.0] - 2022-06-16
  22 --------------------
  23 * Added REST E2 subscription support
  24 * rnib enhancements
  25 * REST service with health and config interface
  26
  27 [3.1.0] - 2022-03-22
  28 --------------------
  29 * Added the symptomdata module
  30
  31 [3.0.2] - 2021-12-17
  32 --------------------
  33 * Fix caching of error code data not happening (`RIC-862 <https://jira.o-ran-sc.org/browse/RIC-862>`_)
  34 * Improves performance of xapp-frame-py by caching the mapping dict of error codes.
  35
  36 [3.0.1] - 2021-12-07
  37 --------------------
  38 * Take configuration and rmr unit tests back into use after fixing the tests (`RIC-865 <https://jira.o-ran-sc.org/browse/RIC-865>`_)
  39 * Improve memory leak fix done in the version 3.0.0 to free memory also if python exception has been thrown.
  40
  41 [3.0.0] - 2021-12-03
  42 --------------------
  43 * Upgrade to RMR version 4.8.0 to fix memory leak in get_constants() function (`RIC-858 <https://jira.o-ran-sc.org/browse/RIC-858>`_)
  44 * From xapp-frame-py version 3.0.0 onwards it is required to have RMR version 4.8.0 or newer.
  45
  46 [2.3.0] - 2021-09-15
  47 --------------------
  48 * Add Xapp Registration (`RIC-706 <https://jira.o-ran-sc.org/browse/RIC-706>`_)
  49 * Integrate pylog (https://gerrit.o-ran-sc.org/r/admin/repos/com/pylog) with xapp-frame-py (`RIC-330 <https://jira.o-ran-sc.org/browse/RIC-330>`_)
  50
  51 [2.2.0] - 2021-06-23
  52 --------------------
  53 * Add E2AP package (`RIC-664 <https://jira.o-ran-sc.org/browse/RIC-664>`_)
  54
  55
  56 [2.1.0] - 2021-06-18
  57 --------------------
  58 * Add `RNIB <https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/nodeb-rnib>`_ feature (`RIC-788 <https://jira.o-ran-sc.org/browse/RIC-788>`_)
  59
  60
  61 [2.0.0] - 2021-06-14
  62 --------------------
  63 * Add Xapp registration/deregistration APIs (`RIC-706 <https://jira.o-ran-sc.org/browse/RIC-706>`_)
  64 * Upgrade SDL 3.0.0 version, SDL scaling (`RIC-699 <https://jira.o-ran-sc.org/browse/RIC-699>`_)
  65 * Upgrade SDL 3.0.0 version, notification fix (`RIC-795 <https://jira.o-ran-sc.org/browse/RIC-795>`_)
  66
  67
  68 [1.6.0] - 2020-10-23
  69 --------------------
  70 * Add SDL wrapping API (`RIC-659 <https://jira.o-ran-sc.org/browse/RIC-659>`_)
  71
  72
  73 [1.5.0] - 2020-07-10
  74 --------------------
  75 * Add Metrics API (`RIC-381 <https://jira.o-ran-sc.org/browse/RIC-381>`_)
  76
  77
  78 [1.4.0] - 2020-07-06
  79 --------------------
  80 * Revise Alarm manager to send via RMR wormhole (`RIC-529 <https://jira.o-ran-sc.org/browse/RIC-529>`_)
  81
  82
  83 [1.3.0] - 2020-06-24
  84 --------------------
  85 * Add configuration-change API (`RIC-425 <https://jira.o-ran-sc.org/browse/RIC-425>`_)
  86
  87
  88 [1.2.1] - 2020-06-22
  89 --------------------
  90 * Revise alarm message type (`RIC-514 <https://jira.o-ran-sc.org/browse/RIC-514>`_)
  91
  92
  93 [1.2.0] - 2020-06-04
  94 --------------------
  95 * Extend RMR module to support wormhole methods
  96 * Add alarm API (`RIC-380 <https://jira.o-ran-sc.org/browse/RIC-380>`_)
  97
  98
  99 [1.1.2] - 2020-05-13
 100 --------------------
 101 * Extend and publish class and method documentation as user guide in RST
 102
 103
 104 [1.1.1] - 2020-05-07
 105 --------------------
 106 * Use timeout on queue get method to avoid 100% CPU usage (`RIC-354 <https://jira.o-ran-sc.org/browse/RIC-354>`_)
 107 * Upgrade to RMR version 4.0.5
 108
 109
 110 [1.1.0] - 2020-05-06
 111 --------------------
 112 * Use RMR timeout on receive to avoid 100% CPU usage (`RIC-354 <https://jira.o-ran-sc.org/browse/RIC-354>`_)
 113 * Publish message-summary dict keys as constants to avoid hardcoding strings
 114 * Add wrapper and test for RMR method rmr_set_vlevel(int)
 115
 116
 117 [1.0.3] - 2020-04-29
 118 --------------------
 119 * Upgrade to RMR version 4.0.2
 120
 121
 122 [1.0.2] - 2020-04-22
 123 --------------------
 124 * Upgrade to RMR version 3.8.0
 125
 126
 127 [1.0.1] - 2020-04-10
 128 --------------------
 129 * Publish API documentation using Sphinx autodoc, which required
 130   changes so Sphinx can run when the RMR .so file is not available,
 131   such as during a ReadTheDocs build.
 132 * Create new subpackage rmr/rmrclib with the C library loaded via
 133   ctypes.
 134 * Extend sphinx configuration to mock the new rmrclib subpackage
 135 * Add method to get constants from RMR library and detect mock
 136   objects to work around a bug in Sphinx 3.0.0.
 137 * Split test files into test_rmr and test_rmrclib.
 138 * Add function to define argtype and restype values for library functions
 139 * Configure intersphinx link for RMR man pages at ReadTheDocs.io
 140
 141
 142 [1.0.0] - 4/6/2020
 143 ------------------
 144 * Python rmr has been moved into this repo. The module name has NOT
 145   changed in order to make the transition for repos very easy. The
 146   only transition needed should be prefixing rmr with ricxappframe in
 147   import statements, and to include this rather than rmr in setup.
 148
 149
 150 [0.7.0] - 4/2/2020
 151 ------------------
 152 * RMRXapps by default now implement the rmr healthcheck probe;
 153   users can also override it with a more complex handler if they
 154   wish
 155 * Fix a bug in the unit tests where a payload mismatch wouldn't
 156   actually fail the test (would now)
 157
 158
 159 [0.6.0] - 3/23/2020
 160 -------------------
 161 * Switch to SI95 for rmr
 162
 163
 164 [0.5.0] - 3/18/2020
 165 -------------------
 166 * All xapps (via the base class) now have a logger attribute that can
 167   be invoked to provide mdc logging. It is a passthrough to the RIC
 168   mdc logger for python (untouched, no value in an API on top at the
 169   current time).
 170
 171
 172 [0.4.1] - 3/17/2020
 173 -------------------
 174 * Switch tox to use py38
 175 * switch to latest builders
 176
 177
 178 [0.4.0] - 3/13/2020
 179 -------------------
 180 * Minor breaking change; switches the default behavior RE
 181   threading for RMRXapps. The default is not to return execution,
 182   but the caller (in `run`) can choose to loop in a thread.
 183 * Add Dockerized examples
 184
 185
 186 [0.3.0] - 3/10/2020
 187 -------------------
 188 * Large change to the "feel" of this framework: rather than subclass
 189   instantiation, xapps now use initialization and registration
 190   functions to register handlers
 191 * rmr xapps can now register handlers for specific message types (and
 192   they must prodive a default callback); if the user does this then
 193   "message to function routing" is now handled by the framework itself
 194 * RMRXapp now runs the polling loop in a thread, and returns execution
 195   back to the caller. The user is then free to loop, or do nothing,
 196   and call stop() when they want.
 197 * Raises tox coverage minimum to 70 from 50 (currently at 86)
 198
 199
 200 [0.2.0] - 3/3/2020
 201 ------------------
 202 * now allows for RMRXapps to call code before entering the infinite
 203   loop
 204 * stop is now called before throwing NotImplemented in the case where
 205   the client fails to provide a must have callback; this ensures there
 206   is no dangling rmr thread
 207 * stop now calls rmr_close to correctly free up any port(s)
 208 * (breaking) renames `loop` to `entrypoint` since the function does
 209   not have to contain a loop (though it most likely does)
 210 * Changes wording around the two types of xapps (docs only)
 211 * Uses a new version of rmr python that crashes when the rmr mrc fails
 212   to init, which prevents an xapp trying to use an unusable rmr
 213 * more unit test code coverage
 214 * Adds more fields to setup like long_desc and classifiers so the pypi
 215   page looks nicer
 216 * Removes a bad release file (will be added back in subseq. commit)
 217
 218
 219 [0.1.0] - 2/27/2020
 220 -------------------
 221 * Initial commit