1 .. ==================================================================================
2 .. Copyright (c) 2019 Nokia
3 .. Copyright (c) 2018-2019 AT&T Intellectual Property.
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
9 .. http://www.apache.org/licenses/LICENSE-2.0
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 .. ==================================================================================
18 A1 Mediator Release Notes
19 =========================
21 All notable changes to this project will be documented in this file.
23 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
24 and this project adheres to `Semantic Versioning <http://semver.org/>`__.
30 * Represents a resillent version of 1.0.0 that uses Redis for persistence
36 * Move database cleanup (e.g., deleting instances based on statuses) into the polling loop
37 * Rework how unit testing works with the polling loop; prior, exceptions were being thrown silently from the thread but not printed. The polling thread has now been paramaterized with override functions for the purposes of testing
38 * Make type cleanup more efficient since we know exactly what instances were touched, and it's inefficient to iterate over all instances if they were not
39 * Bump rmr-python version, and bump rmr version
40 * Still an item left to do in this work; refactor the thread slightly to tie in a healthcheck with a1s healthcheck. We need k8s to restart a1 if that thread dies too.
46 * a1 now has a seperate, continuous polling thread
47 this will enable operations like database cleanup (based on ACKs) and external notifications in real time,
48 rather than when the API is invoked
49 * all rmr send and receive operations are now in this thread
50 * introduces a thread safe job queue between the two threads
51 * Not done yet: database cleanups in the thread
52 * Bump rmr python version
53 * Clean up some logging
59 * Moves the "database" access calls to mimick the SDL API, in preparation for moving to SDL
60 * Does not yet actually use SDL or Redis, but the transition to those will be much shorter after this change.
67 * Represents v1.0.0 of the A1 API for O-RAN-SC Release A
69 - Implement type DELETE
70 - Clean up where policy instance cleanups happen
76 * Upgrade rmr to 1.9.0
77 * Upgrade rmr-python to 0.13.2
78 * Use the new helpers module in rmr-python for the rec all functionality
79 * Switch rmr mode to a multithreaded mode that continuously reads from rmr and populates an internal queue of messages with a deterministic queue size (2048) which is better behavior for A1
80 * Fix a memory leak (python obj is garbage collected but not the underlying C memory allocation)
87 * Implement instance delete
88 * Moves away from the status vector and now aggregates statuses
89 * Pop through a1s mailbox "3x as often"; on all 3 kinds of instance GET since all such calls want the latest information
90 * Misc cleanups in controller (closures ftw)
91 * Add rmr-version.yaml for CICD jobs
96 * Implement GET all policy type ids
97 * Implement GET all policy instance ids for a policy type
98 * fix a tiny bug in integration test receiver
103 * 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)
104 * improve test receiver to behave with this setup
105 * add integration test for this case
106 * 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
107 * improve integration tests overall
115 * Remove RIC manifest
116 * Read type GET to get schema for instance PUT
117 * Remove Utils (no longer needed)
118 * lots more tests (unit and integration)
124 * This is on the road to release 1.0.0. It is not meant to be tested (E2E) as it's own release
125 * Implement the Release A spec in the openapi.yaml
126 * Rework A1 to follow that spec
127 * Remove rmr_mapping now that we use policyid as the mtype to send and a well known mtype for the ACKs
128 * Add the delay receiver test to the tavern integration tests
129 * Remove unneeded ENV variables from helm charts
130 * Switch away from builder images to avoid quicksand; upgrade rmr at our own pace
137 * Update to later rmr-python
138 * Add docs about upgrading rmr
139 * remove bombarder since tavern runs apache bench
146 * Update to later rmr-python
152 * Greatly reduce the size of A1 docker from 1.25GB to ~278MB.
153 * Add a seperate dockerfile for unit testing
160 * Rename all /ric/ URLs to be consistent with requirements of /a1-p/
168 * Implement the GET on policies
169 * 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).
177 * Fix the 400, which was in the API, but wasn't actually implemented
178 * Update the test fixture manifests to reflect the latest adm control, paves way for next feature coming which is a policy GET
187 * Use base Docker with NNG version 1.1.1
196 * Upgrade RMR due to a bug that was preventing rmr from init in kubernetes
205 * Run unit tests as part of docker build
214 * Convert docs to appropriate format
215 * Move rmr string to int mapping to a file
224 * Use tavern to test the actual running docker container
225 * Restructures the integration tests to run as a single tox command
226 * Re-ogranizes the README and splits out the Developers guide, which is not needed by users.
235 * 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
236 * Adds a test "bombarding" script that tests this
245 * 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.
246 * Fix a bug in the unit tests (found using a fresh container with no RIC manifest!)
247 * Fix a (critical) bug in a1rmr due to a rename in the last iteration (RMR_ERR_RMR_RCV_RETRY_INTERVAL)
248 * Make unit tests faster by setting envs in tox
249 * Move to the now publically available rmr-python
250 * Return a 400 if am xapp does not expect a body, but the PUT provides one
251 * Adds a new test policy to the example RIC manifest and a new delayed receiver to test the aformentiond race condition
260 * Upgrade to rmr 0.10.0
261 * Fix bad api spec RE GET
262 * 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
271 * Rip some testing structures out of here that should have been in rmr (those are now in rmr 0.9.0, upgrade to that)
272 * Run Python BLACK for formatting
281 * Fix a blocking execution bug by moving from rmr's timeout to a non blocking call + retry loop + asyncronous sleep
282 * Changes the ENV RMR_RCV_TIMEOUT to RMR_RCV_RETRY_INTERVAL
291 * Update to rmr 0.8.3
292 * Change 503 to 504 for the case where downstream does not reply, per recommendation
293 * Add a 502 with different reasons if the xapp replies but with a bad/malformed/missing status
294 * Make testing much more modular, in anticipating of moving some unit test functionality into rmr itself
303 * Crash immediately if manifest isn't mounted
304 * Add unit tests for utils
314 * Upgrade A1 to rmr 0.8.0
315 * Go from deb RMR installation to git
316 * Remove obnoxious receiver logging
325 * Upgrade A1 to rmr 0.6.0
334 * Add license headers
343 * Introduce RIC Manifest
344 * Move some testing functionality into a helper module
345 * Read the policyname to rmr type mapping from manifest
346 * Do PUT payload validation based on the manifest
355 * Bump rmr python dep version
356 * Include a Dockerized test receiver
357 * Stencil out the mising GET
359 * Include a test docker compose file
368 * Initial Implementation