Gitiles
Code Review Sign In
gerrit.nordix.org / oransc / nonrtric / plt / a1policymanagementservice / 5a0a2a39ac6d857b8ce36d34684511410e99d970
commit5a0a2a39ac6d857b8ce36d34684511410e99d970[log] [tgz]
authorlapentafd <francesco.lapenta@est.tech>Fri Jun 28 09:55:50 2024 +0100
committerFrancesco Davide Lapenta <francesco.lapenta@est.tech>Fri Jun 28 10:14:12 2024 +0000
tree363caa897519e1f2efa58dbc4f093bf96385493d
parent54d107f1dcf0f0d2a3a5a652ec467d15d1ec6520 [diff]
A1PMS README style check

Issue-ID: NONRTRIC-966
Change-Id: I6a0f1ca17d2579ac3f65ecde0c12f8b7d5288054
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
2 files changed
tree: 363caa897519e1f2efa58dbc4f093bf96385493d
  1. .releases/
  2. add-src/
  3. api/
  4. config/
  5. docs/
  6. onap/
  7. src ⇨ onap/oran/a1-policy-management/src
  8. .gitignore
  9. .gitmodules
  10. .gitreview
  11. .readthedocs.yaml
  12. Dockerfile
  13. INFO.yaml
  14. LICENSE.txt
  15. pom.xml
  16. README.md
  17. tox.ini
README.md

O-RAN-SC Non-RT RIC Policy Agent

The O-RAN Non-RT RIC Policy Agent provides a REST API for the management of policies within the O-RAN architecture. This README provides details on the features, configuration, and running instructions for the Policy Agent. For detailed API documentation and further information, refer to the NONRTRIC documentation at NONRTRIC Wiki.

Features

The Policy Agent offers various functionalities to manage and monitor policies and RIC capabilities:

  • Client Supervision: Monitors clients (R-APPs) to eliminate stray policies in case of client failure.
  • Consistency Monitoring: Ensures the SMO view of policies and RIC capabilities is consistent with the actual situation in the RICs.
  • Policy Configuration:
    • Single REST API for all RICs in the network.
    • Query functions to find all policies in a RIC, all policies owned by a service (R-APP), all policies of a specific type, etc.
    • Maps O1 resources (ManagedElement) to the controlling RIC.

Configuration

The Policy Agent uses default keystore and truststore files included in the container. The paths and passwords for these stores are specified in a YAML configuration file located at:

Default Truststore Certificates

The default truststore includes the following trusted certificates:

Overriding Default Configuration

You can override the default keystore, truststore, and application.yaml files by mounting new files using the volumes field in Docker Compose or the docker run command.

Assuming the new keystore, truststore, and application.yaml files are located in the same directory as your Docker Compose file, the volumes field should include these entries:

volumes:
  - ./new_keystore.jks:/opt/app/policy-agent/etc/cert/keystore.jks:ro
  - ./new_truststore.jks:/opt/app/policy-agent/etc/cert/truststore.jks:ro
  - ./new_application.yaml:/opt/app/policy-agent/config/application.yaml:ro

The target paths in the container should remain unchanged.

Example Docker Run Command To run the Policy Agent container and mount the new configuration files, use the following docker run command:

docker run -p 8081:8081 -p 8433:8433 --name=policy-agent-container --network=nonrtric-docker-net \
  --volume "$PWD/new_keystore.jks:/opt/app/policy-agent/etc/cert/keystore.jks" \
  --volume "$PWD/new_truststore.jks:/opt/app/policy-agent/etc/cert/truststore.jks" \
  --volume "$PWD/new_application.yaml:/opt/app/policy-agent/config/application.yaml" \
  o-ran-sc/nonrtric-policy-agent:2.2.0-SNAPSHOT

Running Policy Agent Locally

To run the Policy Agent locally in a simulated test mode, follow these steps:

  1. In the folder /opt/app/policy-agent/config/, create a soft link to your test configuration file:
ln -s <path to test_application_configuration.json> application_configuration.json
  1. Start the Policy Agent with the following Maven command:
mvn -Dtest=MockPolicyAgent test

This will start the agent in a simulated mode, where it mimics the behavior of RICs. The REST API will be available on port 8081.

API Documentation

The backend server publishes live API documentation, which can be accessed at:

http://your-host-name-here:8081/swagger-ui.html

License

Copyright (C) 2019 Nordix Foundation. All rights reserved. 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.