docs/xapp_onboarder/overview.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 ..
   4 .. Copyright (C) 2019 AT&T Intellectual Property
   5
   6 Project Overview
   7 ================
   8
   9 Introduction
  10 ------------
  11
  12 xApp onboarder provides the xapp onboarding service to operators. It consumes the xApp descriptor and optionally additional schema file, and produces xApp helm charts.
  13 xApp onboarder also provides CLI tools for local testing and debuging.
  14
  15
  16 .. image:: images/onboard.png
  17    :scale: 50 %
  18    :align: center
  19
  20
  21
  22 Change logs
  23 -----------
  24 +------------+--------------+-------------------------------------------------------------------------------------------------+
  25 | Version    | Date         | Description                                                                                     |
  26 +============+==============+=================================================================================================+
  27 |1.0.0       | Mar 23 2020  | First release                                                                                   |
  28 +------------+--------------+-------------------------------------------------------------------------------------------------+
  29 |1.0.1       | May 13 2020  | **Bug fix:** add a work-around for backward compatibility. Now xapp onboarder writes the xApp   |
  30 |            |              | descriptor and schema json files into xApp helm charts.                                         |
  31 +------------+--------------+-------------------------------------------------------------------------------------------------+
  32 |1.0.7       | Jun 15 2020  | **Bug fix:**                                                                                    |
  33 |            |              | fix the xApp service name for appmgr backward compatibility.                                    |
  34 |            |              | **Feture add:**                                                                                 |
  35 |            |              | add RMR source name environment variable.                                                       |
  36 |            |              | add lable for VESPAMGR to report xapp name.                                                     |
  37 |            |              | add option to inject annotation.                                                                |
  38 |            |              | add option to inject command parameters.                                                        |
  39 +------------+--------------+-------------------------------------------------------------------------------------------------+
  40
  41 Configurations
  42 --------------
  43
  44 xApp onboarder uses the following environment parameters to configurate its instance.
  45
  46 +----------------------+----------------------+-------------------------------------------------------------------------------------------------+
  47 | Enviroment Variable  |   Default Value      | Description                                                                                     |
  48 +======================+======================+=================================================================================================+
  49 | CHART_WORKSPACE_PATH | /tmp/xapp_onboarder  | Temporary directory for xApp helm chart generation                                              |
  50 +----------------------+----------------------+-------------------------------------------------------------------------------------------------+
  51 | CHART_REPO_URL       | \http://0.0.0.0:8080 | URL for local helm repo that stores the onboarded xApp helm chart                               |
  52 +----------------------+----------------------+-------------------------------------------------------------------------------------------------+
  53 | HTTP_TIME_OUT        | 10                   | Timeout value for outgoing REST API calls                                                       |
  54 +----------------------+----------------------+-------------------------------------------------------------------------------------------------+
  55 | HELM_VERSION         | 2.12.3               | Version of the helm client                                                                      |
  56 +----------------------+----------------------+-------------------------------------------------------------------------------------------------+
  57 | HTTP_RETRY           | 3                    | Number of http retries for outgoing REST API calls                                              |
  58 +----------------------+----------------------+-------------------------------------------------------------------------------------------------+
  59 | ALLOW_REDEPLOY       | True                 | Whether to allow reusing version number when onboard xApps                                      |
  60 +----------------------+----------------------+-------------------------------------------------------------------------------------------------+
  61 | CHART_WORKSPACE_SIZE | 500 MB               | Size limit of the CHART_WORKSPACE_PATH temporary directory                                      |
  62 +----------------------+----------------------+-------------------------------------------------------------------------------------------------+
  63 | FLASK_PORT           | 8888                 | Port the xApp onboarder will listen to                                                          |
  64 +----------------------+----------------------+-------------------------------------------------------------------------------------------------+
  65 | FLASK_DEBUG          | True                 | Enable HTTP server debug messages                                                               |
  66 +----------------------+----------------------+-------------------------------------------------------------------------------------------------+