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