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