-.. ============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
-
-**********************************
-SDNC A1 Controller Developer Guide
-**********************************
-
-This document provides a quickstart for developers of the O-RAN SC A1 Controller SDNC Application
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2020 Nordix
+
+Developer Guide
+===============
+
+This document provides a quickstart for developers of the Non-RT RIC.
+
+SDNC A1 Controller
+==================
Prerequisites
-------------
1. Java development kit (JDK), version 8
-2. Maven dependency-management tool, version 3.4 or later
+2. Maven dependency-management tool, version 3.6 or later
3. Python, version 2
-4. Docker, version 19.03.1 or later
-5. Docker Compose, version 1.24.1 or later
+4. Docker, version 19.03.1 or latest
+5. Docker Compose, version 1.24.1 or latest
+Build and run
+-------------
Go to the northbound directory and run this command ::
mvn clean install
Go to oam/installation directory and run this command ::
mvn clean install -P docker
-This will create the docker images required for sdnc
+This will create the docker images required for A1 controller.
After this step check for the docker images created by the maven build with this command ::
- docker images | grep sdnc
+ docker images | grep a1-controller
Go to oam/installation/src/main/yaml and run this command ::
- docker-compose up -d sdnc
+ docker-compose up -d a1-controller
-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
+This will create the docker containers with the A1 controller image, you can check the status of the docker container using ::
+ docker-compose logs -f a1-controller
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
--------------
-
-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
+Policy Agent
+============
-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 O-RAN Non-RT RIC Policy Agent provides a REST API for management of policices. It provides support for:
-This will generate the A1PApi.java you need to call the generate-sources maven life cycle to generate the file
+ * 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:
-The backend server listens for requests at this URL:
- http://localhost:8080
+ * 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 backend server publishes live API documentation at the URL
- http://localhost:8080/swagger-ui.html
+| The Policy Agent 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 to the README file of Policy Agent to know more about the API's.
-***************
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
Code Review / nonrtric.git / blobdiff