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