X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=9e83177636d3590112bce9b18e6170a8051c0a53;hb=HEAD;hp=9449d6969c9d6d0437fd4bb0278277798bc78dd9;hpb=b17ae674fa99d564280b69b9df89b33695bd7889;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 9449d696..9e831776 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,70 +1,23 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2020 Nordix +.. Copyright (C) 2021-2023 Nordix Foundation. All rights Reserved +.. Copyright (C) 2023 OpenInfra Foundation Europe. All Rights Reserved 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 -------------- +Kubernetes deployment +--------------------- -1. Java development kit (JDK), version 8 -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 +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. -Build and run -------------- -Go to the northbound directory and run this command :: - mvn clean install +For more information on installation of NonRT-RIC in Kubernetes, see `Deploy NONRTRIC in Kubernetes `_. -This will build the project and create artifcats in maven repo +For more information see `Integration and Testing documentation in the O-RAN-SC `_. -Go to oam/installation directory and run this command :: - mvn clean install -P docker - -This will create the docker images required for A1 controller. - -After this step check for the docker images created by the maven build with this command :: - docker images | grep a1-controller - -Go to oam/installation/src/main/yaml and run this command :: - docker-compose up -d a1-controller - -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 - -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. - -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