Upgrade xapp-frame-go module in integration tests
[ric-plt/a1.git] / docs / release-notes.rst
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
4
5 Release Notes
6 ===============
7
8 All notable changes to this project will be documented in this file.
9
10 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
11 and this project adheres to `Semantic Versioning <http://semver.org/>`__.
12
13 .. contents::
14    :depth: 3
15    :local:
16
17 [2.1.7] - 2020-04-22
18 --------------------
19
20 * Upgrade to rmr 3.8.0
21 * Upgrade integration tests to xapp-frame-go version 0.4.8 which drops NNG
22
23 [2.1.6] - 4/7/2020
24 -------------------
25 ::
26
27     * Switch to rmr 3.6.3
28     * Switch to using rmr in the ricxappframe
29
30
31 [2.1.5] - 3/19/2020
32 -------------------
33 ::
34
35     * Switch to python3.8
36     * Switch to SI95 from NNG (rmr v3 vs rmr v1)
37     * 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.
38     * Bump version of py xapp frame (SDL used only) in A1
39     * Bump version of go xapp frame (0.0.24 -> 0.4.2) in integration tests
40     * Add some additional logging in A1
41
42
43 [2.1.4] - 3/6/2020
44 -------------------
45 ::
46
47     * SDL Wrapper was moved into the python xapp framework; use it from there instead.
48
49
50 [2.1.3] - 2/13/2020
51 -------------------
52 ::
53
54     * This is a pretty big amount of work/changes, however no APIs were changed hence the semver patch
55     * 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.
56     * Upgrades the version of rmr in A1 and all integration receivers to 1.13.*
57     * 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.
58
59 [2.1.2] - 1/22/2020
60 -------------------
61
62 ::
63
64     * Upgrades from sdl 2.0.2 to 2.0.3
65     * Integrates an sdl healthcheck into a1's healthcheck
66
67
68 [2.1.1] - 1/14/2020
69 -------------------
70
71 ::
72
73     * Upgrades from sdl 1.0.0 to 2.0.2
74     * Delete a1test_helpers because SDL 2.0.2 provides the mockup we need
75     * Remove general catch all from A1
76
77 [2.1.0] - 1/8/2020
78 ------------------
79
80 ::
81
82     * Represents a resillent version of 2.0.0 that uses Redis for persistence
83     * Now relies on SDL and dbaas; SDL is the python interface library to dbaas
84     * Adds a 503 http code to nearly all http methods, as A1 now depends on an upstream system
85     * 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
86     * 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
87
88 [2.0.0] - 12/9/2019
89 -------------------
90
91 ::
92
93     * 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.
94     * Eliminates the barrier to deleting an instance when no xapp evdr replied (via timeouts)
95     * Add two new ENV variables that control timeouts
96     * Make unit tests more modular so new workflows can be tested easily
97     * Fixes the API for ../status to return a richer structure. This is an (albeit tiny) API change.
98     * Clean up unused items in the integration tests helm chart
99     * Removed "RMR_RCV_RETRY_INTERVAL" leftovers since this isn't used anymore
100     * Uses the standard RIC logging library
101     * Switch the backend routing scheme to using subscription id with constant message types, per request.
102     * Given the above, policy type ids can be any valid 32bit greater than 0
103     * Decouple the API between northbound and A1 from A1 with xapps. This is now two seperate OpenAPI files
104     * Update example for AC Xapp
105     * Updgrade rmr and rmr-python to utilize new features; lots of cleanups because of that
106     * 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.
107
108 [1.0.4]
109 -------
110
111 ::
112
113     * Only external change here is to healthcheck the rmr thread as part of a1s healthcheck. k8s will now respin a1 if that is failing.
114     * Refactors (simplifies) how we wait for rmr initialization; it is now called as part of __init__
115     * Refactors (simplifies) how the thread is actually launched; it is now internal to the object and also a part of __init__
116     * Cleans up unit testing; a1rmr now exposes a replace_rcv_func; useful for unit testing, harmless if not called otherwise
117     * Upgrades to rmr-python 1.0.0 for simpler message allocation
118
119 [1.0.3] - 10/22/2019
120 --------------------
121
122 ::
123
124     * Move database cleanup (e.g., deleting instances based on statuses) into the polling loop
125     * 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
126     * 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
127     * Bump rmr-python version, and bump rmr version
128     * 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.
129
130 [1.0.2] - 10/17/2019
131 --------------------
132
133 ::
134
135     * a1 now has a seperate, continuous polling thread
136       this will enable operations like database cleanup (based on ACKs) and external notifications in real time,
137       rather than when the API is invoked
138     * all rmr send and receive operations are now in this thread
139     * introduces a thread safe job queue between the two threads
140     * Not done yet: database cleanups in the thread
141     * Bump rmr python version
142     * Clean up some logging
143
144 [1.0.1] - 10/15/2019
145 --------------------
146
147 ::
148
149     * Moves the "database" access calls to mimick the SDL API, in preparation for moving to SDL
150     * Does not yet actually use SDL or Redis, but the transition to those will be much shorter after this change.
151
152
153 [1.0.0] - 10/7/2019
154 -------------------
155
156 ::
157
158     * Represents v1.0.0 of the A1 API for O-RAN-SC Release A
159     * Finished here:
160       - Implement type DELETE
161       - Clean up where policy instance cleanups happen
162
163
164 [0.14.1] - 10/2/2019
165 --------------------
166
167 ::
168
169     * Upgrade rmr to 1.9.0
170     * Upgrade rmr-python to 0.13.2
171     * Use the new helpers module in rmr-python for the rec all functionality
172     * 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
173     * Fix a memory leak (python obj is garbage collected but not the underlying C memory allocation)
174
175
176
177 [0.14.0] - 10/1/2019
178 --------------------
179
180 ::
181
182     * Implement instance delete
183     * Moves away from the status vector and now aggregates statuses
184     * Pop through a1s mailbox "3x as often"; on all 3 kinds of instance GET since all such calls want the latest information
185     * Misc cleanups in controller (closures ftw)
186     * Add rmr-version.yaml for CICD jobs
187
188 [0.13.0] - 9/25/2019
189 --------------------
190
191 ::
192
193     * Implement GET all policy type ids
194     * Implement GET all policy instance ids for a policy type
195     * fix a tiny bug in integration test receiver
196
197
198 [0.12.1] - 9/20/2019
199 --------------------
200
201 ::
202
203     * 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)
204     * improve test receiver to behave with this setup
205     * add integration test for this case
206     * 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
207     * improve integration tests overall
208
209
210 [0.12.0] - 9/19/2019
211 --------------------
212
213 ::
214
215     * Implement type PUT
216     * Implement type GET
217     * Remove RIC manifest
218     * Read type GET to get schema for instance PUT
219     * Remove Utils (no longer needed)
220     * lots more tests (unit and integration)
221
222 [0.11.0] - 9/17/2019
223 --------------------
224
225 ::
226
227     * This is on the road to release 1.0.0. It is not meant to be tested (E2E) as it's own release
228     * Implement the Release A spec in the openapi.yaml
229     * Rework A1 to follow that spec
230     * Remove rmr_mapping now that we use policyid as the mtype to send and a well known mtype for the ACKs
231     * Add the delay receiver test to the tavern integration tests
232     * Remove unneeded ENV variables from helm charts
233     * Switch away from builder images to avoid quicksand; upgrade rmr at our own pace
234
235
236 [0.10.3] - 8/20/2019
237 --------------------
238
239 ::
240
241     * Update to later rmr-python
242     * Add docs about upgrading rmr
243     * remove bombarder since tavern runs apache bench
244
245
246 [0.10.2] - 8/14/2019
247 --------------------
248
249 ::
250
251     * Update to later rmr-python
252
253 [0.10.1] - 8/9/2019
254 -------------------
255
256 ::
257
258     * Greatly reduce the size of A1 docker from 1.25GB to ~278MB.
259     * Add a seperate dockerfile for unit testing
260
261
262 [0.10.0] - 7/30/2019
263 --------------------
264
265 ::
266
267    * Rename all /ric/ URLs to be consistent with requirements of /a1-p/
268
269
270 [0.9.0] - 7/22/2019
271 -------------------
272
273 ::
274
275    * Implement the GET on policies
276    * 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).
277
278
279 [0.8.4] - 7/16/2019
280 -------------------
281
282 ::
283
284    * Fix the 400, which was in the API, but wasn't actually implemented
285    * Update the test fixture manifests to reflect the latest adm control, paves way for next feature coming which is a policy GET
286
287
288
289 [0.8.3] - 6/18/2019
290 -------------------
291
292 ::
293
294    * Use base Docker with NNG version 1.1.1
295
296
297
298 [0.8.2] - 6/5/2019
299 ------------------
300
301 ::
302
303    * Upgrade RMR due to a bug that was preventing rmr from init in kubernetes
304
305
306
307 [0.8.1] - 5/31/2019
308 -------------------
309
310 ::
311
312    * Run unit tests as part of docker build
313
314
315
316 [0.8.0] - 5/28/2019
317 -------------------
318
319 ::
320
321    * Convert docs to appropriate format
322    * Move rmr string to int mapping to a file
323
324
325
326 [0.7.2] - 5/24/2019
327 -------------------
328
329 ::
330
331    * Use tavern to test the actual running docker container
332    * Restructures the integration tests to run as a single tox command
333    * Re-ogranizes the README and splits out the Developers guide, which is not needed by users.
334
335
336 [0.7.1] - 5/23/2019
337 -------------------
338
339 ::
340
341    * 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
342    * Adds a test "bombarding" script that tests this
343
344
345 [0.7.0] - 5/22/19
346 -----------------
347
348 ::
349
350    * 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.
351    * Fix a bug in the unit tests (found using a fresh container with no RIC manifest!)
352    * Fix a (critical) bug in a1rmr due to a rename in the last iteration (RMR_ERR_RMR_RCV_RETRY_INTERVAL)
353    * Make unit tests faster by setting envs in tox
354    * Move to the now publically available rmr-python
355    * Return a 400 if am xapp does not expect a body, but the PUT provides one
356    * Adds a new test policy to the example RIC manifest and a new delayed receiver to test the aformentiond race condition
357
358
359 [0.6.0]
360 -------
361
362 ::
363
364    * Upgrade to rmr 0.10.0
365    * Fix bad api spec RE GET
366    * 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
367
368
369 [0.5.1] - 5/13/2019
370 -------------------
371
372 ::
373
374    * Rip some testing structures out of here that should have been in rmr (those are now in rmr 0.9.0, upgrade to that)
375    * Run Python BLACK for formatting
376
377
378 [0.5.0] - 5/10/2019
379 -------------------
380
381 ::
382
383    * Fix a blocking execution bug by moving from rmr's timeout to a non blocking call + retry loop + asyncronous sleep
384    * Changes the ENV RMR_RCV_TIMEOUT to RMR_RCV_RETRY_INTERVAL
385
386
387 [0.4.0] - 5/9.2019
388 ------------------
389
390 ::
391
392    * Update to rmr 0.8.3
393    * Change 503 to 504 for the case where downstream does not reply, per recommendation
394    * Add a 502 with different reasons if the xapp replies but with a bad/malformed/missing status
395    * Make testing much more modular, in anticipating of moving some unit test functionality into rmr itself
396
397
398 [0.3.4] - 5/8/2019
399 ------------------
400
401 ::
402
403    * Crash immediately if manifest isn't mounted
404    * Add unit tests for utils
405    * Add missing lic
406
407
408 [0.3.3]
409 -------
410
411 ::
412
413    * Upgrade A1 to rmr 0.8.0
414    * Go from deb RMR installation to git
415    * Remove obnoxious receiver logging
416
417
418 [0.3.2]
419 -------
420
421 ::
422
423    * Upgrade A1 to rmr 0.6.0
424
425
426 [0.3.1]
427 -------
428
429 ::
430
431    * Add license headers
432
433
434 [0.3.0]
435 -------
436
437 ::
438
439    * Introduce RIC Manifest
440    * Move some testing functionality into a helper module
441    * Read the policyname to rmr type mapping from manifest
442    * Do PUT payload validation based on the manifest
443
444
445 [0.2.0]
446 -------
447
448 ::
449
450    * Bump rmr python dep version
451    * Include a Dockerized test receiver
452    * Stencil out the mising GET
453    * Update the OpenAPI
454    * Include a test docker compose file
455
456
457 [0.1.0]
458 -------
459
460 ::
461
462    * Initial Implementation