X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=0d950cd3436776457219c5d0134fef51c37343dc;hb=c621b96345d48a7ee70b7ead65a8ce166d71adde;hp=0b98cc556c4d9af2466cc7fb1e85fb0ec4620928;hpb=448c3841f395c0927d83c7297491475e027f23c5;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 0b98cc55..0d950cd3 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,86 +1,100 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2021 Nordix -SDNC A1 Controller Developer Guide -================================== +Developer Guide +=============== -This document provides a quickstart for developers of the O-RAN SC A1 Controller SDNC Application +This document provides a quickstart for developers of the Non-RT RIC parts. -Prerequisites -------------- +Additional developer guides are available on the `O-RAN SC NONRTRIC Developer 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 +A1 Policy Management Service & SDNC/A1 Controller & A1 Adapter +-------------------------------------------------------------- -Go to the northbound directory and run this command :: - mvn clean install +The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation `_ +and `wiki `_. -This will build the project and create artifcats in maven repo +Information Coordinator Service +------------------------------- +The Information Coordinator Service is a Java 11 web application built using the Spring Framework. Using Spring Boot +dependencies, it runs as a standalone application. -Go to oam/installation directory and run this command :: - mvn clean install -P docker +Its main functionality is to act as a data subscription broker and to decouple data producer from data consumers. -This will create the docker images required for sdnc +See the ./config/README file in the *information-coordinator-service* directory Gerrit repo on how to create and setup +the certificates and private keys needed for HTTPS. -After this step check for the docker images created by the maven build with this command :: - docker images | grep sdnc +Start standalone +++++++++++++++++ -Go to oam/installation/src/main/yaml and run this command :: - docker-compose up -d sdnc +The project uses Maven. To start the Information Coordinator Service as a freestanding application, run the following +command in the *information-coordinator-service* directory: -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 + +-----------------------------+ + | mvn spring-boot:run | + +-----------------------------+ -The SDNC url to access the Northbound API, - http://localhost:8282/apidoc/explorer/index.html +There are a few files that needs to be available to run. These are referred to from the application.yaml file. +The following properties have to be modified: -Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U +* server.ssl.key-store=./config/keystore.jks +* app.webclient.trust-store=./config/truststore.jks +* app.vardata-directory=./target -Policy Agent -===================================== -The O-RAN NonRT RIC PolicyAgent provides a REST API for management of policices. It provides support for: +Start in Docker ++++++++++++++++ - * 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: +To build and deploy the Information Coordinator Service, go to the "information-coordinator-service" folder and run the +following command: - * 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 PolicyAgent 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 README file of PolicyAgent to know more about the API's. + +-----------------------------+ + | mvn clean install | + +-----------------------------+ +Then start the container by running the following command: -Near-RT RIC Simulator Developer Guide -===================================== + +--------------------------------------------------------------------+ + | docker run nonrtric-information-coordinator-service | + +--------------------------------------------------------------------+ -Prerequisites -------------- +Initial Non-RT-RIC App Catalogue +-------------------------------- -1. Java development kit (JDK), version 8 -2. Maven dependency-management tool, version 3.4 or later +See the README.md file in the *r-app-catalogue* directory in the Gerrit repo for more details how to run the component. -Go to the nearric-simulator/ directory and run this command :: - mvn clean install +DMaaP Adaptor Service +--------------------- +This is run in the same way as the Information Coordinator Service -If you want to genereate the sources from A1 yaml file, Go to nearric-simulator/a1-med-api/ and run this command :: - mvn generate-sources +The following properties in the application.yaml file have to be modified: +* server.ssl.key-store=./config/keystore.jks +* app.webclient.trust-store=./config/truststore.jks +* app.configuration-filepath=./src/test/resources/test_application_configuration.json -This will generate the A1PApi.java you need to call the generate-sources maven life cycle to generate the file +O-DU & O-RU fronthaul recovery +------------------------------ -The backend server listens for requests at this URL: - http://localhost:8080 +See the page in Wiki: `O-RU Fronthaul Recovery usecase `_ -The backend server publishes live API documentation at the URL - http://localhost:8080/swagger-ui.html +O-DU Slicing use cases +---------------------- -End-to-end call -=============== +See the page in Wiki: `O-DU Slice Assurance usecase `_ + +Helm Manager +------------ + +See the page in Wiki: `Release E `_ + +Kubernetes deployment +===================== + +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 on installation of NonRT-RIC in Kubernetes, see `Deploy NONRTRIC in Kubernetes `_ -In order to make a complete end-to-end call, follow the instructions given in this `guide`_. +For more information see `Integration and Testing documentation on the O-RAN-SC wiki `_. -.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166