Obsolete Note

We are in the process of moving this xApp writing guide to https://docs.o-ran-sc.org.

Please refer to App Writing Guide for latest guide.

To test onboard an xApp, you can utilize either the CLI tool or the REST APIs of xapp onboarder.

The CLI tool will return errors that can help you pinpoint problems in your xApp descriptor.

Prerequisites

Create a local helm repo

You can create a local helm repo by running the following command

docker run -d -p 8080:8080 -e DEBUG=1 -e STORAGE=local -e STORAGE_LOCAL_ROOTDIR="/charts" chartmuseum/chartmuseum:latest

Find out the ingress IP for your RIC instance. If you deploy RIC using it/dep deployment script, it should be your host(VM)'s IP.

Install xapp-onboarder CLI

git clone "https://gerrit.o-ran-sc.org/r/it/dev"
cd dev/xapp_onboarder
pip3 install ./

Set up the environment variables for CLI connection

export CHART_REPO_URL="http://0.0.0.0:8080"

# It should return True if your CLI tool is properly connected to the RIC instance
cli health

(OPTIONAL) Download the xApp helm charts

 cli download_helm_chart XAPP_CHART_NAME VERSION --output_path=OUTPUT_PATH

(OPTIONAL) Download the xApp override values.yaml file

cli download_values_yaml XAPP_CHART_NAME VERSION --output_path=OUTPUT_PATH