Developer Guide
===============
+This document provides a quickstart for developers of the Non-RT RIC parts.
+
Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki <https://wiki.o-ran-sc.org/display/RICNR/Release+D>`_
A1 Policy Management Service & SDNC/A1 Controller & A1 Adapter
--------------------------------------------------------------
-The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation <https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html>`_ and `wiki <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_.
+The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation <https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html>`_
+and `wiki <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_.
Enrichment Coordinator Service
------------------------------
-The Enrichment Coordinator Service is a Java 11 web application built using the Spring Framework.
-Using Spring Boot dependencies, it runs as a standalone application.
+The Enrichment Coordinator Service is a Java 11 web application built using the Spring Framework. Using Spring Boot
+dependencies, it runs as a standalone application.
+
+Its main functionality is to act as a data subscription broker and to decouple data producer from data consumers.
+
+See the ./config/README file in the *enrichment-coordinator-service* directory Gerrit repo on how to create and setup
+the certificates and private keys needed for HTTPS.
+
+Start standalone
+++++++++++++++++
+
+The project uses Maven. To start the Enrichment Coordinator Service as a freestanding application, run the following
+command in the *enrichment-coordinator-service* directory:
+
+ +-----------------------------+
+ | mvn spring-boot:run |
+ +-----------------------------+
+
+Start in Docker
++++++++++++++++
+
+To build and deploy the Enrichment Coordinator Service, go to the "enrichment-coordinator-service" folder and run the
+following command:
+
+ +-----------------------------+
+ | mvn clean install |
+ +-----------------------------+
-Its main functionality is to act as a data subscription broker and to decouple data
-producer from data consumers.
+Then start the container by running the following command:
-See the ./config/README file in the *enrichment-coordinator-service* directory Gerrit repo on how to create and setup the certificates and private keys needed for HTTPS.
+ +--------------------------------------------------------------------+
+ | docker run nonrtric-enrichment-coordinator-service |
+ +--------------------------------------------------------------------+
Initial Non-RT-RIC App Catalogue
--------------------------------
Kubernetes deployment
=====================
-Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_ hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the OSC NONRTRIC integrated test environment can be found in the *./nonrtric* directory.
-For more information see `Integration and Testing documentation on the O-RAN-SC wiki <https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/index.html>`_
\ No newline at end of file
+Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_
+hosts deployment and integration artifacts. Instructions and helm charts to deploy the Non-RT-RIC functions in the
+OSC NONRTRIC integrated test environment can be found in the *./nonrtric* directory.
+For more information see `Integration and Testing documentation on the O-RAN-SC wiki <https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/index.html>`_.
./api-docs.rst
./use-cases.rst
./requirements.rst
+ ./installation-guide.rst
./release-notes.rst
* :ref:`search`
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2021 Nordix
+
+Installation Guide
+==================
+
+Abstract
+--------
+
+This document describes how to install the Non-RT RIC components, their dependencies and required system resources.
+
+Preface
+-------
+
+See the README file in the "docker-compose" folder for more information.
+
+Software Installation and Deployment
+------------------------------------
+
+Install with Docker
++++++++++++++++++++
+
+Docker compose files are provided, in the "docker-compose" folder, to install the components. Run the following
+command to start the components:
+
+ .. code-block:: bash
+
+ docker-compose -f docker-compose.yaml
+ -f policy-service/docker-compose.yaml
+ -f ecs/docker-compose.yaml
+
+Install with Helm
++++++++++++++++++
+
+Helm charts and an example recipe are provided in the `it/dep repo <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`__,
+under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which
+components that will be installed can be controlled. Then the components can be installed and started by running the
+following comand:
+
+ .. code-block:: bash
+
+ bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml
Implementation:
* Implemented as a Python application
-* Repo: *portal/nonrtric-controlpanel*
+* Repo: *sim/a1-interface*
More details available at the `A1 Simulator documentation site <https://docs.o-ran-sc.org/projects/o-ran-sc-sim-a1-interface>`_
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
- <version>1.5.2</version>
+ <version>1.5.4</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
ENV NODE_ENV=production
WORKDIR /usr/src/app/cert
-COPY cert/*.crt .
+COPY cert/*.crt ./ #Need trailing slash on dest for multiple file copy
COPY cert/pass .
WORKDIR /usr/src/app
--- /dev/null
+---
+tag: 1.0.0
return dictionary
+def poll_and_handle_messages(mr_address, sdnr_address):
+ while True:
+ try:
+ verboseprint("Polling")
+ response = requests.get(mr_address)
+ messages = response.json()
+ for message in messages:
+ if (is_message_new_link_failure(message)):
+ handle_link_failure(message, o_ru_to_o_du_map, sdnr_address)
+ elif (is_message_clear_link_failure(message)):
+ handle_clear_link_failure(message)
+ except Exception as inst:
+ print(inst)
+
+ time.sleep(pollTime)
+
+
if __name__ == '__main__':
parser = argparse.ArgumentParser(prog='PROG')
parser.add_argument('--mrHost', help='The URL of the MR host (default: %(default)s)', default="http://message-router.onap")
mr_address = mr_host + ":" + str(mr_port) + MR_PATH.replace("[TOPIC]", mr_topic)
sdnr_address = sdnr_host + ":" + str(sdnr_port)
- while True:
- try:
- verboseprint("Polling")
- response = requests.get(mr_address)
- messages = response.json()
- for message in messages:
- if (is_message_new_link_failure(message)):
- handle_link_failure(message, o_ru_to_o_du_map, sdnr_address)
- elif (is_message_clear_link_failure(message)):
- handle_clear_link_failure(message)
- except Exception as inst:
- print(inst)
-
- time.sleep(pollTime)
+ poll_and_handle_messages(mr_address, sdnr_address)
Code Review / nonrtric.git / commitdiff