X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=5358fe3c3a9357531da8b7b681f00d124f3b83ce;hb=2dbde318f013212c81c4a1f477d7638ec3367aa5;hp=63829e260dee06a6fa5cb6c5bcb7c0ed30e8d536;hpb=9c2bfab6a9c8a40b8336ab4d457dd2feae9a149c;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 63829e26..5358fe3c 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,89 +1,28 @@ -.. ============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 - -SDNC A1 Controller Developer Guide -================================== - -This document provides a quickstart for developers of the O-RAN SC A1 Controller SDNC Application - -Prerequisites -------------- - -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 - -Go to the northbound directory and run this command :: - mvn clean install - -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 :: - docker images | grep sdnc - -Go to oam/installation/src/main/yaml and run this command :: - docker-compose up -d sdnc - -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 - -The SDNC url to access the Northbound API, - http://localhost:8282/apidoc/explorer/index.html - -Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U - -Near-RT RIC Simulator Developer Guide -===================================== - -Prerequisites -------------- +Developer Guide +=============== -1. Java development kit (JDK), version 8 -2. Maven dependency-management tool, version 3.4 or later +This document provides a quickstart for developers of the Non-RT RIC. -Go to the nearric-simulator/ directory and run this command :: - mvn clean install +A1 Policy Management 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 Policy Management is implemented in ONAP. For documentation see `readthedocs`_ and `wiki`_. -This will generate the A1PApi.java you need to call the generate-sources maven life cycle to generate the file +.. _readthedocs: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html +.. _wiki: https://wiki.onap.org/pages/viewpage.action?pageId=84644984 -The backend server listens for requests at this URL: - http://localhost:8080 +rAPP Catalogue +-------------- -The backend server publishes live API documentation at the URL - http://localhost:8080/swagger-ui.html +See the README.md file in the r-app-catalogue folder for how to run the component. 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 +.. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166