diff options
Diffstat (limited to 'docs')
| -rwxr-xr-x | docs/consumedapis/consumedapis.rst | 6 | ||||
| -rw-r--r-- | docs/guide/developer-guide.rst | 16 | ||||
| -rw-r--r-- | docs/offeredapis/offeredapis.rst | 1 |
3 files changed, 8 insertions, 15 deletions
diff --git a/docs/consumedapis/consumedapis.rst b/docs/consumedapis/consumedapis.rst index b7c42a97..e1c6bda6 100755 --- a/docs/consumedapis/consumedapis.rst +++ b/docs/consumedapis/consumedapis.rst @@ -8,9 +8,9 @@ Consumed APIs Policy Management Service application is interacting with two ONAP APIs and the A1-P API. -********* -DMaaP API -********* +********************** +DMaaP API (deprecated) +********************** The A1 Policy Management Service API can also be accessed using *ONAP DMaaP*. To support this the `DMaaP Message Router API <https://docs.onap.org/projects/onap-dmaap-messagerouter-messageservice/en/latest/offeredapis/api.html>`_ is used. diff --git a/docs/guide/developer-guide.rst b/docs/guide/developer-guide.rst index 866f6212..a7c5a835 100644 --- a/docs/guide/developer-guide.rst +++ b/docs/guide/developer-guide.rst @@ -33,6 +33,7 @@ A1 Policy Management Service provides a REST API for management of policies. It * Maps O1 resources (ManagedElement) as defined in O1 to the controlling RIC. The Policy Management Service can be accessed over the REST API, and with an equivalent interface using DMaaP. See :ref:`pms_api` for more information about the API. +Note that DMaaP is deprecated and the possibility to access this service using DMaaP is deprecated and will be removed. The configured A1 policies are stored persistently to survive a service restart. @@ -57,7 +58,7 @@ Configuration ------------- There are two configuration files for A1 Policy Management Service, *config/application_configuration.json* and *config/application.yaml* -The first (*config/application_configuration.json*) contains configuration needed by the application, such as which near-RT-RICs, controller, or DMaaP topic to use. +The first (*config/application_configuration.json*) contains configuration needed by the application, such as which near-RT-RICs, controller, or DMaaP topic to use (deprecated). The second (*config/application.yaml*) contains logging and security configurations. For more information about these configuration files can be found as comments in the sample files provided with the source code, or on the `ONAP wiki <https://wiki.onap.org/display/DW/O-RAN+A1+Policies+in+ONAP+Jakarta>`_ @@ -94,17 +95,8 @@ The configuration includes: * The base URL of the near-RT-RIC * A optional list of O1 identifiers that near-RT-RIC is controlling. An application can query this service which near-RT-RIC should be addressed for which component (e.g. cells, sectors, locations, etc.) . * An optional reference to the controller to use, or excluded if the near-RT-RIC should be accessed directly from the A1 Policy Management Service. - - * Optional configuration for using of DMaaP. There can be one stream for requests to the component and an other stream for responses. - - * Controller configuration, which includes information on how to access the a1-adapter - * One entry for each NearRT-RIC, which includes: - - * The base URL of the NearRT RIC - * A list of O1 identifiers that the NearRT RIC is controlling. An application can query this service which NearRT RIC should be addressed for controlling (for instance) a given Cell. - * An optional reference to the controller to use, or excluded if the NearRT-RIC can be accessed directly from this component. - - * Optional configuration for using of DMaaP. There can be one stream for requests to the component and an other stream for responses. + + * Optional configuration for using of DMaaP (deprecated). There can be one stream for requests to the component and an other stream for responses. For details about the syntax of the file, there is an example in source code repository */config/application_configuration.json*. This file is also included in the docker container */opt/app/policy-agent/data/application_configuration.json_example*. diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst index 28f00835..fd65ebf9 100644 --- a/docs/offeredapis/offeredapis.rst +++ b/docs/offeredapis/offeredapis.rst @@ -20,6 +20,7 @@ Overall architecture for O-RAN A1 Policy functions This picture provides a overview of ONAP's A1 Controller architecture, integration with other ONAP components and API resource/operation provided. +Note that DMaaP is deprecated and will be removed in later releases. .. image:: ../media/ONAP-A1ControllerArchitecture.png :width: 500pt |