From: ToineSiebelink Date: Wed, 8 Nov 2023 17:29:50 +0000 (+0000) Subject: Remove CPS-Temporal from RTD X-Git-Tag: 3.4.0~2^2 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=d0e4a9c41e3beac0636df7c04b1ba9d619866afc;p=cps.git Remove CPS-Temporal from RTD - Remove CPS-Temporal references - Removed never implemented interface such as AA&I - Updated diagrams accordingly - moved all images to _static folder - restored -W flag for tox and link-check section so errors will lead to build failures! Issue-ID:CPS-1927 Signed-off-by: ToineSiebelink Change-Id: Ib291b0904472dd32b5458dec3c78391cd1c018d9 --- diff --git a/docs/_static/cps-r13-arch-diagram.png b/docs/_static/cps-r13-arch-diagram.png new file mode 100644 index 000000000..739d52ca9 Binary files /dev/null and b/docs/_static/cps-r13-arch-diagram.png differ diff --git a/docs/_static/cps-r9-arch-diagram.png b/docs/_static/cps-r9-arch-diagram.png deleted file mode 100644 index 181804139..000000000 Binary files a/docs/_static/cps-r9-arch-diagram.png and /dev/null differ diff --git a/docs/images/cps-service-console.JPG b/docs/_static/cps-service-console.JPG similarity index 100% rename from docs/images/cps-service-console.JPG rename to docs/_static/cps-service-console.JPG diff --git a/docs/_static/star.png b/docs/_static/star.png deleted file mode 100644 index 570345c77..000000000 Binary files a/docs/_static/star.png and /dev/null differ diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst index a4313c14e..b58e74033 100644 --- a/docs/admin-guide.rst +++ b/docs/admin-guide.rst @@ -97,7 +97,7 @@ Location of log files --------------------- By default, Spring Boot will only log to the console and will not write log files. -.. image:: images/cps-service-console.JPG +.. image:: _static/cps-service-console.JPG :width: 700 :alt: CPS service console @@ -159,8 +159,6 @@ Logger configuration is provided as a chart resource : +================================+===============================================================================================================================================+ | cps-core | `logback-spring.xml `__ | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | cps-temporal | `logback.xml `__ | - +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | ncmp-dmi-plugin | Not yet applicable to DMI-Plugin | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/docs/architecture.rst b/docs/architecture.rst index 8dde47a5a..d21b213bb 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -16,19 +16,14 @@ High Level Component Definition and Architectural Relationships The Configuration Persistence Service (CPS) provides storage for run-time configuration and operational parameters that need to be used by ONAP. -In this release CPS is no longer a stand alone component and is released along with Cps-Temporal and the NCMP-DMI-Plugin. +CPS is no longer a stand alone component and is released along with and the NCMP-DMI-Plugin. Project page describing eventual scope and ambition is here: `Configuration Persistence Service Project `_ This page reflects the state for the latest release. -.. image:: _static/star.png - :class: float-left - -**Note:** SDC and AAI interfaces have not yet been implemented. - -.. image:: _static/cps-r9-arch-diagram.png +.. image:: _static/cps-r13-arch-diagram.png API definitions =============== @@ -69,10 +64,6 @@ Configuration Persistence Service provides the following interfaces. - - read xNF data - query xNF data - REST - * - CPS-E-06 - - Temporal Data Access - - - data storage and access - - REST * - CPS-E-07 - Admin - - logging levels and configuration diff --git a/docs/deployment.rst b/docs/deployment.rst index 0fee55969..59e2adafe 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -20,7 +20,6 @@ This chart includes different cps components referred as fu .. container:: ulist - `cps-core `__ - - `cps-temporal `__ - `ncmp-dmi-plugin `__ Please refer to the `OOM documentation `_ on how to install and deploy ONAP. @@ -111,7 +110,6 @@ values.yaml file to be used across different components as : .. container:: ulist - `cps-core `_ - - `cps-temporal `_ - `ncmp-dmi-plugin `_ Below are the list of secrets for different cps components. @@ -123,10 +121,6 @@ Below are the list of secrets for different cps components. +--------------------------+---------------------------------+---------------------------------------------------+ | cps-core | Rest API Authentication | -cps-core-app-user-creds | +--------------------------+---------------------------------+---------------------------------------------------+ -| cps-temporal | Rest API Authentication | -cps-temporal-app-user-creds | -+--------------------------+---------------------------------+---------------------------------------------------+ -| cps-temporal | Database authentication | -cps-temporal-pg-user-creds | -+--------------------------+---------------------------------+---------------------------------------------------+ | ncmp-dmi-plugin | Rest API Authentication | -cps-dmi-plugin-user-creds | +--------------------------+---------------------------------+---------------------------------------------------+ | ncmp-dmi-plugin | SDNC authentication | -ncmp-dmi-plugin-sdnc-creds | @@ -177,8 +171,6 @@ Any spring supported property can be configured by providing in ``config.additio +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | config.appUserPassword | Password used by cps-core service to configure the authentication for REST API it exposes. | Not defined | | | | | -| | This is the password to be used by CPS Temporal REST clients to authenticate themselves. | | -| | | | | | If not defined, the password is generated when deploying the application. | | | | | | | | See also :ref:`cps_common_credentials_retrieval`. | | @@ -243,13 +235,6 @@ Any spring supported property can be configured by providing in ``config.additio | ssl.endpoint.identification.algorithm | | | | | * ``""``, empty string to disable | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.additional. | Kafka topic to publish to cps-temporal | ``cps.data-updated-events`` | -| notification.data-updated.topic | | | -+---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.additional. | Array of dataspaces to be enabled for publishing events to cps-temporal | [] | -| notification.data-updated.filters. | If left blank CPS-Temporal notification will be sent for all dataspaces | | -| enabled-dataspaces | | | -+---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | config.additional. | If asynchronous messaging, user notifications, and updated event persistence should be enabled | ``true`` | | notification.data-updated.enabled | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ @@ -339,4 +324,4 @@ Below are the list of distributed datastructures that we have. | cps-ncmp | moduleSetTagCacheMapConfig | Stores the Module Set Tags for cmHandles. | +--------------+---------------------------------+----------------------------------------------------------+ -Total number of caches : 8 \ No newline at end of file +Total number of caches : 8 diff --git a/docs/overview.rst b/docs/overview.rst index cde6f6db6..11ed519b6 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -48,14 +48,6 @@ NCMP-DMI-Plugin The Data-Model-Inventory (DMI) Plugin is a rest interface used to synchronize CM-Handles data between CPS and DMI through the DMI-Plugin. This is built previously from the CPS-NF-Proxy component. -CPS-Temporal ------------- - -This service is responsible to provide a time oriented perspective for -operational network data. It provides features to store and retrieve sequences -of configurations or states along with the associated times when they occurred -or have been observed. - CPS Project =========== diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 1b7ef14d2..ff3ebdb18 100755 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1098,7 +1098,6 @@ Following CPS components are available with default ONAP/CPS installation. * Service components - CPS-NCMP - - CPS-Temporal - DMI-Plugin * Additional resources that CPS utilizes deployed using ONAP common charts diff --git a/docs/tox.ini b/docs/tox.ini index 7020752c8..4e99dc248 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -27,7 +27,7 @@ deps = -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = - sphinx-build -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html + sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html [testenv:docs-linkcheck] basepython = python3.10 deps = @@ -35,7 +35,7 @@ deps = -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = - sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck + sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck [testenv:docs-spellcheck] basepython = python3.10 deps =