policy-agent/README.md

   1 # O-RAN-SC NonRT RIC Dashboard Web Application
   2
   3 The O-RAN NonRT RIC PolicyAgent provides a REST API for management of
   4 policices. It provides support for
   5 -Policy configuration. This includes
   6  -One REST API towards all RICs in the network
   7  -Query functions that can find all policies in a RIC, all policies owned by a service (R-APP), all policies of a type etc.
   8  -Maps O1 resources (ManagedElement) as defined in O1 to the controlling RIC
   9 -Supervision of clients (R-APPs) to eliminate stray policies in case of failure
  10 -Consistency monitoring of the SMO view of policies and the actual situation in the RICs
  11 -Consistency monitoring of RIC capabilities (policy types)
  12
  13 To Run Policy Agent in Local:
  14 Create a symbolic link with below command,
  15 ln -s <path to test_application_configuration.json> application_configuration.json
  16
  17 The agent can be run stand alone in a simulated test mode. Then it
  18 simulates RICs.
  19 The REST API is published on port 8081 and it is started by command:
  20 mvn -Dtest=MockPolicyAgent test
  21
  22 The backend server publishes live API documentation at the
  23 URL `http://your-host-name-here:8080/swagger-ui.html`
  24
  25 ## License
  26
  27 Copyright (C) 2019 Nordix Foundation. All rights reserved.
  28 Licensed under the Apache License, Version 2.0 (the "License");
  29 you may not use this file except in compliance with the License.
  30 You may obtain a copy of the License at
  31
  32      http://www.apache.org/licenses/LICENSE-2.0
  33
  34 Unless required by applicable law or agreed to in writing, software
  35 distributed under the License is distributed on an "AS IS" BASIS,
  36 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  37 See the License for the specific language governing permissions and
  38 limitations under the License.