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 onboard an xApp, you can utilize either the CLI tool or the REST APIs of xapp onboarder.
We recommend to use postman for rest API calls.
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://<INGRESS_IP>:32080/helmrepo" # It should return True if your CLI tool is properly connected to the RIC instance cli health |
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.
(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 |