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