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