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