diff options
| author |   elinuxhenrik <henrik.b.andersson@est.tech> | 2020-10-01 10:52:59 +0200 |
|---|---|---|
| committer |   Singal, Kapil (ks220y) <ks220y@att.com> | 2020-10-07 11:02:35 -0400 |
| commit | 3c0cb32c558ebec18600ee5ec3c00e7fc323f099 (patch) | |
| tree | d34177c4422f84219cb8fa13e0408a2c76466e5d /docs/developer-guide.rst | |
| parent | abc005f4b2f9f80ed7fa658758da803ad6d91583 (diff) | |
Use redoc for api docs
Change-Id: Ia530424154226698aad6c1498c90eadf23efdea0
Issue-ID: CCSDK-2833
Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
Diffstat (limited to 'docs/developer-guide.rst')
| -rw-r--r-- | docs/developer-guide.rst | 56 |
1 files changed, 0 insertions, 56 deletions
diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst deleted file mode 100644 index 8a32b206..00000000 --- a/docs/developer-guide.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2020 Nordix Foundation. - -Developer Guide -=============== - -This document provides a quickstart for developers of the CCSDK ORAN parts. - -A1 Adapter -++++++++++ - -TBD - -The A1 Adapter can be accessed over the REST API. See :ref:`a1-adapter-api` for how to use the API. - - -A1 Policy Management -++++++++++++++++++++ - -The CCSDK Policy Management Service (PMS) 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. - -The Policy Management Service can be accessed over the REST API. See :ref:`pms-api` for how to use the API. - -Configuration of certs ----------------------- -The Policy Management Service uses the default keystore and truststore that are built into the container. The paths and passwords for these stores are located in a yaml file: - oran/a1-policy-management/config/application.yaml - -There is also Policy Management Service's own cert in the default truststore for mocking purposes and unit-testing (ApplicationTest.java). - -The default keystore, truststore, and application.yaml files can be overridden by mounting new files using the "volumes" field of docker-compose or docker run command. - -Assuming that the keystore, truststore, and application.yaml files are located in the same directory as docker-compose, the volumes field should have 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 not be modified. - -Example docker run command for mounting new files (assuming they are located in the current directory): - -`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.1.0-SNAPSHOT` |