docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 Release Notes
   5 ===============
   6
   7 All notable changes to this project will be documented in this file.
   8
   9 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
  10 and this project adheres to `Semantic Versioning <http://semver.org/>`__.
  11
  12 .. contents::
  13    :depth: 3
  14    :local:
  15
  16
  17 [1.x.x] - TBD
  18 -------------
  19
  20 ::
  21
  22     * Represents a resillent version of 1.0.0 that uses Redis for persistence
  23
  24 [1.0.4] - 10/24/2019
  25 --------------------
  26
  27 ::
  28
  29     * Only external change here is to healthcheck the rmr thread as part of a1s healthcheck. k8s will now respin a1 if that is failing.
  30     * Refactors (simplifies) how we wait for rmr initialization; it is now called as part of __init__
  31     * Refactors (simplifies) how the thread is actually launched; it is now internal to the object and also a part of __init__
  32     * Cleans up unit testing; a1rmr now exposes a replace_rcv_func; useful for unit testing, harmless if not called otherwise
  33     * Upgrades to rmr-python 1.0.0 for simpler message allocation
  34
  35 [1.0.3] - 10/22/2019
  36 --------------------
  37
  38 ::
  39
  40     * Move database cleanup (e.g., deleting instances based on statuses) into the polling loop
  41     * Rework how unit testing works with the polling loop; prior, exceptions were being thrown silently from the thread but not printed. The polling thread has now been paramaterized with override functions for the purposes of testing
  42     * Make type cleanup more efficient since we know exactly what instances were touched, and it's inefficient to iterate over all instances if they were not
  43     * Bump rmr-python version, and bump rmr version
  44     * Still an item left to do in this work; refactor the thread slightly to tie in a healthcheck with a1s healthcheck. We need k8s to restart a1 if that thread dies too.
  45
  46 [1.0.2] - 10/17/2019
  47 --------------------
  48
  49 ::
  50
  51     * a1 now has a seperate, continuous polling thread
  52       this will enable operations like database cleanup (based on ACKs) and external notifications in real time,
  53       rather than when the API is invoked
  54     * all rmr send and receive operations are now in this thread
  55     * introduces a thread safe job queue between the two threads
  56     * Not done yet: database cleanups in the thread
  57     * Bump rmr python version
  58     * Clean up some logging
  59
  60 [1.0.1] - 10/15/2019
  61 --------------------
  62
  63 ::
  64
  65     * Moves the "database" access calls to mimick the SDL API, in preparation for moving to SDL
  66     * Does not yet actually use SDL or Redis, but the transition to those will be much shorter after this change.
  67
  68
  69 [1.0.0] - 10/7/2019
  70 -------------------
  71
  72 ::
  73
  74     * Represents v1.0.0 of the A1 API for O-RAN-SC Release A
  75     * Finished here:
  76       - Implement type DELETE
  77       - Clean up where policy instance cleanups happen
  78
  79
  80 [0.14.1] - 10/2/2019
  81 --------------------
  82
  83 ::
  84
  85     * Upgrade rmr to 1.9.0
  86     * Upgrade rmr-python to 0.13.2
  87     * Use the new helpers module in rmr-python for the rec all functionality
  88     * Switch rmr mode to a multithreaded mode that continuously reads from rmr and populates an internal queue of messages with a deterministic queue size (2048) which is better behavior for A1
  89     * Fix a memory leak (python obj is garbage collected but not the underlying C memory allocation)
  90
  91
  92
  93 [0.14.0] - 10/1/2019
  94 --------------------
  95
  96 ::
  97
  98     * Implement instance delete
  99     * Moves away from the status vector and now aggregates statuses
 100     * Pop through a1s mailbox "3x as often"; on all 3 kinds of instance GET since all such calls want the latest information
 101     * Misc cleanups in controller (closures ftw)
 102     * Add rmr-version.yaml for CICD jobs
 103
 104 [0.13.0] - 9/25/2019
 105 --------------------
 106
 107 ::
 108
 109     * Implement GET all policy type ids
 110     * Implement GET all policy instance ids for a policy type
 111     * fix a tiny bug in integration test receiver
 112
 113
 114 [0.12.1] - 9/20/2019
 115 --------------------
 116
 117 ::
 118
 119     * switch to rmr 1.8.1 to pick up a non blocking variant of rmr that deals with bad routing tables (no hanging connections / blocking calls)
 120     * improve test receiver to behave with this setup
 121     * add integration test for this case
 122     * this also switches past 1.5.x, which included another change that altered the behavior of rts; deal with this with a change to a1s helmchart (env: `RMR_SRC_ID`) that causes the sourceid to be set to a1s service name, which was not needed prior
 123     * improve integration tests overall
 124
 125
 126 [0.12.0] - 9/19/2019
 127 --------------------
 128
 129 ::
 130
 131     * Implement type PUT
 132     * Implement type GET
 133     * Remove RIC manifest
 134     * Read type GET to get schema for instance PUT
 135     * Remove Utils (no longer needed)
 136     * lots more tests (unit and integration)
 137
 138 [0.11.0] - 9/17/2019
 139 --------------------
 140
 141 ::
 142
 143     * This is on the road to release 1.0.0. It is not meant to be tested (E2E) as it's own release
 144     * Implement the Release A spec in the openapi.yaml
 145     * Rework A1 to follow that spec
 146     * Remove rmr_mapping now that we use policyid as the mtype to send and a well known mtype for the ACKs
 147     * Add the delay receiver test to the tavern integration tests
 148     * Remove unneeded ENV variables from helm charts
 149     * Switch away from builder images to avoid quicksand; upgrade rmr at our own pace
 150
 151
 152 [0.10.3] - 8/20/2019
 153 --------------------
 154
 155 ::
 156
 157     * Update to later rmr-python
 158     * Add docs about upgrading rmr
 159     * remove bombarder since tavern runs apache bench
 160
 161
 162 [0.10.2] - 8/14/2019
 163 --------------------
 164
 165 ::
 166
 167     * Update to later rmr-python
 168
 169 [0.10.1] - 8/9/2019
 170 -------------------
 171
 172 ::
 173
 174     * Greatly reduce the size of A1 docker from 1.25GB to ~278MB.
 175     * Add a seperate dockerfile for unit testing
 176
 177
 178 [0.10.0] - 7/30/2019
 179 --------------------
 180
 181 ::
 182
 183    * Rename all /ric/ URLs to be consistent with requirements of /a1-p/
 184
 185
 186 [0.9.0] - 7/22/2019
 187 -------------------
 188
 189 ::
 190
 191    * Implement the GET on policies
 192    * Add a new endpoint for healthcheck. NOTE, it has been decided by oran architecture documents that this policy interface should be named a1-p in all URLS. In a future release the existing URLs will be renamed (existing URLs were not changed in this release).
 193
 194
 195 [0.8.4] - 7/16/2019
 196 -------------------
 197
 198 ::
 199
 200    * Fix the 400, which was in the API, but wasn't actually implemented
 201    * Update the test fixture manifests to reflect the latest adm control, paves way for next feature coming which is a policy GET
 202
 203
 204
 205 [0.8.3] - 6/18/2019
 206 -------------------
 207
 208 ::
 209
 210    * Use base Docker with NNG version 1.1.1
 211
 212
 213
 214 [0.8.2] - 6/5/2019
 215 ------------------
 216
 217 ::
 218
 219    * Upgrade RMR due to a bug that was preventing rmr from init in kubernetes
 220
 221
 222
 223 [0.8.1] - 5/31/2019
 224 -------------------
 225
 226 ::
 227
 228    * Run unit tests as part of docker build
 229
 230
 231
 232 [0.8.0] - 5/28/2019
 233 -------------------
 234
 235 ::
 236
 237    * Convert docs to appropriate format
 238    * Move rmr string to int mapping to a file
 239
 240
 241
 242 [0.7.2] - 5/24/2019
 243 -------------------
 244
 245 ::
 246
 247    * Use tavern to test the actual running docker container
 248    * Restructures the integration tests to run as a single tox command
 249    * Re-ogranizes the README and splits out the Developers guide, which is not needed by users.
 250
 251
 252 [0.7.1] - 5/23/2019
 253 -------------------
 254
 255 ::
 256
 257    * Adds a defense mechanism against A1 getting queue-overflowed with messages A1 doesnt care about; A1 now ignores all incoming messages it's not waiting for, so it's queue size should now always be "tiny", i.e., never exceeding the number of valid requests it's waiting for ACKs back for
 258    * Adds a test "bombarding" script that tests this
 259
 260
 261 [0.7.0] - 5/22/19
 262 -----------------
 263
 264 ::
 265
 266    * Main purpose of this change is to fix a potential race condition where A1 sends out M1 expecting ACK1, and while waiting for ACK1, sends out M2 expecting ACK2, but gets back ACK2, ACK1. Prior to this change, A1 may have eaten ACK2 and never fufilled the ACK1 request.
 267    * Fix a bug in the unit tests (found using a fresh container with no RIC manifest!)
 268    * Fix a (critical) bug in a1rmr due to a rename in the last iteration (RMR_ERR_RMR_RCV_RETRY_INTERVAL)
 269    * Make unit tests faster by setting envs in tox
 270    * Move to the now publically available rmr-python
 271    * Return a 400 if am xapp does not expect a body, but the PUT provides one
 272    * Adds a new test policy to the example RIC manifest and a new delayed receiver to test the aformentiond race condition
 273
 274
 275 [0.6.0]
 276 -------
 277
 278 ::
 279
 280    * Upgrade to rmr 0.10.0
 281    * Fix bad api spec RE GET
 282    * Fix a (big) bug where transactionid wasn't being checked, which wouldn't have worked on sending two policies to the same downstream policy handler
 283
 284
 285 [0.5.1] - 5/13/2019
 286 -------------------
 287
 288 ::
 289
 290    * Rip some testing structures out of here that should have been in rmr (those are now in rmr 0.9.0, upgrade to that)
 291    * Run Python BLACK for formatting
 292
 293
 294 [0.5.0] - 5/10/2019
 295 -------------------
 296
 297 ::
 298
 299    * Fix a blocking execution bug by moving from rmr's timeout to a non blocking call + retry loop + asyncronous sleep
 300    * Changes the ENV RMR_RCV_TIMEOUT to RMR_RCV_RETRY_INTERVAL
 301
 302
 303 [0.4.0] - 5/9.2019
 304 ------------------
 305
 306 ::
 307
 308    * Update to rmr 0.8.3
 309    * Change 503 to 504 for the case where downstream does not reply, per recommendation
 310    * Add a 502 with different reasons if the xapp replies but with a bad/malformed/missing status
 311    * Make testing much more modular, in anticipating of moving some unit test functionality into rmr itself
 312
 313
 314 [0.3.4] - 5/8/2019
 315 ------------------
 316
 317 ::
 318
 319    * Crash immediately if manifest isn't mounted
 320    * Add unit tests for utils
 321    * Add missing lic
 322
 323
 324 [0.3.3]
 325 -------
 326
 327 ::
 328
 329    * Upgrade A1 to rmr 0.8.0
 330    * Go from deb RMR installation to git
 331    * Remove obnoxious receiver logging
 332
 333
 334 [0.3.2]
 335 -------
 336
 337 ::
 338
 339    * Upgrade A1 to rmr 0.6.0
 340
 341
 342 [0.3.1]
 343 -------
 344
 345 ::
 346
 347    * Add license headers
 348
 349
 350 [0.3.0]
 351 -------
 352
 353 ::
 354
 355    * Introduce RIC Manifest
 356    * Move some testing functionality into a helper module
 357    * Read the policyname to rmr type mapping from manifest
 358    * Do PUT payload validation based on the manifest
 359
 360
 361 [0.2.0]
 362 -------
 363
 364 ::
 365
 366    * Bump rmr python dep version
 367    * Include a Dockerized test receiver
 368    * Stencil out the mising GET
 369    * Update the OpenAPI
 370    * Include a test docker compose file
 371
 372
 373 [0.1.0]
 374 -------
 375
 376 ::
 377
 378    * Initial Implementation