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