Mostly integration test work:
[ric-plt/a1.git] / docs / release-notes.rst
index 49c3a18..e39ec3a 100644 (file)
@@ -1,5 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2019 AT&T Intellectual Property
 
 Release Notes
 ===============
@@ -13,16 +14,66 @@ and this project adheres to `Semantic Versioning <http://semver.org/>`__.
    :depth: 3
    :local:
 
+[2.1.3] - 2/13/2020
+-------------------
+::
+
+    * This is a pretty big amount of work/changes, however no APIs were changed hence the semver patch
+    * 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.
+    * Upgrades the version of rmr in A1 and all integration receivers to 1.13.*
+    * 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.
 
-[1.x.x] - TBD
--------------
+[2.1.2] - 1/22/2020
+-------------------
 
 ::
 
-    * Represents a resillent version of 1.0.0 that uses Redis for persistence
+    * Upgrades from sdl 2.0.2 to 2.0.3
+    * Integrates an sdl healthcheck into a1's healthcheck
 
-[1.0.4] - 10/24/2019
---------------------
+
+[2.1.1] - 1/14/2020
+-------------------
+
+::
+
+    * Upgrades from sdl 1.0.0 to 2.0.2
+    * Delete a1test_helpers because SDL 2.0.2 provides the mockup we need
+    * Remove general catch all from A1
+
+[2.1.0] - 1/8/2020
+------------------
+
+::
+
+    * Represents a resillent version of 2.0.0 that uses Redis for persistence
+    * Now relies on SDL and dbaas; SDL is the python interface library to dbaas
+    * Adds a 503 http code to nearly all http methods, as A1 now depends on an upstream system
+    * 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
+    * 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
+
+[2.0.0] - 12/9/2019
+-------------------
+
+::
+
+    * 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.
+    * Eliminates the barrier to deleting an instance when no xapp evdr replied (via timeouts)
+    * Add two new ENV variables that control timeouts
+    * Make unit tests more modular so new workflows can be tested easily
+    * Fixes the API for ../status to return a richer structure. This is an (albeit tiny) API change.
+    * Clean up unused items in the integration tests helm chart
+    * Removed "RMR_RCV_RETRY_INTERVAL" leftovers since this isn't used anymore
+    * Uses the standard RIC logging library
+    * Switch the backend routing scheme to using subscription id with constant message types, per request.
+    * Given the above, policy type ids can be any valid 32bit greater than 0
+    * Decouple the API between northbound and A1 from A1 with xapps. This is now two seperate OpenAPI files
+    * Update example for AC Xapp
+    * Updgrade rmr and rmr-python to utilize new features; lots of cleanups because of that
+    * 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.
+
+[1.0.4]
+-------
 
 ::