xapp_onboarder/README.md

   1 xApp Onboarder
   2 ==============
   3
   4 xApp onboarder onboards xApp to the near-rt RIC platform. The operators provides the xApp descriptors and their schemas, the xApp onboarder generates the xApp helm charts dynamically.
   5
   6 ## Install xapp_onboarder
   7
   8 Run  [pip](https://pip.pypa.io/en/stable/) to install xapp_onboarder.
   9
  10 ```bash
  11 pip install xapp_onboarder
  12 ```
  13
  14 ## Prerequisite Requirements
  15 A helm chart repo is needed to store the xApp helm charts. You can use [chartmuseum](https://github.com/helm/chartmuseum) for this purpose.
  16
  17 Environment variables:
  18 * **FLASK_SERVER_NAME**: Address that the xapp_onboarder is listening on. Default http://0.0.0.0:8888
  19 * **CHART_REPO_URL**: helm chart repo URL. Default http://0.0.0.0:8080
  20
  21 ## Configurations
  22 Environment variables:
  23 * **CHART_WORKSPACE_PATH**: Temporary directory that will store the xApp helm chart artifacts. Default /tmp/xapp_onboarder
  24 * **CHART_WORKSPACE_SIZE**: Size limit of the temporary directory. Default 500MB
  25 * **ALLOW_REDEPLOY**: Enable or disable redeploying of xApp helm charts. Default True
  26 * **HTTP_TIME_OUT**: Timeout of all http requests. Default 10
  27 * **HTTP_RETRY**: Number of retry xapp_onboarder will use for the http requests. Default 3
  28
  29 ## Run the API server
  30 ```bash
  31 xapp_onboarder
  32 ```
  33 ## Run the CLI tool
  34 ```bash
  35 cli
  36 ```