1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2020 Nordix
8 This document provides a quickstart for developers of the Non-RT RIC.
16 1. Java development kit (JDK), version 8
17 2. Maven dependency-management tool, version 3.4 or later
19 4. Docker, version 19.03.1 or later
20 5. Docker Compose, version 1.24.1 or later
24 Go to the northbound directory and run this command ::
27 This will build the project and create artifcats in maven repo
29 Go to oam/installation directory and run this command ::
30 mvn clean install -P docker
32 This will create the docker images required for sdnc
34 After this step check for the docker images created by the maven build with this command ::
35 docker images | grep sdnc
37 Go to oam/installation/src/main/yaml and run this command ::
38 docker-compose up -d sdnc
40 This will create the docker containers with the sdnc image, you can check the status of the docker container using ::
41 docker-compose logs -f sdnc
43 The SDNC url to access the Northbound API,
44 http://localhost:8282/apidoc/explorer/index.html
46 Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
51 The O-RAN Non-RT RIC Policy Agent provides a REST API for management of policices. It provides support for:
53 * Supervision of clients (R-APPs) to eliminate stray policies in case of failure
54 * Consistency monitoring of the SMO view of policies and the actual situation in the RICs
55 * Consistency monitoring of RIC capabilities (policy types)
56 * Policy configuration. This includes:
58 * One REST API towards all RICs in the network
59 * Query functions that can find all policies in a RIC, all policies owned by a service (R-APP), all policies of a type etc.
60 * Maps O1 resources (ManagedElement) as defined in O1 to the controlling RIC.
62 | The Policy Agent can be accessed over the REST API or through the DMaaP Interface. The REST API is documented in the
63 | *nonrtric/policy-agent/docs/api.yaml* file. Please refer to the README file of Policy Agent to know more about the API's.
68 In order to make a complete end-to-end call, follow the instructions given in this `guide`_.
70 .. _guide: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=12157166