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 .. Copyright (C) 2019 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 .. contents::
  14    :depth: 3
  15    :local:
  16
  17 [2.1.1] - 1/14/2020
  18 -------------------
  19
  20 ::
  21
  22     * Upgrades from sdl 1.0.0 to 2.0.2
  23     * Delete a1test_helpers because SDL 2.0.2 provides the mockup we need
  24     * Remove general catch all from A1
  25
  26 [2.1.0] - 1/8/2020
  27 ------------------
  28
  29 ::
  30
  31     * Represents a resillent version of 2.0.0 that uses Redis for persistence
  32     * Now relies on SDL and dbaas; SDL is the python interface library to dbaas
  33     * Adds a 503 http code to nearly all http methods, as A1 now depends on an upstream system
  34     * Integration tests have a copy of a dbaas helm chart, however the goal is to simplify that deployment per https://jira.o-ran-sc.org/browse/RIC-45
  35     * Unit tests have a mockup of SDL, however again the goal is to simplify as SDL grows per https://jira.o-ran-sc.org/browse/RIC-44
  36
  37 [2.0.0] - 12/9/2019
  38 -------------------
  39
  40 ::
  41
  42     * Implements new logic around when instances are deleted. See flowcharts in docs/. Basically timeouts now trigger to actually delete instances from a1s database, and these timeouts are configurable.
  43     * Eliminates the barrier to deleting an instance when no xapp evdr replied (via timeouts)
  44     * Add two new ENV variables that control timeouts
  45     * Make unit tests more modular so new workflows can be tested easily
  46     * Fixes the API for ../status to return a richer structure. This is an (albeit tiny) API change.
  47     * Clean up unused items in the integration tests helm chart
  48     * Removed "RMR_RCV_RETRY_INTERVAL" leftovers since this isn't used anymore
  49     * Uses the standard RIC logging library
  50     * Switch the backend routing scheme to using subscription id with constant message types, per request.
  51     * Given the above, policy type ids can be any valid 32bit greater than 0
  52     * Decouple the API between northbound and A1 from A1 with xapps. This is now two seperate OpenAPI files
  53     * Update example for AC Xapp
  54     * Updgrade rmr and rmr-python to utilize new features; lots of cleanups because of that
  55     * Implements a POLICY QUERY feature where A1 listens for queries for a policy type. A1 then responds via multiple RTS messages every policy instance of that policy type (and expects an ACK back from xapps as usual). This feature can be used for xapp recovery etc.
  56
  57 [1.0.4]
  58 -------
  59
  60 ::
  61
  62     * Only external change here is to healthcheck the rmr thread as part of a1s healthcheck. k8s will now respin a1 if that is failing.
  63     * Refactors (simplifies) how we wait for rmr initialization; it is now called as part of __init__
  64     * Refactors (simplifies) how the thread is actually launched; it is now internal to the object and also a part of __init__
  65     * Cleans up unit testing; a1rmr now exposes a replace_rcv_func; useful for unit testing, harmless if not called otherwise
  66     * Upgrades to rmr-python 1.0.0 for simpler message allocation
  67
  68 [1.0.3] - 10/22/2019
  69 --------------------
  70
  71 ::
  72
  73     * Move database cleanup (e.g., deleting instances based on statuses) into the polling loop
  74     * 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
  75     * 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
  76     * Bump rmr-python version, and bump rmr version
  77     * 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.
  78
  79 [1.0.2] - 10/17/2019
  80 --------------------
  81
  82 ::
  83
  84     * a1 now has a seperate, continuous polling thread
  85       this will enable operations like database cleanup (based on ACKs) and external notifications in real time,
  86       rather than when the API is invoked
  87     * all rmr send and receive operations are now in this thread
  88     * introduces a thread safe job queue between the two threads
  89     * Not done yet: database cleanups in the thread
  90     * Bump rmr python version
  91     * Clean up some logging
  92
  93 [1.0.1] - 10/15/2019
  94 --------------------
  95
  96 ::
  97
  98     * Moves the "database" access calls to mimick the SDL API, in preparation for moving to SDL
  99     * Does not yet actually use SDL or Redis, but the transition to those will be much shorter after this change.
 100
 101
 102 [1.0.0] - 10/7/2019
 103 -------------------
 104
 105 ::
 106
 107     * Represents v1.0.0 of the A1 API for O-RAN-SC Release A
 108     * Finished here:
 109       - Implement type DELETE
 110       - Clean up where policy instance cleanups happen
 111
 112
 113 [0.14.1] - 10/2/2019
 114 --------------------
 115
 116 ::
 117
 118     * Upgrade rmr to 1.9.0
 119     * Upgrade rmr-python to 0.13.2
 120     * Use the new helpers module in rmr-python for the rec all functionality
 121     * 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
 122     * Fix a memory leak (python obj is garbage collected but not the underlying C memory allocation)
 123
 124
 125
 126 [0.14.0] - 10/1/2019
 127 --------------------
 128
 129 ::
 130
 131     * Implement instance delete
 132     * Moves away from the status vector and now aggregates statuses
 133     * Pop through a1s mailbox "3x as often"; on all 3 kinds of instance GET since all such calls want the latest information
 134     * Misc cleanups in controller (closures ftw)
 135     * Add rmr-version.yaml for CICD jobs
 136
 137 [0.13.0] - 9/25/2019
 138 --------------------
 139
 140 ::
 141
 142     * Implement GET all policy type ids
 143     * Implement GET all policy instance ids for a policy type
 144     * fix a tiny bug in integration test receiver
 145
 146
 147 [0.12.1] - 9/20/2019
 148 --------------------
 149
 150 ::
 151
 152     * 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)
 153     * improve test receiver to behave with this setup
 154     * add integration test for this case
 155     * 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
 156     * improve integration tests overall
 157
 158
 159 [0.12.0] - 9/19/2019
 160 --------------------
 161
 162 ::
 163
 164     * Implement type PUT
 165     * Implement type GET
 166     * Remove RIC manifest
 167     * Read type GET to get schema for instance PUT
 168     * Remove Utils (no longer needed)
 169     * lots more tests (unit and integration)
 170
 171 [0.11.0] - 9/17/2019
 172 --------------------
 173
 174 ::
 175
 176     * This is on the road to release 1.0.0. It is not meant to be tested (E2E) as it's own release
 177     * Implement the Release A spec in the openapi.yaml
 178     * Rework A1 to follow that spec
 179     * Remove rmr_mapping now that we use policyid as the mtype to send and a well known mtype for the ACKs
 180     * Add the delay receiver test to the tavern integration tests
 181     * Remove unneeded ENV variables from helm charts
 182     * Switch away from builder images to avoid quicksand; upgrade rmr at our own pace
 183
 184
 185 [0.10.3] - 8/20/2019
 186 --------------------
 187
 188 ::
 189
 190     * Update to later rmr-python
 191     * Add docs about upgrading rmr
 192     * remove bombarder since tavern runs apache bench
 193
 194
 195 [0.10.2] - 8/14/2019
 196 --------------------
 197
 198 ::
 199
 200     * Update to later rmr-python
 201
 202 [0.10.1] - 8/9/2019
 203 -------------------
 204
 205 ::
 206
 207     * Greatly reduce the size of A1 docker from 1.25GB to ~278MB.
 208     * Add a seperate dockerfile for unit testing
 209
 210
 211 [0.10.0] - 7/30/2019
 212 --------------------
 213
 214 ::
 215
 216    * Rename all /ric/ URLs to be consistent with requirements of /a1-p/
 217
 218
 219 [0.9.0] - 7/22/2019
 220 -------------------
 221
 222 ::
 223
 224    * Implement the GET on policies
 225    * 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).
 226
 227
 228 [0.8.4] - 7/16/2019
 229 -------------------
 230
 231 ::
 232
 233    * Fix the 400, which was in the API, but wasn't actually implemented
 234    * Update the test fixture manifests to reflect the latest adm control, paves way for next feature coming which is a policy GET
 235
 236
 237
 238 [0.8.3] - 6/18/2019
 239 -------------------
 240
 241 ::
 242
 243    * Use base Docker with NNG version 1.1.1
 244
 245
 246
 247 [0.8.2] - 6/5/2019
 248 ------------------
 249
 250 ::
 251
 252    * Upgrade RMR due to a bug that was preventing rmr from init in kubernetes
 253
 254
 255
 256 [0.8.1] - 5/31/2019
 257 -------------------
 258
 259 ::
 260
 261    * Run unit tests as part of docker build
 262
 263
 264
 265 [0.8.0] - 5/28/2019
 266 -------------------
 267
 268 ::
 269
 270    * Convert docs to appropriate format
 271    * Move rmr string to int mapping to a file
 272
 273
 274
 275 [0.7.2] - 5/24/2019
 276 -------------------
 277
 278 ::
 279
 280    * Use tavern to test the actual running docker container
 281    * Restructures the integration tests to run as a single tox command
 282    * Re-ogranizes the README and splits out the Developers guide, which is not needed by users.
 283
 284
 285 [0.7.1] - 5/23/2019
 286 -------------------
 287
 288 ::
 289
 290    * 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
 291    * Adds a test "bombarding" script that tests this
 292
 293
 294 [0.7.0] - 5/22/19
 295 -----------------
 296
 297 ::
 298
 299    * 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.
 300    * Fix a bug in the unit tests (found using a fresh container with no RIC manifest!)
 301    * Fix a (critical) bug in a1rmr due to a rename in the last iteration (RMR_ERR_RMR_RCV_RETRY_INTERVAL)
 302    * Make unit tests faster by setting envs in tox
 303    * Move to the now publically available rmr-python
 304    * Return a 400 if am xapp does not expect a body, but the PUT provides one
 305    * Adds a new test policy to the example RIC manifest and a new delayed receiver to test the aformentiond race condition
 306
 307
 308 [0.6.0]
 309 -------
 310
 311 ::
 312
 313    * Upgrade to rmr 0.10.0
 314    * Fix bad api spec RE GET
 315    * 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
 316
 317
 318 [0.5.1] - 5/13/2019
 319 -------------------
 320
 321 ::
 322
 323    * Rip some testing structures out of here that should have been in rmr (those are now in rmr 0.9.0, upgrade to that)
 324    * Run Python BLACK for formatting
 325
 326
 327 [0.5.0] - 5/10/2019
 328 -------------------
 329
 330 ::
 331
 332    * Fix a blocking execution bug by moving from rmr's timeout to a non blocking call + retry loop + asyncronous sleep
 333    * Changes the ENV RMR_RCV_TIMEOUT to RMR_RCV_RETRY_INTERVAL
 334
 335
 336 [0.4.0] - 5/9.2019
 337 ------------------
 338
 339 ::
 340
 341    * Update to rmr 0.8.3
 342    * Change 503 to 504 for the case where downstream does not reply, per recommendation
 343    * Add a 502 with different reasons if the xapp replies but with a bad/malformed/missing status
 344    * Make testing much more modular, in anticipating of moving some unit test functionality into rmr itself
 345
 346
 347 [0.3.4] - 5/8/2019
 348 ------------------
 349
 350 ::
 351
 352    * Crash immediately if manifest isn't mounted
 353    * Add unit tests for utils
 354    * Add missing lic
 355
 356
 357 [0.3.3]
 358 -------
 359
 360 ::
 361
 362    * Upgrade A1 to rmr 0.8.0
 363    * Go from deb RMR installation to git
 364    * Remove obnoxious receiver logging
 365
 366
 367 [0.3.2]
 368 -------
 369
 370 ::
 371
 372    * Upgrade A1 to rmr 0.6.0
 373
 374
 375 [0.3.1]
 376 -------
 377
 378 ::
 379
 380    * Add license headers
 381
 382
 383 [0.3.0]
 384 -------
 385
 386 ::
 387
 388    * Introduce RIC Manifest
 389    * Move some testing functionality into a helper module
 390    * Read the policyname to rmr type mapping from manifest
 391    * Do PUT payload validation based on the manifest
 392
 393
 394 [0.2.0]
 395 -------
 396
 397 ::
 398
 399    * Bump rmr python dep version
 400    * Include a Dockerized test receiver
 401    * Stencil out the mising GET
 402    * Update the OpenAPI
 403    * Include a test docker compose file
 404
 405
 406 [0.1.0]
 407 -------
 408
 409 ::
 410
 411    * Initial Implementation