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