Updated the documentation
[nonrtric.git] / docs / developer-guide.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3
4 SDNC A1 Controller Developer Guide
5 ==================================
6
7 This document provides a quickstart for developers of the O-RAN SC A1 Controller SDNC Application
8
9 Prerequisites
10 -------------
11
12 1. Java development kit (JDK), version 8
13 2. Maven dependency-management tool, version 3.4 or later
14 3. Python, version 2
15 4. Docker, version 19.03.1 or later
16 5. Docker Compose, version 1.24.1 or later
17
18 Go to the northbound directory and run this command ::
19     mvn clean install
20
21 This will build the project and create artifcats in maven repo
22
23 Go to oam/installation directory and run this command ::
24     mvn clean install -P docker
25
26 This will create the docker images required for sdnc
27
28 After this step check for the docker images created by the maven build with this command ::
29     docker images | grep sdnc
30
31 Go to oam/installation/src/main/yaml and run this command ::
32     docker-compose up -d sdnc
33
34 This will create the docker containers with the sdnc image, you can check the status of the docker container using ::
35     docker-compose logs -f sdnc
36
37 The SDNC url to access the Northbound API,
38     http://localhost:8282/apidoc/explorer/index.html
39
40 Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
41
42 Policy Agent
43 =====================================
44 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.
45 The PolicyAgent can be accessed over the REST API or throught DMaaP Interface. Please Refer README file of PolicyAgent to know more about the API's.
46
47
48 Near-RT RIC Simulator Developer Guide
49 =====================================
50
51 Prerequisites
52 -------------
53
54 1. Java development kit (JDK), version 8
55 2. Maven dependency-management tool, version 3.4 or later
56
57 Go to the nearric-simulator/ directory and run this command ::
58      mvn clean install
59
60 If you want to genereate the sources from A1 yaml file, Go to nearric-simulator/a1-med-api/ and run this command ::
61      mvn generate-sources
62
63 This will generate the A1PApi.java you need to call the generate-sources maven life cycle to generate the file
64
65 The backend server listens for requests at this URL:
66    http://localhost:8080
67
68 The backend server publishes live API documentation at the URL
69    http://localhost:8080/swagger-ui.html
70
71 End-to-end call
72 ===============
73
74 In order to make a complete end-to-end call, follow the instructions given in this `guide`_.
75
76 .. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166