diff options
author | 2022-05-12 22:15:14 +0100 | |
---|---|---|
committer | 2022-05-17 09:56:16 +0000 | |
commit | c1778929dbf61e1a2ae31f20b90fedd4f0daae2a (patch) | |
tree | 7055d089342abdaa3b0e47c31b19ab003743b60e /docs | |
parent | 219aca6f1fa526fa0bdc8546a88a612aa2b512f7 (diff) |
Documentation updates
Updated RTD documentation, and fixed some typos in java files conatining annotations
used to generate OpenAPI (json, yaml, html) specs & docs.
Issue-ID: CCSDK-3616
Change-Id: Iefa905f4c0f13cb013872d4858232695fc107927
Signed-off-by: JohnKeeney <john.keeney@est.tech>
(cherry picked from commit 069b469a3990f30b3a0012f3d9fde535ebf3149f)
Diffstat (limited to 'docs')
-rwxr-xr-x | docs/architecture/architecture.rst | 8 | ||||
-rwxr-xr-x | docs/consumedapis/consumedapis.rst | 13 | ||||
-rw-r--r-- | docs/guide/developer-guide.rst | 75 | ||||
-rw-r--r-- | docs/humaninterfaces/humaninterfaces.rst | 4 | ||||
-rw-r--r-- | docs/index.rst | 2 | ||||
-rw-r--r-- | docs/media/ONAP-A1ControllerArchitecture.png | bin | 79142 -> 75211 bytes | |||
-rw-r--r-- | docs/offeredapis/offeredapis.rst | 4 | ||||
-rw-r--r-- | docs/offeredapis/swagger/a1-adapter-api.yaml | 2 | ||||
-rw-r--r-- | docs/offeredapis/swagger/pms-api.json | 12 | ||||
-rw-r--r-- | docs/offeredapis/swagger/pms-api.yaml | 30 | ||||
-rw-r--r-- | docs/releasenotes/release-notes.rst | 136 |
11 files changed, 216 insertions, 70 deletions
diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst index 1e0f0691..a9facd53 100755 --- a/docs/architecture/architecture.rst +++ b/docs/architecture/architecture.rst @@ -1,5 +1,5 @@ .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright 2021 Nordix Foundation +.. Copyright 2022 Nordix Foundation .. _architecture: @@ -16,9 +16,9 @@ The CCSDK ORAN components add support for handling "A1 Policies" as defined for The O-RAN A1 interface is defined by the `O-RAN Alliance <https://www.o-ran.org>`_ -********************************************* -Architecture for ONAP Honolulu release -********************************************* +******************* +Architecture Review +******************* This picture provides a overview of ONAP's A1 Controller architecture, integration with other ONAP components and API resource/operation provided. diff --git a/docs/consumedapis/consumedapis.rst b/docs/consumedapis/consumedapis.rst index b572bc49..b7c42a97 100755 --- a/docs/consumedapis/consumedapis.rst +++ b/docs/consumedapis/consumedapis.rst @@ -1,5 +1,5 @@ .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright 2021 Nordix Foundation +.. Copyright 2022 Nordix Foundation Consumed APIs ============= @@ -9,18 +9,21 @@ Policy Management Service application is interacting with two ONAP APIs and the ********* -DMAAP API +DMaaP API ********* 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. ***************************************** -O-RAN A1 interface for A1 Policies (A1-P) +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. - -An opensource implementation of a `near-RT-RIC <https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=1179659>`_ is available from `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). +The **Jakarta** 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 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 29c9f91d..866f6212 100644 --- a/docs/guide/developer-guide.rst +++ b/docs/guide/developer-guide.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2021 Nordix Foundation. +.. Copyright (C) 2022 Nordix Foundation. .. _developer_guide: @@ -13,7 +13,7 @@ Source tree +++++++++++ This provides CCSDK with "A1 Policy Management Service" and "A1 Adapter" functions. -Each resource is implemented independently in a package corresponding to its name. +Each resource is implemented independently in a sub-directory corresponding to its name. A1 Policy Management Service ++++++++++++++++++++++++++++ @@ -34,7 +34,7 @@ A1 Policy Management Service provides a REST API for management of policies. It 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. -The configured A1 policies are stored presistently to survive a service restart. +The configured A1 policies are stored persistently to survive a service restart. Dependencies ------------ @@ -42,19 +42,28 @@ Dependencies This project uses various frameworks which are managed with Maven dependency management tool (see *pom.xml* file at root level) : +- Swagger annotations +- `Spring Framework <https://github.com/spring-projects/spring-boot>`_ +- `Springfox <https://github.com/springfox/springfox>`_ Automated JSON API documentation for APIs built with Spring +- `Immutable <https://immutables.github.io/>`_ to generate simple, safe and consistent value objects +- `JSON in Java <https://github.com/stleary/JSON-java>`_ to parse JSON documents into Java objects +- `Apache Commons Net <https://github.com/apache/commons-net>`_ for network utilities and protocol implementations +- `Lombok <https://github.com/rzwitserloot/lombok>`_ to generate code, such as getters and setters +- `Awaitility <https://github.com/awaitility/awaitility>`_ to test asynchronous functionality + To get a complete list of all dependencies, use command "mvn dependency:tree". Configuration ------------- There are two configuration files for A1 Policy Management Service, *config/application_configuration.json* and *config/application.yaml* -The first one contains configuration of data needed by the application, such as which Near-RT RICs -that are available. The second contains logging and security configurations. +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 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+Honolulu>`_ +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>`_ -Static configuration (application.yaml) ---------------------------------------- +Static configuration - Settings that cannot be changed at runtime (*application.yaml*) +-------------------------------------------------------------------------------------- The file *./config/application.yaml* is read by the application at startup. It provides the following configurable features: @@ -67,18 +76,27 @@ The file *./config/application.yaml* is read by the application at startup. It p * SSL parameters for setting up using of key store and trust store databases. * Usage of HTTP(S) Proxy; if configured, the proxy will be used for southbound access to the NearRT-RICs - * logging; setting of of which information that is logged. + * logging; setting for which information is logged. + * auth-token; optional authorization token to use for REST call. * filepath; the local path to a file used for dynamic configuration (if used). See next chapter. For details about the parameters in this file, see documentation in the file. -Dynamic configuration ---------------------- - -The component has configuration that can be updated in runtime. This configuration is loaded from a file (accessible from the container). The configuration is re-read and refreshed at regular intervals. This file based configuration can be updated or read via the REST API, See :ref:`pms_api`. +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 configuration includes: + * Optional Controller configuration, e.g. an SDNC instance (with A1-Adapter) + * One entry for each near-RT-RIC, which 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: @@ -86,40 +104,34 @@ The configuration includes: * 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. 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*. -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: :: +Configuring certificates +------------------------ - oran/a1-policy-management/config/application.yaml +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 -(ApplicationTest.java). +(*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 default keystore, truststore, and application.yaml files can be overridden by mounting new files using the the docker "volumes" +command for 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" onap/ccsdk-oran-a1policymanagementservice:1.2.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.0-SNAPSHOT A1 Adapter (Internal) +++++++++++++++++++++ @@ -132,8 +144,11 @@ Configuration of HTTP Proxy --------------------------- In order to configure a HTTP Proxy for southbound connections: - * Modify file: odlsli/src/main/properties/a1-adapter-api-dg.properties in CCSDK/distribution - * Variable a1Mediator.proxy.url must contain Proxy URL + * Modify file: *odlsli/src/main/properties/a1-adapter-api-dg.properties*. This file is found in CCSDK/distribution for SDNC. + * In a running container this file is found at */opt/onap/ccsdk/data/properties/a1-adapter-api-dg.properties* + * Variable a1Mediator.proxy.url must contain the full Proxy URL + +After this configuration has been changed the A1 adapter needs to be either rebuilt, or restarted if the configuration is changed inside a container, or re-read by the container if externally accessible (e.g. K8s ConfigMap). diff --git a/docs/humaninterfaces/humaninterfaces.rst b/docs/humaninterfaces/humaninterfaces.rst index 9f1ea579..be271b43 100644 --- a/docs/humaninterfaces/humaninterfaces.rst +++ b/docs/humaninterfaces/humaninterfaces.rst @@ -1,5 +1,5 @@ .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright 2021 Nordix Foundation +.. Copyright 2022 Nordix Foundation Human Interfaces @@ -8,4 +8,4 @@ Human Interfaces The NON-RT RIC Control Panel in O-RAN-SC can be used to interact with the Policy Management Service. See `NON-RT RIC Control Panel repo <https://gerrit.o-ran-sc.org/r/admin/repos/portal/nonrtric-controlpanel>`_ from the `O-RAN-SC NONRTRIC Project <https://wiki.o-ran-sc.org/display/RICNR>`_. -Any "Rest Client" application may be used (Postman, ...) to interact with the Policy Management Service application via the :ref:`pms_api` +Any "REST Client" application may be used (Postman, ...) to interact with the Policy Management Service application via the :ref:`pms_api` diff --git a/docs/index.rst b/docs/index.rst index 613ff566..c5be7965 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2020 Nordix Foundation. +.. Copyright 2022 Nordix Foundation. .. _master_index: ccsdk/oran diff --git a/docs/media/ONAP-A1ControllerArchitecture.png b/docs/media/ONAP-A1ControllerArchitecture.png Binary files differindex ded44fbc..2d521ef2 100644 --- a/docs/media/ONAP-A1ControllerArchitecture.png +++ b/docs/media/ONAP-A1ControllerArchitecture.png diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst index 1ef7dd0c..28f00835 100644 --- a/docs/offeredapis/offeredapis.rst +++ b/docs/offeredapis/offeredapis.rst @@ -1,7 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2020 Nordix Foundation +.. Copyright 2022 Nordix Foundation .. _offered_apis: @@ -12,7 +12,7 @@ Offered APIs Introduction ------------ -The north bound REST API of the A1 Policy Management Service provides convenient methods to handle policies. +The north-bound REST API of the A1 Policy Management Service provides convenient methods to handle A1 policies. Overall architecture for O-RAN A1 Policy functions diff --git a/docs/offeredapis/swagger/a1-adapter-api.yaml b/docs/offeredapis/swagger/a1-adapter-api.yaml index 1db84156..65e1ebf5 100644 --- a/docs/offeredapis/swagger/a1-adapter-api.yaml +++ b/docs/offeredapis/swagger/a1-adapter-api.yaml @@ -8,7 +8,7 @@ info: email: nonrtric@est.tech description: >- The O-RAN A1 Adapter provides an internal REST API for management of A1 - policices, useful for test and verification. <b>Note!</b> For production, + policies, useful for test and verification. <b>Note!</b> For production, the https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/offeredapis/pms-api.html should be used! diff --git a/docs/offeredapis/swagger/pms-api.json b/docs/offeredapis/swagger/pms-api.json index 2b8fb739..9fc8e7bb 100644 --- a/docs/offeredapis/swagger/pms-api.json +++ b/docs/offeredapis/swagger/pms-api.json @@ -79,7 +79,7 @@ }, "keep_alive_interval_seconds": { "format": "int64", - "description": "keep alive interval for the service. This is a heartbeat supervision of the service, which in regular intevals must invoke a 'keepalive' REST call. When a service does not invoke this call within the given time, it is considered unavailble. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means no timeout supervision.", + "description": "keep alive interval for the service. This is a heartbeat supervision of the service, which in regular intervals must invoke a 'keepalive' REST call. When a service does not invoke this call within the given time, it is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means no timeout supervision.", "type": "integer" } } @@ -144,7 +144,7 @@ "description": "Policy type", "type": "object", "properties": {"policy_schema": { - "description": "Policy type json scema. The schema is a json object following http://json-schema.org/draft-07/schema", + "description": "Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema", "type": "object" }} }, @@ -335,7 +335,7 @@ }}, "/a1-policy/v2/rics/ric": {"get": { "summary": "Returns info for one Near-RT RIC", - "description": "Either a Near-RT RIC identity or a Mananged Element identity can be specified.<br>The intention with Mananged Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).", + "description": "Either a Near-RT RIC identity or a Managed Element identity can be specified.<br>The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).", "operationId": "getRic", "responses": { "200": { @@ -559,7 +559,7 @@ }, "/a1-policy/v2/services/{service_id}/keepalive": {"put": { "summary": "Heartbeat indicates that the service is running", - "description": "A registerred service must call this in regular intervals to indicate that it is in operation. Absence of this call will lead to that the service will be deregisterred and all its policies are removed.", + "description": "A registered service must call this in regular intervals to indicate that it is in operation. Absence of this call will lead to that the service will be deregistered and all its policies are removed.", "operationId": "keepAliveService", "responses": { "200": { @@ -798,7 +798,7 @@ "content": {"application/json": {"schema": {"$ref": "#/components/schemas/service_callback_info_v2"}}}, "required": true }, - "description": "The URL to this call is registerred at Service registration.", + "description": "The URL to this call is registered at Service registration.", "operationId": "serviceCallback", "responses": {"200": { "description": "OK", @@ -867,7 +867,7 @@ "name": "Copyright (C) 2020-2022 Nordix Foundation. Licensed under the Apache License.", "url": "http://www.apache.org/licenses/LICENSE-2.0" }, - "description": "<h2>General<\/h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policices. <br/>The main tasks of the service are:<\/p><ul><li>A1 Policy creation, modification and deletion.<\/li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs<\/li><li>Maintaining a view of supported Near-RT RIC policy types<\/li><li>Supervision of using services (R-APPs). When a service is unavailble, its policies are removed.<\/li><\/ul><h2>APIs provided by the service<\/h2><h3>A1 Policy Management<\/h3><p>This is an API for management of A1 Policies.<\/p><ul><li>A1 Policy retrieval, creation, modification and deletion.<\/li><li>Retrieval of supported A1 Policy types for a Near-RT RIC<\/li><li>Retrieval of status for existing A1 policies<\/li><\/ul><h3>Management of configuration<\/h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.<\/p><h3>Callbacks<\/h3><p>These are endpoints that are invoked by this service. The callbacks are registerred in this service at service registration.<\/p><h3>NearRT-RIC Repository<\/h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.<\/p><h3>Health Check<\/h3><p>API used for supervision of the PMS component.<\/p><h3>Service Registry and Supervision<\/h3><p>API used for registerring services that uses PMS. Each A1 policy is owned by a service. PMS can supervise each registerred service and will automatically remove policies for unavailable services.<\/p>", + "description": "<h2>General<\/h2><p>The O-RAN Non-RT RIC Policy Management Service provides a REST API for management of A1 policies. <br/>The main tasks of the service are:<\/p><ul><li>A1 Policy creation, modification and deletion.<\/li><li>Monitoring and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs<\/li><li>Maintaining a view of supported Near-RT RIC policy types<\/li><li>Supervision of using services (R-APPs). When a service is unavailable, its policies are removed.<\/li><\/ul><h2>APIs provided by the service<\/h2><h3>A1 Policy Management<\/h3><p>This is an API for management of A1 Policies.<\/p><ul><li>A1 Policy retrieval, creation, modification and deletion.<\/li><li>Retrieval of supported A1 Policy types for a Near-RT RIC<\/li><li>Retrieval of status for existing A1 policies<\/li><\/ul><h3>Management of configuration<\/h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.<\/p><h3>Callbacks<\/h3><p>These are endpoints that are invoked by this service. The callbacks are registered in this service at service registration.<\/p><h3>NearRT-RIC Repository<\/h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.<\/p><h3>Health Check<\/h3><p>API used for supervision of the PMS component.<\/p><h3>Service Registry and Supervision<\/h3><p>API used for registering services that uses PMS. Each A1 policy is owned by a service. PMS can supervise each registered service and will automatically remove policies for unavailable services.<\/p>", "title": "A1 Policy management service", "version": "1.1.0" }, diff --git a/docs/offeredapis/swagger/pms-api.yaml b/docs/offeredapis/swagger/pms-api.yaml index 958ec0d4..3fd496bd 100644 --- a/docs/offeredapis/swagger/pms-api.yaml +++ b/docs/offeredapis/swagger/pms-api.yaml @@ -2,23 +2,23 @@ openapi: 3.0.1 info: title: A1 Policy management service description: <h2>General</h2><p>The O-RAN Non-RT RIC Policy Management Service provides - a REST API for management of A1 policices. <br/>The main tasks of the service - are:</p><ul><li>A1 Policy creation, modification and deletion.</li><li>Monitoring - and maintaining consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining + a REST API for management of A1 policies. <br/>The main tasks of the service are:</p><ul><li>A1 + Policy creation, modification and deletion.</li><li>Monitoring and maintaining + consistency of the SMO view of A1 policies and the Near-RT RICs</li><li>Maintaining a view of supported Near-RT RIC policy types</li><li>Supervision of using services - (R-APPs). When a service is unavailble, its policies are removed.</li></ul><h2>APIs + (R-APPs). When a service is unavailable, its policies are removed.</li></ul><h2>APIs provided by the service</h2><h3>A1 Policy Management</h3><p>This is an API for management of A1 Policies.</p><ul><li>A1 Policy retrieval, creation, modification and deletion.</li><li>Retrieval of supported A1 Policy types for a Near-RT RIC</li><li>Retrieval of status for existing A1 policies</li></ul><h3>Management of configuration</h3><p>API for updating and retrieval of the component configuration. Note that there other ways to maintain the configuration.</p><h3>Callbacks</h3><p>These are endpoints - that are invoked by this service. The callbacks are registerred in this service + that are invoked by this service. The callbacks are registered in this service at service registration.</p><h3>NearRT-RIC Repository</h3><p>This is an API that provides support for looking up a NearRT-RIC. Each A1 policy is targeted for one Near-RT RIC.</p><h3>Health Check</h3><p>API used for supervision of the PMS component.</p><h3>Service - Registry and Supervision</h3><p>API used for registerring services that uses PMS. - Each A1 policy is owned by a service. PMS can supervise each registerred service + Registry and Supervision</h3><p>API used for registering services that uses PMS. + Each A1 policy is owned by a service. PMS can supervise each registered service and will automatically remove policies for unavailable services.</p> license: name: Copyright (C) 2020-2022 Nordix Foundation. Licensed under the Apache License. @@ -152,8 +152,8 @@ paths: tags: - NearRT-RIC Repository summary: Returns info for one Near-RT RIC - description: Either a Near-RT RIC identity or a Mananged Element identity can - be specified.<br>The intention with Mananged Element identity is the ID used + description: Either a Near-RT RIC identity or a Managed Element identity can + be specified.<br>The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU). operationId: getRic parameters: @@ -434,9 +434,9 @@ paths: tags: - Service Registry and Supervision summary: Heartbeat indicates that the service is running - description: A registerred service must call this in regular intervals to indicate + description: A registered service must call this in regular intervals to indicate that it is in operation. Absence of this call will lead to that the service - will be deregisterred and all its policies are removed. + will be deregistered and all its policies are removed. operationId: keepAliveService parameters: - name: service_id @@ -742,7 +742,7 @@ paths: tags: - Callbacks summary: Callback for Near-RT RIC status - description: The URL to this call is registerred at Service registration. + description: The URL to this call is registered at Service registration. operationId: serviceCallback requestBody: content: @@ -897,9 +897,9 @@ components: keep_alive_interval_seconds: type: integer description: keep alive interval for the service. This is a heartbeat supervision - of the service, which in regular intevals must invoke a 'keepalive' REST + of the service, which in regular intervals must invoke a 'keepalive' REST call. When a service does not invoke this call within the given time, - it is considered unavailble. An unavailable service will be automatically + it is considered unavailable. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means no timeout supervision. format: int64 @@ -955,7 +955,7 @@ components: properties: policy_schema: type: object - description: Policy type json scema. The schema is a json object following + description: Policy type json schema. The schema is a json object following http://json-schema.org/draft-07/schema description: Policy type policytype_id_list_v2: diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst index 5a3eec01..5450e15f 100644 --- a/docs/releasenotes/release-notes.rst +++ b/docs/releasenotes/release-notes.rst @@ -1,7 +1,7 @@ .. 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. +.. Copyright (C) 2022 Nordix Foundation. .. _release_notes: ============= @@ -37,6 +37,24 @@ Version history Policy Management Service | 2021-02-23 | 1.1.1 | Dan Timoney | M3 version, | | | | | Honolulu Release | +------------+----------+-------------+-------------------+ +| 2021-03-25 | 1.1.2 | Dan Timoney | RC0 version, | +| | | | Honolulu Release | ++------------+----------+-------------+-------------------+ +| 2021-04-05 | 1.1.3 | Dan Timoney | RC1 version, | +| | | | Honolulu Release | ++------------+----------+-------------+-------------------+ +| 2021-04-19 | 1.1.4 | Dan Timoney | RC2 version, | +| | | | Honolulu Release | ++------------+----------+-------------+-------------------+ +| 2021-05-10 | 1.1.5 | Dan Timoney | Final version, | +| | | | Honolulu Release | ++------------+----------+-------------+-------------------+ +| 2021-09-02 | 1.2.0 | Dan Timoney | M3 version, | +| | | | Istanbul Release | ++------------+----------+-------------+-------------------+ +| 2021-09-16 | 1.2.1 | Dan Timoney | M4 version, | +| | | | Istanbul Release | ++------------+----------+-------------+-------------------+ | 2021-08-31 | 1.2.0 | Dan Timoney | RC1 version, | | | | | Istanbul Release | +------------+----------+-------------+-------------------+ @@ -66,6 +84,21 @@ Version history A1 Adapter | 2021-02-23 | 1.1.1 | Dan Timoney | M3 version, | | | | | Honolulu Release | +------------+----------+-------------+-------------------+ +| 2021-03-25 | 1.1.2 | Dan Timoney | RC0 version, | +| | | | Honolulu Release | ++------------+----------+-------------+-------------------+ +| 2021-04-05 | 1.1.3 | Dan Timoney | RC1 version, | +| | | | Honolulu Release | ++------------+----------+-------------+-------------------+ +| 2021-04-19 | 1.1.4 | Dan Timoney | RC2 version, | +| | | | Honolulu Release | ++------------+----------+-------------+-------------------+ +| 2021-05-10 | 1.1.5 | Dan Timoney | Final version, | +| | | | Honolulu Release | ++------------+----------+-------------+-------------------+ +| 2021-09-02 | 1.2.0 | Dan Timoney | M3 version, | +| | | | Istanbul Release | ++------------+----------+-------------+-------------------+ | 2021-08-31 | 1.2.0 | Dan Timoney | RC1 version, | | | | | Istanbul Release | +------------+----------+-------------+-------------------+ @@ -171,22 +204,117 @@ Honolulu, M3 | | | +-----------------------------+-----------------------------------------------------+ -Istanbul, RC1 +Honolulu, RC0 +------------- ++-----------------------------+-----------------------------------------------------+ +| **Project** | CCSDK ORAN | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Repo/commit-ID** | ccsdk-oran/e9e8fda7dc7facf288d1652152ceb358977c1006 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release designation** | Honolulu | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release date** | 2021-03-25 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Purpose of the delivery** | Improvements in ORAN, RC0 version | +| | | ++-----------------------------+-----------------------------------------------------+ + +Honolulu, RC1 +------------- ++-----------------------------+-----------------------------------------------------+ +| **Project** | CCSDK ORAN | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Repo/commit-ID** | ccsdk-oran/a17d643fcee3240c98bf3e101c1eac5a2b53119a | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release designation** | Honolulu | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release date** | 2021-04-05 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Purpose of the delivery** | Improvements in ORAN, RC1 version | +| | | ++-----------------------------+-----------------------------------------------------+ + +Honolulu, RC2 ------------- +-----------------------------+-----------------------------------------------------+ | **Project** | CCSDK ORAN | | | | +-----------------------------+-----------------------------------------------------+ +| **Repo/commit-ID** | ccsdk-oran/b4f33c2d6fef60df2e48d81e2f7cdbf6a66cb30d | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release designation** | Honolulu | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release date** | 2021-04-19 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Purpose of the delivery** | Improvements in ORAN, RC2 version | +| | | ++-----------------------------+-----------------------------------------------------+ + +Honolulu, Final version +----------------------- ++-----------------------------+-----------------------------------------------------+ +| **Project** | CCSDK ORAN | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Repo/commit-ID** | ccsdk-oran/9f99c19662c8190ad821144f3f4406c60d48025c | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release designation** | Honolulu | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release date** | 2021-05-10 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Purpose of the delivery** | Improvements in ORAN, Final version | +| | | ++-----------------------------+-----------------------------------------------------+ + +Istanbul, M3 +------------ ++-----------------------------+-----------------------------------------------------+ +| **Project** | CCSDK ORAN | +| | | ++-----------------------------+-----------------------------------------------------+ | **Repo/commit-ID** | ccsdk-oran/8a70f00cc986df657ddd3ab92f449f9e1690cf62 | | | | +-----------------------------+-----------------------------------------------------+ | **Release designation** | Istanbul | | | | +-----------------------------+-----------------------------------------------------+ -| **Release date** | 2021-08-31 | +| **Release date** | 2021-09-02 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Purpose of the delivery** | Improvements in ORAN, M3 version | +| | | ++-----------------------------+-----------------------------------------------------+ + +Istanbul, M4 +------------ ++-----------------------------+-----------------------------------------------------+ +| **Project** | CCSDK ORAN | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Repo/commit-ID** | ccsdk-oran/9241d1d555884ba2d28eab9ed692f50a660ba2a5 | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release designation** | Istanbul | +| | | ++-----------------------------+-----------------------------------------------------+ +| **Release date** | 2021-09-16 | | | | +-----------------------------+-----------------------------------------------------+ -| **Purpose of the delivery** | Persistent storage, RC1 version | +| **Purpose of the delivery** | Improvements in ORAN, M4 version | | | | +-----------------------------+-----------------------------------------------------+ |