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