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.

xApp onboarded to each RIC platform instance may have different parameters either provided by the operators in the xapp descriptor or by the RIC platform that the xApp is hosted upon.

These parameters are injected into the xApp container by using environment variables or by sharing the xApp descriptor file.

The following table shows the parameters that are injected as environment variables.

Note that the default values are only examples and depends on the RIC platform instance configuration they are subjected to change.

xApp should always refer to the environment variables for their values instead of using the default ones.

Environment Variable	Description	Default Value
RMR_RTG_SVC	RMR route collector mode variable	4561
XAPP_DESCRIPTOR_PATH	Path of the xApp descriptor JSON file	/opt/ric/config
DBAAS_MASTER_NAME	Entry point of DBAASHA sentinel	service-ricplt-dbaas-tcp.ricplt.svc.cluster.local
DBAAS_SERVICE_HOST	Entry point of DBAAS service	service-ricplt-dbaas-tcp.ricplt.svc.cluster.local
DBAAS_SERVICE_PORT	DBAAS service port	6379
DBAAS_SERVICE_SENTINEL_PORT	DBAASHA sentinel port	26379

Consuming parameters in the xApp descriptor

The xApp program can find the xApp descriptor file using XAPP_DESCRIPTOR_PATH. The descriptor should contains all the internal configuration parameters for the xApp.