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