docs/release-notes.rst

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