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