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

Prerequisites

• a host with docker installed
• a local helm repo

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

Test on-boarding using xapp-onboarder CLI tools

1. 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.

2. Install xapp-onboarder CLI

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

3. 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

4. Onboard your xApp. Please refer to xApp descriptor for preparing for the xApp descriptor

   # Make sure that you have the xapp descriptor config file and the schema file at your local file system
   cli onboard CONFIG_FILE_PATH SHCEMA_FILE_PATH

   If onboarding fails, the cli will return you messages that indicate where the errors are in the descriptor.

5. (OPTIONAL) Download the xApp helm charts

    cli download_helm_chart XAPP_CHART_NAME VERSION --output_path=OUTPUT_PATH

6. (OPTIONAL) Download the xApp override values.yaml file

   cli download_values_yaml XAPP_CHART_NAME VERSION --output_path=OUTPUT_PATH