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
   4 Release Notes
   5 ===============
   6
   7 All notable changes to this project will be documented in this file.
   8
   9 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
  10 and this project adheres to `Semantic Versioning <http://semver.org/>`__.
  11
  12 .. contents::
  13    :depth: 3
  14    :local:
  15
  16
  17 [1.x.x] - TBD
  18
  19 ::
  20
  21     * Represents a resillent version of 1.0.0 that uses Redis for persistence
  22
  23 [1.0.4]
  24
  25 ::
  26
  27     * Only external change here is to healthcheck the rmr thread as part of a1s healthcheck. k8s will now respin a1 if that is failing.
  28     * Refactors (simplifies) how we wait for rmr initialization; it is now called as part of __init__
  29     * Refactors (simplifies) how the thread is actually launched; it is now internal to the object and also a part of __init__
  30     * Cleans up unit testing; a1rmr now exposes a replace_rcv_func; useful for unit testing, harmless if not called otherwise
  31     * Upgrades to rmr-python 1.0.0 for simpler message allocation
  32
  33 [1.0.3] - 10/22/2019
  34
  35 ::
  36
  37     * Move database cleanup (e.g., deleting instances based on statuses) into the polling loop
  38     * 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
  39     * 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
  40     * Bump rmr-python version, and bump rmr version
  41     * 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.
  42
  43 [1.0.2] - 10/17/2019
  44
  45 ::
  46
  47     * a1 now has a seperate, continuous polling thread
  48       this will enable operations like database cleanup (based on ACKs) and external notifications in real time,
  49       rather than when the API is invoked
  50     * all rmr send and receive operations are now in this thread
  51     * introduces a thread safe job queue between the two threads
  52     * Not done yet: database cleanups in the thread
  53     * Bump rmr python version
  54     * Clean up some logging
  55
  56 [1.0.1] - 10/15/2019
  57
  58 ::
  59
  60     * Moves the "database" access calls to mimick the SDL API, in preparation for moving to SDL
  61     * Does not yet actually use SDL or Redis, but the transition to those will be much shorter after this change.
  62
  63
  64 [1.0.0] - 10/7/2019
  65
  66 ::
  67
  68     * Represents v1.0.0 of the A1 API for O-RAN-SC Release A
  69     * Finished here:
  70       - Implement type DELETE
  71       - Clean up where policy instance cleanups happen
  72
  73
  74 [0.14.1] - 10/2/2019
  75 ::
  76
  77     * Upgrade rmr to 1.9.0
  78     * Upgrade rmr-python to 0.13.2
  79     * Use the new helpers module in rmr-python for the rec all functionality
  80     * 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
  81     * Fix a memory leak (python obj is garbage collected but not the underlying C memory allocation)
  82
  83
  84
  85 [0.14.0] - 10/1/2019
  86 ::
  87
  88     * Implement instance delete
  89     * Moves away from the status vector and now aggregates statuses
  90     * Pop through a1s mailbox "3x as often"; on all 3 kinds of instance GET since all such calls want the latest information
  91     * Misc cleanups in controller (closures ftw)
  92     * Add rmr-version.yaml for CICD jobs
  93
  94 [0.13.0] - 9/25/2019
  95 ::
  96
  97     * Implement GET all policy type ids
  98     * Implement GET all policy instance ids for a policy type
  99     * fix a tiny bug in integration test receiver
 100
 101
 102 [0.12.1] - 9/20/2019
 103 ::
 104
 105     * 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)
 106     * improve test receiver to behave with this setup
 107     * add integration test for this case
 108     * 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
 109     * improve integration tests overall
 110
 111
 112 [0.12.0] - 9/19/2019
 113 ::
 114
 115     * Implement type PUT
 116     * Implement type GET
 117     * Remove RIC manifest
 118     * Read type GET to get schema for instance PUT
 119     * Remove Utils (no longer needed)
 120     * lots more tests (unit and integration)
 121
 122 [0.11.0] - 9/17/2019
 123
 124 ::
 125
 126     * This is on the road to release 1.0.0. It is not meant to be tested (E2E) as it's own release
 127     * Implement the Release A spec in the openapi.yaml
 128     * Rework A1 to follow that spec
 129     * Remove rmr_mapping now that we use policyid as the mtype to send and a well known mtype for the ACKs
 130     * Add the delay receiver test to the tavern integration tests
 131     * Remove unneeded ENV variables from helm charts
 132     * Switch away from builder images to avoid quicksand; upgrade rmr at our own pace
 133
 134
 135 [0.10.3] - 8/20/2019
 136
 137 ::
 138
 139     * Update to later rmr-python
 140     * Add docs about upgrading rmr
 141     * remove bombarder since tavern runs apache bench
 142
 143
 144 [0.10.2] - 8/14/2019
 145
 146 ::
 147
 148     * Update to later rmr-python
 149
 150 [0.10.1] - 8/9/2019
 151
 152 ::
 153
 154     * Greatly reduce the size of A1 docker from 1.25GB to ~278MB.
 155     * Add a seperate dockerfile for unit testing
 156
 157
 158 [0.10.0] - 7/30/2019
 159
 160 ::
 161
 162    * Rename all /ric/ URLs to be consistent with requirements of /a1-p/
 163
 164
 165 [0.9.0] - 7/22/2019
 166 -------------------
 167
 168 ::
 169
 170    * Implement the GET on policies
 171    * 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).
 172
 173
 174 [0.8.4] - 7/16/2019
 175 -------------------
 176
 177 ::
 178
 179    * Fix the 400, which was in the API, but wasn't actually implemented
 180    * Update the test fixture manifests to reflect the latest adm control, paves way for next feature coming which is a policy GET
 181
 182
 183
 184 [0.8.3] - 6/18/2019
 185 -------------------
 186
 187 ::
 188
 189    * Use base Docker with NNG version 1.1.1
 190
 191
 192
 193 [0.8.2] - 6/5/2019
 194 -------------------
 195
 196 ::
 197
 198    * Upgrade RMR due to a bug that was preventing rmr from init in kubernetes
 199
 200
 201
 202 [0.8.1] - 5/31/2019
 203 -------------------
 204
 205 ::
 206
 207    * Run unit tests as part of docker build
 208
 209
 210
 211 [0.8.0] - 5/28/2019
 212 -------------------
 213
 214 ::
 215
 216    * Convert docs to appropriate format
 217    * Move rmr string to int mapping to a file
 218
 219
 220
 221 [0.7.2] - 5/24/2019
 222 -------------------
 223
 224 ::
 225
 226    * Use tavern to test the actual running docker container
 227    * Restructures the integration tests to run as a single tox command
 228    * Re-ogranizes the README and splits out the Developers guide, which is not needed by users.
 229
 230 .. _section-1:
 231
 232 [0.7.1] - 5/23/2019
 233 -------------------
 234
 235 ::
 236
 237    * 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
 238    * Adds a test "bombarding" script that tests this
 239
 240 .. _section-2:
 241
 242 [0.7.0] - 5/22/19
 243 -----------------
 244
 245 ::
 246
 247    * 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.
 248    * Fix a bug in the unit tests (found using a fresh container with no RIC manifest!)
 249    * Fix a (critical) bug in a1rmr due to a rename in the last iteration (RMR_ERR_RMR_RCV_RETRY_INTERVAL)
 250    * Make unit tests faster by setting envs in tox
 251    * Move to the now publically available rmr-python
 252    * Return a 400 if am xapp does not expect a body, but the PUT provides one
 253    * Adds a new test policy to the example RIC manifest and a new delayed receiver to test the aformentiond race condition
 254
 255 .. _section-3:
 256
 257 [0.6.0]
 258 -------
 259
 260 ::
 261
 262    * Upgrade to rmr 0.10.0
 263    * Fix bad api spec RE GET
 264    * 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
 265
 266 .. _section-4:
 267
 268 [0.5.1] - 5/13/2019
 269 -------------------
 270
 271 ::
 272
 273    * Rip some testing structures out of here that should have been in rmr (those are now in rmr 0.9.0, upgrade to that)
 274    * Run Python BLACK for formatting
 275
 276 .. _section-5:
 277
 278 [0.5.0] - 5/10/2019
 279 -------------------
 280
 281 ::
 282
 283    * Fix a blocking execution bug by moving from rmr's timeout to a non blocking call + retry loop + asyncronous sleep
 284    * Changes the ENV RMR_RCV_TIMEOUT to RMR_RCV_RETRY_INTERVAL
 285
 286 .. _section-6:
 287
 288 [0.4.0] - 5/9.2019
 289 ------------------
 290
 291 ::
 292
 293    * Update to rmr 0.8.3
 294    * Change 503 to 504 for the case where downstream does not reply, per recommendation
 295    * Add a 502 with different reasons if the xapp replies but with a bad/malformed/missing status
 296    * Make testing much more modular, in anticipating of moving some unit test functionality into rmr itself
 297
 298 .. _section-7:
 299
 300 [0.3.4] - 5/8/2019
 301 ------------------
 302
 303 ::
 304
 305    * Crash immediately if manifest isn't mounted
 306    * Add unit tests for utils
 307    * Add missing lic
 308
 309 .. _section-8:
 310
 311 [0.3.3]
 312 -------
 313
 314 ::
 315
 316    * Upgrade A1 to rmr 0.8.0
 317    * Go from deb RMR installation to git
 318    * Remove obnoxious receiver logging
 319
 320 .. _section-9:
 321
 322 [0.3.2]
 323 -------
 324
 325 ::
 326
 327    * Upgrade A1 to rmr 0.6.0
 328
 329 .. _section-10:
 330
 331 [0.3.1]
 332 -------
 333
 334 ::
 335
 336    * Add license headers
 337
 338 .. _section-11:
 339
 340 [0.3.0]
 341 -------
 342
 343 ::
 344
 345    * Introduce RIC Manifest
 346    * Move some testing functionality into a helper module
 347    * Read the policyname to rmr type mapping from manifest
 348    * Do PUT payload validation based on the manifest
 349
 350 .. _section-12:
 351
 352 [0.2.0]
 353 -------
 354
 355 ::
 356
 357    * Bump rmr python dep version
 358    * Include a Dockerized test receiver
 359    * Stencil out the mising GET
 360    * Update the OpenAPI
 361    * Include a test docker compose file
 362
 363 .. _section-13:
 364
 365 [0.1.0]
 366 -------
 367
 368 ::
 369
 370    * Initial Implementation