Add release notes for Acumos xAPP for Amber release

Change-Id: I12db889774420c7260d7e9473c3c333ba942d9c9

Signed-off-by: Guy Jacobson <guy@research.att.com>
Change-Id: I1bf82c6d2e9e2d1e74daddb9a12bc0e5ed1e4321

diff --git a/docs/index.rst b/docs/index.rst
index a9639a0..938164c 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,5 +14,6 @@ RIC APP ML
    :caption: Contents:
 
    overview.rst
+   release-notes.rst
 
 * :ref:`search`

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..7a4f90b
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,78 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. SPDX-License-Identifier: CC-BY-4.0\r
+.. Copyright (C) 2019 AT&T\r
+\r
+\r
+Release Notes\r
+=============\r
+\r
+\r
+This document provides the release notes for the Amber Release of the Acumos xAPP adapter.\r
+\r
+.. contents::\r
+   :depth: 3\r
+   :local:\r
+\r
+\r
+Version history\r
+---------------\r
+\r
++--------------------+--------------------+--------------------+--------------------+\r
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+| 2019-11-14         | 0.0.1              |  Guy Jacobson      | First draft        |\r
+|                    |                    |                    |                    |\r
++--------------------+--------------------+--------------------+--------------------+\r
+\r
+\r
+\r
+Summary\r
+-------\r
+\r
+The Amber release of the Acumos xAPP adapter contains the code needed to use an existing\r
+Acumos microservice as an O-RAN xAPP, by providing "glue" that listens and speaks RMR protocol\r
+and translates these into calls to the Acumos microservice, which is co-deployed in the\r
+same pod as the adapter.\r
+\r
+\r
+\r
+Release Data\r
+------------\r
+\r
++--------------------------------------+--------------------------------------+\r
+| **Project**                          |      RAN Intelligent Controller      |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Repo/commit-ID**                   |              ric-app/ml              |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Release designation**              |                 Amber                |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Release date**                     |              2019-11-14              |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+| **Purpose of the delivery**          | open-source adapter between Acumos   |\r
+|                                      | and xAPPs.                           |\r
+|                                      |                                      |\r
++--------------------------------------+--------------------------------------+\r
+\r
+\r
+Components\r
+----------\r
+\r
+- *AcumosXappAdapter/* contains the source code and other items of interest. Under that directory :\r
+  \r
+  + *rmracumosadapter.py* is source code for the adapter itself.\r
+  + *iris_sklearn.py* is the source code for a generic Acumos model (iris classification).\r
+  + *config.json*  is a sample configuration file, needed to connect the Acumos model with the xAPP adapter during deployment.\r
+  + *Dokcerfile* is the Dockerfile that builds the xAPP adapter microservice.\r
+  + *testdata.csv* contains sample input data to test the iris_sklearn.py classifier\r
+ \r
+\r
+Limitations\r
+-----------\r
+- This is a first release and needs some fixes to the Dockerfile function correctly, due to known problems with the build process to incorporate the required nng libraries.\r
+\r
+ \r