X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=9e83177636d3590112bce9b18e6170a8051c0a53;hb=ad29f8c95374793b37b2e98291e6315ea1ec45fe;hp=94044d04db7aff1851015dc38a93e480f76e5397;hpb=1279d1964e3a02af70fcc3532928a82b869181be;p=nonrtric.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 94044d04..9e831776 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,81 +1,23 @@ -.. ============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) 2021-2023 Nordix Foundation. All rights Reserved +.. Copyright (C) 2023 OpenInfra Foundation Europe. All Rights Reserved -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 -------------- +Kubernetes deployment +--------------------- -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 +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. -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 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 - -Credentails: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U - -Near-RT RIC Simulator Developer Guide -===================================== - -Prerequisites -------------- - -1. Java development kit (JDK), version 8 -2. Maven dependency-management tool, version 3.4 or later - -Go to the nearric-simulator/ directory and run this command :: - mvn clean install - -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 - -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