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