1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (C) 2019 AT&T Intellectual Property
8 All notable changes to this project will be documented in this file.
10 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
11 and this project adheres to `Semantic Versioning <http://semver.org/>`__.
14 * Reference RMR version 4.4.6 via the builder image.
19 * Add counters of create/update/delete actions on policy types and instances
20 * Add Prometheus /metrics endpoint to report counter data
26 * Fix _send_msg method to free allocated RMR message buffers
27 * Adjust send-message methods to retry only on RMR_ERR_RETRY
28 * Extend send-message methods to log message state after send
29 * Use constants from ricxappframe.rmr instead of hardcoded strings
30 * Upgrade RMR to version 4.0.5
31 * Upgrade tavern to version 1.2.2
32 * Extend user guide with southbound API schemas
38 * Revise Dockerfile to set user as owner of .local dir with a1 package
39 * Rename console shell start script to run-a1 from run.py
40 * Extend start script to report webserver listening port
41 * Add tiny RMR routing table for use in demo and test
42 * Extend documentation for running a container locally
43 * Add documentation of start/init parameters to _RmrLoop class
44 * Add new environment variable USE_FAKE_SDL (`RIC-351 <https://jira.o-ran-sc.org/browse/RIC-351>`_)
45 * Respond with error if policy type ID differs from ID in object on create
46 * Upgrade integration tests to use Tavern version 1.0.0
52 * Upgrade to rmr 4.0.2
53 * Upgrade integration tests to xapp-frame-go version 0.4.8 which drops NNG
54 * Extend exception handler to return error details in HTTP response
55 * Ensure that policy type ID on path matches ID in object
56 * Add OpenAPI spec to RST documentation
63 * Switch to using rmr in the ricxappframe
70 * Switch to SI95 from NNG (rmr v3 vs rmr v1)
71 * The switch to SI95 led to a rabbit hole in which we eventually discovered that rmr_send may sometimes block for an arbitrary period of time. Because of this issue, a1's sends are now threaded. Please see the longer comment about this in a1rmr.
72 * Bump version of py xapp frame (SDL used only) in A1
73 * Bump version of go xapp frame (0.0.24 -> 0.4.2) in integration tests
74 * Add some additional logging in A1
80 * SDL Wrapper was moved into the python xapp framework; use it from there instead.
86 * This is a pretty big amount of work/changes, however no APIs were changed hence the semver patch
87 * Switches A1's three test receivers (integration tests) over to golang; this was mostly done to learn the go xapp framework and they are identical in functionality.
88 * Upgrades the version of rmr in A1 and all integration receivers to 1.13.*
89 * Uses a much fancier Docker build to reduce the size of a1's image. The python:3.7-alpine image itself is 98MB and A1 is now only ~116MB, so we're done optimizing A1's container size.
94 * Upgrades from sdl 2.0.2 to 2.0.3
95 * Integrates an sdl healthcheck into a1's healthcheck
101 * Upgrades from sdl 1.0.0 to 2.0.2
102 * Delete a1test_helpers because SDL 2.0.2 provides the mockup we need
103 * Remove general catch all from A1
109 * Represents a resillent version of 2.0.0 that uses Redis for persistence
110 * Now relies on SDL and dbaas; SDL is the python interface library to dbaas
111 * Adds a 503 http code to nearly all http methods, as A1 now depends on an upstream system
112 * Integration tests have a copy of a dbaas helm chart, however the goal is to simplify that deployment per https://jira.o-ran-sc.org/browse/RIC-45
113 * Unit tests have a mockup of SDL, however again the goal is to simplify as SDL grows per https://jira.o-ran-sc.org/browse/RIC-44
119 * Implements new logic around when instances are deleted. See flowcharts in docs/. Basically timeouts now trigger to actually delete instances from a1s database, and these timeouts are configurable.
120 * Eliminates the barrier to deleting an instance when no xapp evdr replied (via timeouts)
121 * Add two new ENV variables that control timeouts
122 * Make unit tests more modular so new workflows can be tested easily
123 * Fixes the API for ../status to return a richer structure. This is an (albeit tiny) API change.
124 * Clean up unused items in the integration tests helm chart
125 * Removed "RMR_RCV_RETRY_INTERVAL" leftovers since this isn't used anymore
126 * Uses the standard RIC logging library
127 * Switch the backend routing scheme to using subscription id with constant message types, per request.
128 * Given the above, policy type ids can be any valid 32bit greater than 0
129 * Decouple the API between northbound and A1 from A1 with xapps. This is now two seperate OpenAPI files
130 * Update example for AC Xapp
131 * Updgrade rmr and rmr-python to utilize new features; lots of cleanups because of that
132 * Implements a POLICY QUERY feature where A1 listens for queries for a policy type. A1 then responds via multiple RTS messages every policy instance of that policy type (and expects an ACK back from xapps as usual). This feature can be used for xapp recovery etc.
138 * Only external change here is to healthcheck the rmr thread as part of a1s healthcheck. k8s will now respin a1 if that is failing.
139 * Refactors (simplifies) how we wait for rmr initialization; it is now called as part of __init__
140 * Refactors (simplifies) how the thread is actually launched; it is now internal to the object and also a part of __init__
141 * Cleans up unit testing; a1rmr now exposes a replace_rcv_func; useful for unit testing, harmless if not called otherwise
142 * Upgrades to rmr-python 1.0.0 for simpler message allocation
148 * Move database cleanup (e.g., deleting instances based on statuses) into the polling loop
149 * 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
150 * 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
151 * Bump rmr-python version, and bump rmr version
152 * 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.
158 * a1 now has a seperate, continuous polling thread, which will enable operations like database cleanup
159 (based on ACKs) and external notifications in real time, rather than when the API is invoked
160 * all rmr send and receive operations are now in this thread
161 * introduces a thread safe job queue between the two threads
162 * Not done yet: database cleanups in the thread
163 * Bump rmr python version
164 * Clean up some logging
170 * Moves the "database" access calls to mimick the SDL API, in preparation for moving to SDL
171 * Does not yet actually use SDL or Redis, but the transition to those will be much shorter after this change.
177 * Represents v1.0.0 of the A1 API for O-RAN-SC Release A
179 - Implement type DELETE
180 - Clean up where policy instance cleanups happen
188 * Upgrade rmr to 1.9.0
189 * Upgrade rmr-python to 0.13.2
190 * Use the new helpers module in rmr-python for the rec all functionality
191 * 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
192 * Fix a memory leak (python obj is garbage collected but not the underlying C memory allocation)
201 * Implement instance delete
202 * Moves away from the status vector and now aggregates statuses
203 * Pop through a1s mailbox "3x as often"; on all 3 kinds of instance GET since all such calls want the latest information
204 * Misc cleanups in controller (closures ftw)
205 * Add rmr-version.yaml for CICD jobs
212 * Implement GET all policy type ids
213 * Implement GET all policy instance ids for a policy type
214 * fix a tiny bug in integration test receiver
222 * 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)
223 * improve test receiver to behave with this setup
224 * add integration test for this case
225 * 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
226 * improve integration tests overall
236 * Remove RIC manifest
237 * Read type GET to get schema for instance PUT
238 * Remove Utils (no longer needed)
239 * lots more tests (unit and integration)
246 * This is on the road to release 1.0.0. It is not meant to be tested (E2E) as it's own release
247 * Implement the Release A spec in the openapi.yaml
248 * Rework A1 to follow that spec
249 * Remove rmr_mapping now that we use policyid as the mtype to send and a well known mtype for the ACKs
250 * Add the delay receiver test to the tavern integration tests
251 * Remove unneeded ENV variables from helm charts
252 * Switch away from builder images to avoid quicksand; upgrade rmr at our own pace
260 * Update to later rmr-python
261 * Add docs about upgrading rmr
262 * remove bombarder since tavern runs apache bench
270 * Update to later rmr-python
277 * Greatly reduce the size of A1 docker from 1.25GB to ~278MB.
278 * Add a seperate dockerfile for unit testing
286 * Rename all /ric/ URLs to be consistent with requirements of /a1-p/
294 * Implement the GET on policies
295 * 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).
303 * Fix the 400, which was in the API, but wasn't actually implemented
304 * Update the test fixture manifests to reflect the latest adm control, paves way for next feature coming which is a policy GET
313 * Use base Docker with NNG version 1.1.1
322 * Upgrade RMR due to a bug that was preventing rmr from init in kubernetes
331 * Run unit tests as part of docker build
340 * Convert docs to appropriate format
341 * Move rmr string to int mapping to a file
350 * Use tavern to test the actual running docker container
351 * Restructures the integration tests to run as a single tox command
352 * Re-ogranizes the README and splits out the Developers guide, which is not needed by users.
360 * 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
361 * Adds a test "bombarding" script that tests this
369 * 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.
370 * Fix a bug in the unit tests (found using a fresh container with no RIC manifest!)
371 * Fix a (critical) bug in a1rmr due to a rename in the last iteration (RMR_ERR_RMR_RCV_RETRY_INTERVAL)
372 * Make unit tests faster by setting envs in tox
373 * Move to the now publically available rmr-python
374 * Return a 400 if am xapp does not expect a body, but the PUT provides one
375 * Adds a new test policy to the example RIC manifest and a new delayed receiver to test the aformentiond race condition
383 * Upgrade to rmr 0.10.0
384 * Fix bad api spec RE GET
385 * 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
393 * Rip some testing structures out of here that should have been in rmr (those are now in rmr 0.9.0, upgrade to that)
394 * Run Python BLACK for formatting
402 * Fix a blocking execution bug by moving from rmr's timeout to a non blocking call + retry loop + asyncronous sleep
403 * Changes the ENV RMR_RCV_TIMEOUT to RMR_RCV_RETRY_INTERVAL
411 * Update to rmr 0.8.3
412 * Change 503 to 504 for the case where downstream does not reply, per recommendation
413 * Add a 502 with different reasons if the xapp replies but with a bad/malformed/missing status
414 * Make testing much more modular, in anticipating of moving some unit test functionality into rmr itself
422 * Crash immediately if manifest isn't mounted
423 * Add unit tests for utils
432 * Upgrade A1 to rmr 0.8.0
433 * Go from deb RMR installation to git
434 * Remove obnoxious receiver logging
442 * Upgrade A1 to rmr 0.6.0
450 * Add license headers
458 * Introduce RIC Manifest
459 * Move some testing functionality into a helper module
460 * Read the policyname to rmr type mapping from manifest
461 * Do PUT payload validation based on the manifest
469 * Bump rmr python dep version
470 * Include a Dockerized test receiver
471 * Stencil out the mising GET
473 * Include a test docker compose file
481 * Initial Implementation
Code Review / ric-plt / a1.git / blob