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