X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=93182d31cff5bf6e233a2cafe1987a177e3c49db;hb=1e714863191f051b1e156f64e61393a312f7a163;hp=549662d3ebfd2b3fc15bb5ab7897a414ef303fd7;hpb=fd5e1f38fac7e52c0a975051c9e09a8b2c257bee;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 549662d3..93182d31 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -7,63 +7,32 @@ Developer Guide This document provides a quickstart for developers of the Non-RT RIC. -SDNC A1 Controller -================== +A1 Policy Management Service +---------------------------- -Prerequisites -------------- +The Policy Management is implemented in ONAP. For documentation see `readthedocs`_ and `wiki`_. -1. Java development kit (JDK), version 8 -2. Maven dependency-management tool, version 3.4 or later -3. Python, version 2 -4. Docker, version 19.03.1 or later -5. Docker Compose, version 1.24.1 or later +.. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html +.. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984 -Build and run -------------- -Go to the northbound directory and run this command :: - mvn clean install +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. -This will build the project and create artifcats in maven repo +Its main functionality is to act as a data subscription broker and to decouple data +producer from data consumers. -Go to oam/installation directory and run this command :: - mvn clean install -P docker +See the ./config/README file on how to create and setup the cerificates and private keys needed for HTTPS. -This will create the docker images required for sdnc -After this step check for the docker images created by the maven build with this command :: - docker images | grep sdnc +rAPP Catalogue +-------------- -Go to oam/installation/src/main/yaml and run this command :: - docker-compose up -d sdnc - -This will create the docker containers with the sdnc image, you can check the status of the docker container using :: - docker-compose logs -f sdnc - -The SDNC url to access the Northbound API, - http://localhost:8282/apidoc/explorer/index.html - -Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U - -Policy Agent -============ - -The O-RAN Non-RT RIC Policy Agent provides a REST API for management of policices. It provides support for: - - * Supervision of clients (R-APPs) to eliminate stray policies in case of failure - * Consistency monitoring of the SMO view of policies and the actual situation in the RICs - * Consistency monitoring of RIC capabilities (policy types) - * Policy configuration. This includes: - - * One REST API towards all RICs in the network - * Query functions that can find all policies in a RIC, all policies owned by a service (R-APP), all policies of a type etc. - * Maps O1 resources (ManagedElement) as defined in O1 to the controlling RIC. - -| The Policy Agent can be accessed over the REST API or through the DMaaP Interface. The REST API is documented in the -| *nonrtric/policy-agent/docs/api.yaml* file. Please refer to the README file of Policy Agent to know more about the API's. +See the README.md file in the r-app-catalogue folder for how to run the component. End-to-end call -=============== +--------------- In order to make a complete end-to-end call, follow the instructions given in this `guide`_.