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