X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=43ac2d1531fc6e430a32cf98464f735d25281e9b;hb=refs%2Fheads%2Fdawn;hp=36ae9d22ab27ea97c50d650cb1393bd6085971d3;hpb=5a7560b9906f08ba2a47daace7da78484188aed7;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 36ae9d22..43ac2d15 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -5,66 +5,61 @@ Developer Guide =============== -This document provides a quickstart for developers of the Non-RT RIC. +This document provides a quickstart for developers of the Non-RT RIC parts. -SDNC A1 Controller -================== +Additional developer guides are available on the `O-RAN SC NONRTRIC Developer wiki `_ -Prerequisites -------------- +A1 Policy Management Service & SDNC/A1 Controller & A1 Adapter +-------------------------------------------------------------- -1. Java development kit (JDK), version 11 -2. Maven dependency-management tool, version 3.6 or later -3. Python, version 2 -4. Docker, version 19.03.1 or latest -5. Docker Compose, version 1.24.1 or latest +The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation `_ +and `wiki `_. -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 in the *enrichment-coordinator-service* directory Gerrit repo on how to create and setup +the certificates and private keys needed for HTTPS. -This will create the docker images required for A1 controller. +Start standalone +++++++++++++++++ -After this step check for the docker images created by the maven build with this command :: - docker images | grep a1-controller +The project uses Maven. To start the Enrichment Coordinator Service as a freestanding application, run the following +command in the *enrichment-coordinator-service* directory: -Go to oam/installation/src/main/yaml and run this command :: - docker-compose up -d a1-controller + +-----------------------------+ + | mvn spring-boot:run | + +-----------------------------+ -This will create the docker containers with the A1 controller image, you can check the status of the docker container using :: - docker-compose logs -f a1-controller +Start in Docker ++++++++++++++++ -The SDNC url to access the Northbound API, - http://localhost:8282/apidoc/explorer/index.html +To build and deploy the Enrichment Coordinator Service, go to the "enrichment-coordinator-service" folder and run the +following command: -Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U + +-----------------------------+ + | mvn clean install | + +-----------------------------+ -Policy Agent -============ +Then start the container by running the following command: -The O-RAN Non-RT RIC Policy Agent provides a REST API for management of policices. It provides support for: + +--------------------------------------------------------------------+ + | docker run nonrtric-enrichment-coordinator-service | + +--------------------------------------------------------------------+ - * 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: +Initial Non-RT-RIC App Catalogue +-------------------------------- - * 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. +See the README.md file in the *r-app-catalogue* directory in the Gerrit repo for more details how to run the component. -| 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. +Kubernetes deployment +===================== -End-to-end call -=============== - -In order to make a complete end-to-end call, follow the instructions given in this `guide`_. - -.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166 +Non-RT RIC can be also deployed in a Kubernetes cluster, `it/dep repository `_ +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 `_.