X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;fp=docs%2Finstallation-guide.rst;h=562e5269a50e64c9fcdaf01fec21622e7063edcf;hb=0a168f272a81ac4c3afe42e014f8032f2a159d97;hp=cffd4e336fa1f77d71eff2608c424b6982c66a81;hpb=8a198a45af798bc7c9525a2663d397377d01ab01;p=ric-app%2Fadmin.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index cffd4e3..562e526 100755 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -126,12 +126,12 @@ directory contains mock-ups for these three components which can be build and ex 2. **A1 Mediator** : The A1 mediator is responsible for sending policies to the xAPPs over RMR to configure their behaviour. A mock-up of the A1 mediator can be built and executed as follows : - - *make mock-a1-server* builds the executable. - - The executable can be run as *./mock-a1-server -p * where port number can be any port not conflicting with the xAPP and E2 Term. - - Note that the A1 mediator also uses RMR and hence the environment variable *RMR_SEED_RT* must also be set when executing *mock-a1-server* (if static routes are being used). - - On start up, the *mock-a1-mediator* will send a stream of valid/invalid JSON messages containing policies to test the xAPP. + - *make mock-a1-tool* builds the executable. + - The executable can be run as *./mock-a1-tool -p * where port number can be any port not conflicitng with the xAPP and E2 Term ports. + - Note that the A1 mediator also uses RMR and hence the environment variable *RMR_SEED_RT* must also be set when executing *mock-a1-tool* (if static routes are being used). + - Run ./mock-a1-tool -h to see various options. -3. **VES Collector** : This component is responsible for receiving metrics from xAPPs as JSON payloads. A simple mock-up is available under *test/* which is basically a *cherrypy* web-server that receives JSON and prints out relevant messages. It can be invoked as *python ./mock_ves_collector.py*. +3. **VES Collector** : This component is responsible for receiving metrics from xAPPs as JSON payloads. A simple mock-up is available under *test/* which is basically a *cherrypy* web-server that receives VES messages from the Admission Control Xapp and prints out relevant messages. It can be invoked as *python ./mock_ves_collector.py*. - Pre-requisites for the VES collector are the *cherrypy* and *requests* Python modules. They can be installed via pip : *pip install cherrypy requests*.