diff options
Diffstat (limited to 'docs')
| -rwxr-xr-x | docs/consumedapis/consumedapis.rst | 10 | ||||
| -rw-r--r-- | docs/guide/developer-guide.rst | 14 | ||||
| -rw-r--r-- | docs/releasenotes/release-notes.rst | 240 |
3 files changed, 245 insertions, 19 deletions
diff --git a/docs/consumedapis/consumedapis.rst b/docs/consumedapis/consumedapis.rst index e1c6bda6..6c5d33df 100755 --- a/docs/consumedapis/consumedapis.rst +++ b/docs/consumedapis/consumedapis.rst @@ -5,7 +5,7 @@ Consumed APIs ============= -Policy Management Service application is interacting with two ONAP APIs and the A1-P API. +The A1 Policy Management Service consumes two ONAP APIs and the A1-P API. ********************** @@ -14,16 +14,18 @@ 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. +Note: this functionality is deprecated, and will be removed in future versions. + ***************************************** O-RAN A1 Interface for A1 Policies (A1-P) ***************************************** Southbound, the ONAP A1 Policy functions communicate with *near-RT-RIC* RAN functions using the **A1** interface, as defined by the `O-RAN Alliance <https://www.o-ran.org>`_ -The *A1 Interface - Application Protocol Specification (A1-AP)* describe this interface. The specification can be viewed from the `O-RAN Alliance <https://www.o-ran.org>`_ website. +The *A1 Interface - Application Protocol Specification (A1-AP)* describes this interface. The specification can be viewed from the `O-RAN Alliance <https://www.o-ran.org>`_ website. -The **Jakarta** ONAP A1 Policy functions implement the *A1 Policy* parts (*A1-P*) of A1-AP versions *v1.1*, *v2.0* and *v3.0* +The **Kohn** ONAP A1 Policy functions implement the *A1 Policy* parts (*A1-P*) of A1-AP versions *v1.1*, *v2.0* and *v3.0* -An opensource implementation of a `near-RT-RIC <https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=1179659>`_ is available from the `O-RAN Software Community <https://o-ran-sc.org>`_. It supports a pre-spec version of the A1-AP. The ONAP A1 Policy functions described here also supports this A1 version (A1-OSC). +An opensource implementation of a `near-RT-RIC <https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=1179659>`_ is available from the `O-RAN Software Community <https://o-ran-sc.org>`_. It supports a pre-spec version of the A1-AP. The ONAP A1 Policy functions described here also supports this A1 version (*A1-OSC*). An opensource implementation of an `A1 Simulator <https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=3604819>`_ is also available from the `O-RAN Software Community <https://o-ran-sc.org>`_. It supports all versions of A1-AP. diff --git a/docs/guide/developer-guide.rst b/docs/guide/developer-guide.rst index a7c5a835..3734d8fc 100644 --- a/docs/guide/developer-guide.rst +++ b/docs/guide/developer-guide.rst @@ -58,10 +58,10 @@ 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 (deprecated). +The first (*config/application_configuration.json*) contains configuration needed by the application, such as which near-RT-RICs, or controller to use. DMaaP topic can also be configured, but is 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>`_ +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+Kohn>`_ Static configuration - Settings that cannot be changed at runtime (*application.yaml*) -------------------------------------------------------------------------------------- @@ -84,12 +84,14 @@ The file *./config/application.yaml* is read by the application at startup. It p For details about the parameters in this file, see documentation in the file. Dynamic configuration - Settings that can be changed at runtime (*application_configuration.json* or REST or ConfigMap) -------------------------------------------------------------------------------------------------------------------------------- -The component has configuration that can be updated in runtime. This configuration can either be loaded from a file (accessible from the container), or from a CBS/Consul database (Cloudify), or using the Configuration REST API. The configuration is re-read and refreshed at regular intervals. +----------------------------------------------------------------------------------------------------------------------- +The component has configuration that can be updated in runtime. This configuration can either be loaded from a file (accessible from the container), or using the Configuration REST API. The configuration is re-read and refreshed at regular intervals. The configuration includes: * Optional Controller configuration, e.g. an SDNC instance (with A1-Adapter) + + * (If no 'Contoller' is configured, the A1 Policy Management Service will connect direct to near-RT-RICs, bypassing the SDNC controller) * One entry for each near-RT-RIC, which includes: * The base URL of the near-RT-RIC @@ -107,7 +109,7 @@ Configuring certificates The A1 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, with an example is provided in the source code repository *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 +There is also the A1 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 the docker "volumes" @@ -123,7 +125,7 @@ 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" onap/ccsdk-oran-a1policymanagementservice:1.4.0-SNAPSHOT + 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" onap/ccsdk-oran-a1policymanagementservice:1.4.2-SNAPSHOT A1 Adapter (Internal) +++++++++++++++++++++ diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst index 5450e15f..4d3ac9df 100644 --- a/docs/releasenotes/release-notes.rst +++ b/docs/releasenotes/release-notes.rst @@ -55,12 +55,36 @@ Version history Policy Management Service | 2021-09-16 | 1.2.1 | Dan Timoney | M4 version, | | | | | Istanbul Release | +------------+----------+-------------+-------------------+ -| 2021-08-31 | 1.2.0 | Dan Timoney | RC1 version, | +| 2021-10-19 | 1.2.2 | Dan Timoney | RC version, | | | | | Istanbul Release | +------------+----------+-------------+-------------------+ -| 2022-03-28 | 1.3.0 | Dan Timoney | RC1 version, | +| 2021-10-21 | 1.2.3 | Dan Timoney | Release version, | +| | | | Istanbul Release | ++------------+----------+-------------+-------------------+ +| 2021-12-06 | 1.2.4 | Dan Timoney | Release version, | +| | | | Istanbul Release | ++------------+----------+-------------+-------------------+ +| 2021-12-09 | 1.2.5 | Dan Timoney | Release version, | +| | | | Istanbul Release | ++------------+----------+-------------+-------------------+ +| 2022-03-29 | 1.3.0 | Dan Timoney | M4 version, | | | | | Jakarta Release | +------------+----------+-------------+-------------------+ +| 2022-04-29 | 1.3.1 | Dan Timoney | RC1 version, | +| | | | Jakarta Release | ++------------+----------+-------------+-------------------+ +| 2022-06-07 | 1.3.2 | Dan Timoney | Release version, | +| | | | Jakarta Release | ++------------+----------+-------------+-------------------+ +| 2022-08-29 | 1.3.3 | John Keeney | Release version, | +| | | | Jakarta Release | ++------------+----------+-------------+-------------------+ +| 2022-09-26 | 1.4.0 | Dan Timoney | M3 version, | +| | | | Kohn Release | ++------------+----------+-------------+-------------------+ +| 2022-10-25 | 1.4.1 | Dan Timoney | RC (1) version, | +| | | | Kohn Release | ++------------+----------+-------------+-------------------+ Version history A1 Adapter ========================== @@ -69,7 +93,7 @@ Version history A1 Adapter | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +------------+----------+-------------+-------------------+ -| 2019-09-10 | 1.0.0 | Dan Timoney | M4 version, | +| 2020-09-10 | 1.0.0 | Dan Timoney | M4 version, | | | | | Guilin Release | +------------+----------+-------------+-------------------+ | 2020-11-02 | 1.0.1 | Dan Timoney | RC1 version, | @@ -99,12 +123,39 @@ Version history A1 Adapter | 2021-09-02 | 1.2.0 | Dan Timoney | M3 version, | | | | | Istanbul Release | +------------+----------+-------------+-------------------+ -| 2021-08-31 | 1.2.0 | Dan Timoney | RC1 version, | +| 2021-09-16 | 1.2.1 | Dan Timoney | M4 version, | +| | | | Istanbul Release | ++------------+----------+-------------+-------------------+ +| 2021-10-19 | 1.2.2 | Dan Timoney | RC version, | | | | | Istanbul Release | +------------+----------+-------------+-------------------+ -| 2022-03-28 | 1.3.0 | Dan Timoney | RC1 version, | +| 2021-10-21 | 1.2.3 | Dan Timoney | Release version, | +| | | | Istanbul Release | ++------------+----------+-------------+-------------------+ +| 2021-12-06 | 1.2.4 | Dan Timoney | Release version, | +| | | | Istanbul Release | ++------------+----------+-------------+-------------------+ +| 2021-12-09 | 1.2.5 | Dan Timoney | Release version, | +| | | | Istanbul Release | ++------------+----------+-------------+-------------------+ +| 2022-03-29 | 1.3.0 | Dan Timoney | M4 version, | +| | | | Jakarta Release | ++------------+----------+-------------+-------------------+ +| 2022-04-29 | 1.3.1 | Dan Timoney | RC1 version, | | | | | Jakarta Release | +------------+----------+-------------+-------------------+ +| 2022-06-07 | 1.3.2 | Dan Timoney | Release version, | +| | | | Jakarta Release | ++------------+----------+-------------+-------------------+ +| 2022-08-29 | 1.3.3 | John Keeney | Release version, | +| | | | Jakarta Release | ++------------+----------+-------------+-------------------+ +| 2022-09-26 | 1.4.0 | Dan Timoney | M3 version, | +| | | | Kohn Release | ++------------+----------+-------------+-------------------+ +| 2022-10-25 | 1.4.1 | Dan Timoney | RC (1) version, | +| | | | Kohn Release | ++------------+----------+-------------+-------------------+ Release Data ============ @@ -314,7 +365,102 @@ Istanbul, M4 | **Release date** | 2021-09-16 | | | | +-----------------------------+-----------------------------------------------------+ -| **Purpose of the delivery** | Improvements in ORAN, M4 version | +| **Purpose of the delivery** | Improvements in ORAN, 1.2.1, M4 version | +| | | ++-----------------------------+-----------------------------------------------------+ + +Istanbul, RC +------------ ++-----------------------------+-----------------------------------------------------+ +| **Project** | CCSDK ORAN | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Repo/commit-ID** | ccsdk-oran/f726685a515dc9442887b2cea982604c0c459de7 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release designation** | Istanbul | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release date** | 2021-10-19 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Purpose of the delivery** | Improvements in ORAN, 1.2.2, RC version | +| | | ++-----------------------------+-----------------------------------------------------+ + +Istanbul, Release 1.2.3 +----------------------- ++-----------------------------+-----------------------------------------------------+ +| **Project** | CCSDK ORAN | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Repo/commit-ID** | ccsdk-oran/ddc61485ae3c9c856c1f7989515d60a800aba6b9 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release designation** | Istanbul | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release date** | 2021-10-21 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Purpose of the delivery** | Improvements in ORAN, 1.2.3, Release | +| | | ++-----------------------------+-----------------------------------------------------+ + +Istanbul, Release 1.2.4 +----------------------- ++-----------------------------+-----------------------------------------------------+ +| **Project** | CCSDK ORAN | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Repo/commit-ID** | ccsdk-oran/72d8a8abbe096a3e21c920abdc8034437d4b6f7f | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release designation** | Istanbul | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release date** | 2021-12-06 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Purpose of the delivery** | Improvements in ORAN, 1.2.4, Release | +| | | ++-----------------------------+-----------------------------------------------------+ + +Istanbul, Release 1.2.5 +----------------------- ++-----------------------------+-----------------------------------------------------+ +| **Project** | CCSDK ORAN | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Repo/commit-ID** | ccsdk-oran/b056353185760a887d4555c315e094436aaf0050 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release designation** | Istanbul | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release date** | 2021-12-09 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Purpose of the delivery** | Improvements in ORAN, 1.2.5, Release | +| | | ++-----------------------------+-----------------------------------------------------+ + +Jakarta, M4 +------------ ++-----------------------------+-----------------------------------------------------+ +| **Project** | CCSDK ORAN | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Repo/commit-ID** | ccsdk-oran/75978a77bc2d332b23506bc3fc37cf34a809e277 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release designation** | Jakarta | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release date** | 2022-03-29 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Purpose of the delivery** | Improvements, M4 1.3.0 version | | | | +-----------------------------+-----------------------------------------------------+ @@ -324,15 +470,91 @@ Jakarta, RC1 | **Project** | CCSDK ORAN | | | | +-----------------------------+-----------------------------------------------------+ -| **Repo/commit-ID** | ccsdk-oran/4b6205245fd4839e4449e26aa4e3000ddb30ecc1 | +| **Repo/commit-ID** | ccsdk-oran/f061e6cce023d789f2de4035b85e210496216c61 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release designation** | Jakarta | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release date** | 2022-04-29 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Purpose of the delivery** | Improvements, RC1 1.3.1 version | +| | | ++-----------------------------+-----------------------------------------------------+ + +Jakarta, Release 1.3.2 +---------------------- ++-----------------------------+-----------------------------------------------------+ +| **Project** | CCSDK ORAN | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Repo/commit-ID** | ccsdk-oran/da4210def8b1eb998af881ff0cb275cc09449aac | | | | +-----------------------------+-----------------------------------------------------+ | **Release designation** | Jakarta | | | | +-----------------------------+-----------------------------------------------------+ -| **Release date** | 2022-02-28 | +| **Release date** | 2022-06-07 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Purpose of the delivery** | Improvements, Release 1.3.2 version | +| | | ++-----------------------------+-----------------------------------------------------+ + +Jakarta, Release 1.3.3 +---------------------- ++-----------------------------+-----------------------------------------------------+ +| **Project** | CCSDK ORAN | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Repo/commit-ID** | ccsdk-oran/97ace6245fb8b7238d2f7f871797ba03df2d435f | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release designation** | Jakarta | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release date** | 2022-08-29 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Purpose of the delivery** | Improvements, Release 1.3.3 version | +| | | ++-----------------------------+-----------------------------------------------------+ + +Kohn, M3 +-------- ++-----------------------------+-----------------------------------------------------+ +| **Project** | CCSDK ORAN | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Repo/commit-ID** | ccsdk-oran/4e7d4dea70232b2e03a1f8e72d700698acf2bb47 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release designation** | Kohn | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release date** | 2022-09-26 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Purpose of the delivery** | Improvements, Kohn M3 1.4.0 version | +| | | ++-----------------------------+-----------------------------------------------------+ + +Kohn, RC (1) +------------ ++-----------------------------+-----------------------------------------------------+ +| **Project** | CCSDK ORAN | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Repo/commit-ID** | ccsdk-oran/f2e9dce279d7db91645da4c5a19c81904d8cbb9a | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release designation** | Kohn | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release date** | 2022-10-25 | | | | +-----------------------------+-----------------------------------------------------+ -| **Purpose of the delivery** | Improvements, RC1 version | +| **Purpose of the delivery** | Improvements, Kohn RC 1.4.1 version | | | | +-----------------------------+-----------------------------------------------------+ |