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