X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=0b98cc556c4d9af2466cc7fb1e85fb0ec4620928;hb=710610557eeca8da05020d062a65805dd2f0fc09;hp=94044d04db7aff1851015dc38a93e480f76e5397;hpb=1279d1964e3a02af70fcc3532928a82b869181be;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 94044d04..0b98cc55 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,24 +1,5 @@ -.. ============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========================================================= - -A1 Mediation: -1. SDNC Controller -2. Near-RT RIC Simulator +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 SDNC A1 Controller Developer Guide ================================== @@ -41,6 +22,7 @@ This will build the project and create artifcats in maven repo Go to oam/installation directory and run this command :: mvn clean install -P docker + 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 :: @@ -55,7 +37,23 @@ This will create the docker containers with the sdnc image, you can check the st The SDNC url to access the Northbound API, http://localhost:8282/apidoc/explorer/index.html -Credentails: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U +Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U + +Policy Agent +===================================== +The O-RAN NonRT RIC PolicyAgent 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 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. + Near-RT RIC Simulator Developer Guide ===================================== @@ -79,3 +77,10 @@ The backend server listens for requests at this URL: 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