--- /dev/null
+---
+version: 2
+
+formats:
+ - htmlzip
+
+build:
+ image: latest
+
+python:
+ version: 3.7
+ install:
+ - requirements: docs/requirements-docs.txt
+
+sphinx:
+ configuration: docs/conf.py
---
-tag: '0.0.1'
+tag: '1.0.0'
'https://gerrit.o-ran-sc.org.*'
]
extensions = ['sphinx.ext.autosectionlabel']
+intersphinx_mapping = {}
+intersphinx_mapping['ric-app-admin'] = ('https://o-ran-sc-doc.readthedocs.io/projects/o-ran-sc-ric-app-admin/en/%s' % 'latest')
installation-guide.rst
user-guide.rst
-
-
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
- The xAPP docker run time **must** be configured with a json configuration file appropriate to the test environment which injects various environment variables including the RMR routes (an example is provided under init/config-file.json).
- - Once such a file is available (say under directory /home/user/test-config), the docker image can be invoked as *docker run --net host -it --rm -v "/home/user/test-config:/opt/ric/config" --name "AC-xAPP" <image>*. See REAMDE.md under the init directory for more details.
+ - Once such a file is available (say under directory /home/user/test-config), the docker image can be invoked as *docker run --net host -it --rm -v "/home/user/test-config:/opt/ric/config" --name "AC-xAPP" <image>*. See README.md under the init directory for more details.
3. **Invoking docker xAPP container in RIC Kubernetes environment** :
- ./run_tests.sh
- If gcovr is installed (https://github.com/gcovr/gcovr) the script will also generates a coverage report (as ../coverage_report.html)
-In order to run integration tests, the AC-xAPP requires *three* components : an *E2 Termination point* to send and receive RAN messages, an *A1 mediator* to send policy updatesd and a *VES collector* to receive metrics. The *test/*
+In order to run integration tests, the AC-xAPP requires *three* components : an *E2 Termination point* to send and receive RAN messages, an *A1 mediator* to send policy updates and a *VES collector* to receive metrics. The *test/*
directory contains mock-ups for these three components which can be build and executed from the *test/* directory as follows :
1. **E2 Termination** : The E2 termination is responsible for forwarding messages to and fro between the RAN and RIC. A mock-up of the E2 termination is provided in *test/* that
- - listens and responds to E2AP subscribption requests.
+ - listens and responds to E2AP subscription requests.
- upon receiving an E2AP subscription request, starts sending E2AP Indication messages that contain the X2AP SgNB Addition Request Message.
- monitors E2AP control messages from the AC xAPP.
- *src/* contains the main source code. Under that directory :
- + *xapp_utils.hpp, xapp_utls.cc* is generic multi-threaded framework for receiving and sending RMR events.
+ + *xapp_utils.hpp, xapp_utils.cc* is generic multi-threaded framework for receiving and sending RMR events.
+ *E2AP-c/subscription/* contains generic classes to send/process ASN1 subscription requests, responses, deletes and failures as well as thread-safe subscription handler for managing the subscription process.
+ *E2AP-c/* contains generic classes for generating/processing ASN1 E2AP Indication and Control messages.
+ *E2SM/* contains generic classes for handling generating/processing ASN1 E2SM service model (e.g event trigger etc).
+ *curl/* contains a simple *libcurl* based class for POSTing JSON messages.
- + *json/* contains a generic class for simple JSON key retreival and modification (based on rapidjson)
+ + *json/* contains a generic class for simple JSON key retrieval and modification (based on rapidjson)
+ *protector-plugin/* contains code specific to the admission control algorithm and interfaces for setting/getting policy.
- *test/* contains unit tests showing how to use various components as well as mock-ups for integration testing.
:local:
.. a user guide should be how to use the component or system; it should not be a requirements document
-.. delete this content after edittng it
+.. delete this content after editing it
Description
-----------
-.. Describe the target users of the projcet, for example, modeler/data scientist, ORAN-OSC platform admin, marketplace user, design studio end user, etc
-.. Descirbe how the target users can get use of a O-RAN SC component.
+.. Describe the target users of the project, for example, modeler/data scientist, ORAN-OSC platform admin, marketplace user, design studio end user, etc
+.. Describe how the target users can get use of a O-RAN SC component.
.. If the guide contains sections on third-party tools, is it clearly stated why the O-RAN-OSC platform is using those tools? Are there instructions on how to install and configure each tool/toolset?
The AC xAPP provides rate control of SgNB Addition Requests via a standard sliding window control algorithm which is configurable at run-time. Please see :ref:`Installation Guide` for instructions on compiling and executing the AC xAPP. This document explains the various configurable parameters of the AC xAPP executable, policies and metrics.
----------------
The AC xAPP takes the following parameters (either on the command line) or as environment variables on invocation (see *src/run_xapp.sh* for an example of providing arguments on command line and *init/config-file.json* for environment variables) :
-1. List of comma separated gNodeBs to send subscription requests to.
+1. List of comma separated gNodeBs to send subscription requests to. Can be specified with :
+
- Use *-g or --gNodeB* on command line.
- Set the "GNODEB" environment variable
- *-v* on command line.
- "VES_SCHEMA_FILE" environment variable.
-4. Set of sample JSON payloads for policy and metrics that the AC xAPP uses as templates to generate payloads. Values in the template payload are modified/retreived rather than construct the entire payload from scratch. The JSON file
+4. Set of sample JSON payloads for policy and metrics that the AC xAPP uses as templates to generate payloads. Values in the template payload are modified/retrieved rather than construct the entire payload from scratch. The JSON file
containing the payloads can be specified with :
- *-s* on command line.
- "SAMPLE_FILE" environment variable.