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