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