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