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=36ac802dd82aec50e13e76953f8ba72619e5a302;hpb=e94200843789d401cd13a3b87dc19ae0cc73974f;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 36ac802d..43ac2d15 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,92 +1,65 @@ -.. ============LICENSE_START======================================================= -.. Copyright (C) 2019 Nordix Foundation. -.. ================================================================================ -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. -.. SPDX-License-Identifier: Apache-2.0 -.. ============LICENSE_END========================================================= +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2020 Nordix -A1 Mediation: -1. SDNC Controller -2. Near-RT RIC Simulator +Developer Guide +=============== -********************************** -SDNC A1 Controller Developer Guide -********************************** +This document provides a quickstart for developers of the Non-RT RIC parts. -This document provides a quickstart for developers of the O-RAN SC A1 Controller SDNC Application +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 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 +The A1 Policy Management Service is implemented in ONAP. For documentation see `ONAP CCSDK documentation `_ +and `wiki `_. -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 sdnc +Start standalone +++++++++++++++++ -After this step check for the docker images created by the maven build with this command :: - docker images | grep sdnc +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 sdnc + +-----------------------------+ + | mvn spring-boot:run | + +-----------------------------+ -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 +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 | + +-----------------------------+ -************************************* -Near-RT RIC Simulator Developer Guide -************************************* +Then start the container by running the following command: -Prerequisites -------------- + +--------------------------------------------------------------------+ + | docker run nonrtric-enrichment-coordinator-service | + +--------------------------------------------------------------------+ -1. Java development kit (JDK), version 8 -2. Maven dependency-management tool, version 3.4 or later +Initial Non-RT-RIC App Catalogue +-------------------------------- -Go to the nearric-simulator/ directory and run this command :: - mvn clean install +See the README.md file in the *r-app-catalogue* directory in the Gerrit repo for more details how to run the component. -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 +Kubernetes deployment +===================== -This will generate the A1PApi.java you need to call the generate-sources maven life cycle to generate the file - -The backend server listens for requests at this URL: - http://localhost:8080 - -The backend server publishes live API documentation at the URL - http://localhost:8080/swagger-ui.html - -*************** -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 \ No newline at end of file +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 `_.