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