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