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