docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
   2 .. SPDX-License-Identifier: CC-BY-4.0\r
   3 .. Copyright (C) 2019 AT&T\r
   4 \r
   5 \r
   6 Release Notes\r
   7 =============\r
   8 \r
   9 \r
  10 This document provides the release notes for the Amber Release of the Acumos xAPP adapter.\r
  11 \r
  12 .. contents::\r
  13    :depth: 3\r
  14    :local:\r
  15 \r
  16 \r
  17 Version history\r
  18 ---------------\r
  19 \r
  20 +--------------------+--------------------+--------------------+--------------------+\r
  21 | **Date**           | **Ver.**           | **Author**         | **Comment**        |\r
  22 |                    |                    |                    |                    |\r
  23 +--------------------+--------------------+--------------------+--------------------+\r
  24 | 2019-11-14         | 0.0.1              |  Guy Jacobson      | First draft        |\r
  25 |                    |                    |                    |                    |\r
  26 +--------------------+--------------------+--------------------+--------------------+\r
  27 \r
  28 \r
  29 \r
  30 Summary\r
  31 -------\r
  32 \r
  33 The Amber release of the Acumos xAPP adapter contains the code needed to use an existing\r
  34 Acumos microservice as an O-RAN xAPP, by providing "glue" that listens and speaks RMR protocol\r
  35 and translates these into calls to the Acumos microservice, which is co-deployed in the\r
  36 same pod as the adapter.\r
  37 \r
  38 \r
  39 \r
  40 Release Data\r
  41 ------------\r
  42 \r
  43 +--------------------------------------+--------------------------------------+\r
  44 | **Project**                          |      RAN Intelligent Controller      |\r
  45 |                                      |                                      |\r
  46 +--------------------------------------+--------------------------------------+\r
  47 | **Repo/commit-ID**                   |              ric-app/ml              |\r
  48 |                                      |                                      |\r
  49 +--------------------------------------+--------------------------------------+\r
  50 | **Release designation**              |                 Amber                |\r
  51 |                                      |                                      |\r
  52 +--------------------------------------+--------------------------------------+\r
  53 | **Release date**                     |              2019-11-14              |\r
  54 |                                      |                                      |\r
  55 +--------------------------------------+--------------------------------------+\r
  56 | **Purpose of the delivery**          | open-source adapter between Acumos   |\r
  57 |                                      | and xAPPs.                           |\r
  58 |                                      |                                      |\r
  59 +--------------------------------------+--------------------------------------+\r
  60 \r
  61 \r
  62 Components\r
  63 ----------\r
  64 \r
  65 - *AcumosXappAdapter/* contains the source code and other items of interest. Under that directory :\r
  66   \r
  67   + *rmracumosadapter.py* is source code for the adapter itself.\r
  68   + *iris_sklearn.py* is the source code for a generic Acumos model (iris classification).\r
  69   + *config.json*  is a sample configuration file, needed to connect the Acumos model with the xAPP adapter during deployment.\r
  70   + *Dokcerfile* is the Dockerfile that builds the xAPP adapter microservice.\r
  71   + *testdata.csv* contains sample input data to test the iris_sklearn.py classifier\r
  72  \r
  73 \r
  74 Limitations\r
  75 -----------\r
  76 - 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
  77 \r
  78  \r