diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_static/cps-r8-arch-diagram.png | bin | 62879 -> 0 bytes | |||
| -rw-r--r-- | docs/_static/cps-r9-arch-diagram.png | bin | 0 -> 61907 bytes | |||
| -rw-r--r-- | docs/_static/star.png | bin | 0 -> 486 bytes | |||
| -rw-r--r-- | docs/admin-guide.rst | 58 | ||||
| -rw-r--r-- | docs/api/yang/dmiYangResource.yang | 46 | ||||
| -rw-r--r-- | docs/architecture.rst | 30 | ||||
| -rwxr-xr-x | docs/design.rst | 24 | ||||
| -rw-r--r-- | docs/modeling.rst | 50 | ||||
| -rw-r--r-- | docs/overview.rst | 31 | ||||
| -rwxr-xr-x | docs/release-notes.rst | 89 |
10 files changed, 285 insertions, 43 deletions
diff --git a/docs/_static/cps-r8-arch-diagram.png b/docs/_static/cps-r8-arch-diagram.png Binary files differdeleted file mode 100644 index f5a90a6ea..000000000 --- a/docs/_static/cps-r8-arch-diagram.png +++ /dev/null diff --git a/docs/_static/cps-r9-arch-diagram.png b/docs/_static/cps-r9-arch-diagram.png Binary files differnew file mode 100644 index 000000000..181804139 --- /dev/null +++ b/docs/_static/cps-r9-arch-diagram.png diff --git a/docs/_static/star.png b/docs/_static/star.png Binary files differnew file mode 100644 index 000000000..570345c77 --- /dev/null +++ b/docs/_static/star.png diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst index 8e917e1f5..fab8d54a4 100644 --- a/docs/admin-guide.rst +++ b/docs/admin-guide.rst @@ -9,10 +9,64 @@ CPS Admin Guide ############### -.. warning:: draft - .. toctree:: :maxdepth: 1 Logging & Diagnostics ===================== + +General Guidelines +------------------ +CPS-Core logs are sent to `STDOUT` in order to leverage the Kubernetes logging architecture. + +These logs are available using the following command: + +.. code:: bash + + kubectl logs <cps-core-pod> + +The default configuration for CPS logs is the INFO level. + +This architecture also makes all logs ready to be sent to an Elastic-search Log-stash and Kibana (ELK) stack or similar. + +Enabling tracing for all executed sql statements is done by changing hibernate +loggers log level + +Logger configuration is provided as a chart resource : + + +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | cps-component-service-name | logback.xml location | + +================================+=================================================================================================================================+ + | cps-core | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-core/resources/config/logback.xml>`_ | + +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | cps-temporal | `logback.xml <https://github.com/onap/oom/blob/master/kubernetes/cps/components/cps-temporal/resources/config/logback.xml>`_ | + +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | ncmp-dmi-plugin | Not yet applicable to DMI Plugin | + +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +Monitoring +========== +Once CPS-Core is deployed, information related to the running instance of the application is available + +.. code:: + + http://<cps-component-service-name>:8081/manage/info/ + +Health +------ + +Cps-Core health status and state can be checked using the following endpoint. +This also includes both the liveliness state and readiness state. + +.. code:: + + http://<cps-component-service-name>:8081/manage/health/ + +Metrics +------- + +Prometheus Metrics can be checked at the following endpoint + +.. code:: + + http://<cps-component-service-name>:8081/manage/prometheus
\ No newline at end of file diff --git a/docs/api/yang/dmiYangResource.yang b/docs/api/yang/dmiYangResource.yang new file mode 100644 index 000000000..8e06a2694 --- /dev/null +++ b/docs/api/yang/dmiYangResource.yang @@ -0,0 +1,46 @@ +module dmi-registry { + + yang-version 1.1; + + namespace \"org:onap:cps:ncmp\"; + + prefix dmi-reg; + + organization \"Nordix Foundation\"; + + contact \"rahul.tyagi@est.tech\"; + + revision \"2021-05-20\" { + description + \"Initial Version\"; + } + + container dmi-registry { + + list cm-handles { + + key \"id\"; + + leaf id { + type string; + } + + leaf dmi-service-name { + type string; + } + + list additional-properties { + + key \"name\"; + + leaf name { + type string; + } + + leaf value { + type string; + } + } + } + } +}
\ No newline at end of file diff --git a/docs/architecture.rst b/docs/architecture.rst index b703cfa53..12a51e222 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -6,8 +6,6 @@ CPS Architecture ################ -.. warning:: draft - .. toctree:: :maxdepth: 1 @@ -25,12 +23,17 @@ Project page describing eventual scope and ambition is here: This page reflects the state for Istanbul-R9 release. -.. image:: _static/cps-r8-arch-diagram.png +.. image:: _static/star.png + :class: float-left + +**Note:** SDC and AAI interfaces have not yet been implemented. + +.. image:: _static/cps-r9-arch-diagram.png API definitions =============== -Configuration Persistence Service provides following interfaces. +Configuration Persistence Service provides the following interfaces. .. list-table:: :header-rows: 1 @@ -41,7 +44,7 @@ Configuration Persistence Service provides following interfaces. - Protocol * - CPS-E-01 - Administrative Data Management - - - create/delete dataspace + - - create dataspace - create/delete schema set - create/delete anchor - REST @@ -57,12 +60,25 @@ Configuration Persistence Service provides following interfaces. - REST * - CPS-E-04 - Change Notification - - *Not available in Honolulu-R8* - - *N/A* + - - Kafka is used as the event messaging system + - running instance is supplied independently from ONAP DMaaP component or any Kafka instance deployed from ONAP + - published events contain Timestamp, Dataspace, Schema set, Anchor and JSON Data Payload + - DMaaP * - CPS-E-05 - xNF Data Access - - 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 + - monitoring + - health including liveliness state and readiness state + - metrics through Prometheus + - Various The CPS Basic Concepts are described in :doc:`modeling`. diff --git a/docs/design.rst b/docs/design.rst index f9f12de43..ce419caed 100755 --- a/docs/design.rst +++ b/docs/design.rst @@ -9,8 +9,6 @@ CPS Design ########## -.. warning:: draft - .. toctree:: :maxdepth: 1 @@ -23,8 +21,8 @@ CPS supports the public APIs listed in the link below: :download:`CPS NCMP RestOpenApi Specification <api/swagger/ncmp/openapi.yaml>` -Exposed API ------------ +View Offered APIs +----------------- The standard for API definition in the RESTful API world is the OpenAPI Specification (OAS). The OAS 3, which is based on the original "Swagger Specification", is being widely used in API developments. @@ -33,7 +31,23 @@ Specification can be accessed using following URI: .. code-block:: bash - “http://<hostname>:<port>/v3/api-docs?group=cps-docket” + http://<hostname>:<port>/v3/api-docs?group=cps-docket + +Additionally, the Swagger User Interface can be found at the following URI. The component may be changed between CPS-Core +and CPS-NCMP using the drop down table in the top right: + +.. code-block:: bash + + http://<hostname>:<port>/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config#/ + +Consumed APIs +------------- + +CPS Core uses API's from the following ONAP components + +* DMI-Plugin: REST based interface which is used to provide integration + and allow the DMI registry API's have access to the corresponding NCMP API's within CPS Core. + More information on the DMI Plugins offered APIs can be found on the `DMI Plugin's Design Page <https://docs.onap.org/projects/onap-cps-ncmp-dmi-plugin/en/latest/design.html>`_. CPS Path ======== diff --git a/docs/modeling.rst b/docs/modeling.rst index 22c4b0ba3..863e93263 100644 --- a/docs/modeling.rst +++ b/docs/modeling.rst @@ -3,20 +3,24 @@ .. Copyright (C) 2021 Pantheon.tech .. _modeling: +.. toctree:: + :maxdepth: 1 + CPS Modeling ############ -.. warning:: draft +CPS-Core Modeling +================= -.. toctree:: - :maxdepth: 1 - -Basic Concepts -============== +Data Model +---------- .. image:: _static/cps-modeling-concepts.png :alt: Basic entities relationship +Basic Concepts +-------------- + Administrative entities - **Dataspace** is a primary logical separation of data. @@ -30,7 +34,7 @@ Administrative entities and uniquely identified by its name (within its own dataspace). Same YANG resources (source files) can be referenced by multiple schema sets from different dataspaces. -- **Anchor** identifies the unique data set (data record) within a dataspace +- **Anchor** identifies the unique data set (data record) within a dataspace. Anchor always references a schema set within same dataspace which describes a data model of associated data. Multiple anchors may reference same schema set. Anchor is uniquely identified by its name (within own dataspace). @@ -50,13 +54,33 @@ Data Querying -- **CPS Path** is used to query data nodes. The CPS Path is described in detail in the :doc:`cps-path` sub-page. +- **CPS Path** is used to query data nodes. The CPS Path is described in detail in :doc:`cps-path`. -CPS Path -======== +NCMP Modeling +============= -.. toctree:: - :maxdepth: 1 +Data Model +---------- + +NCMP stores DMI Plugin and CM Handle relations using a data model described as per this Yang module. + +:download:`DMI Yang Module <api/yang/dmiYangResource.yang>` + +Basic Concepts +-------------- + +- **CM-Handle** represents an instance a modeled Network Function(node) in ONAP. + + These are stored as Anchors within CPS-Core. + +- **Datastores** represent different views of the cm data. - cps-path.rst + Datastores are defined for NCMP to access the CPS running or operational datastores. Currently supported datastores are: + +--------------------------------+-------------------------------------+-------------------------+ + | Datastore | Configurations | Data access type | + +================================+=====================================+=========================+ + | Passthrough-operational | config-true, config-false | read-only | + +--------------------------------+-------------------------------------+-------------------------+ + | Passthrough-running | config-true | read-write | + +--------------------------------+-------------------------------------+-------------------------+
\ No newline at end of file diff --git a/docs/overview.rst b/docs/overview.rst index b1f4755b6..1333e66fc 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -6,8 +6,6 @@ CPS Overview ============ -.. warning:: draft - The Configuration Persistence Service (CPS) is a platform component that is designed to serve as a data repository for runtime data that needs persistence. @@ -29,6 +27,35 @@ Types of data that is stored: information, meaning it is information that doesn't belong in A&AI. In principle, some parameters might be both configuration and operational parameters depending on how they are used. +CPS Components +-------------- + +CPS-Core +######## +This is the component of CPS which encompasses the generic storage of Yang module data. + +**NCMP** + +The Network Configuration Management Proxy (NCMP) provides access to network configuration data and is a part of CPS-Core. +NCMP accesses all network Data-Model-Inventory (DMI) information via NCMP-DMI-Plugins. The ONAP DMI Plugin described in the next section is one such plugin. + +**Note:** This documentation will often refer to "CPS-NCMP" which is the component (container image) that contains both CPS-Core and NCMP since NCMP is not a stand-alone component +even though CPS-Core could be deployed without the NCMP extension. + +ONAP 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 797a11cf5..fc672c44c 100755 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -11,8 +11,6 @@ CPS Release Notes ================= -.. warning:: draft - .. contents:: :depth: 2 .. @@ -21,6 +19,60 @@ CPS Release Notes .. * * * ISTANBUL * * * .. ======================== +Version: 2.0.1 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:2.0.1 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 2.0.1 Istanbul | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2021-14-10 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- + + - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API + - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules + - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts + - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page + +Known Limitations, Issues and Workarounds +----------------------------------------- + +*System Limitations* + +Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3. + +*Known Vulnerabilities* + + - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin + +*Workarounds* + +Add recursive method to save list node data to loop through all corresponding child nodes. + +Security Notes +-------------- + +*Fixed Security Issues* + + - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities + +*Known Security Issues* + +None + Version: 2.0.0 ============== @@ -42,7 +94,7 @@ Release Data | **Release designation** | 2.0.0 Istanbul | | | | +--------------------------------------+--------------------------------------------------------+ -| **Release date** | 2021-14-10 | +| **Release date** | 2021-14-09 | | | | +--------------------------------------+--------------------------------------------------------+ @@ -53,8 +105,6 @@ Features * Add support for retrieving and writing CM Handle data through NCMP datastores. * Automatic retrieval and caching of model information for CM Handles within NCMP. -.. _istanbul_deliverable: - Deliverables ------------ @@ -69,22 +119,32 @@ Software Deliverables Bug Fixes --------- + - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior + - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes + - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values - - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing, error details are not provided + - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE + - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container + - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error + - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root + - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues - - `CPS-504 <https://jira.onap.org/browse/CPS-504>`_ Checkstyle rules are not enforced for cps-ncmp-dmi-plugin - - `CPS-515 <https://jira.onap.org/browse/CPS-515>`_ Maven build is not failing when test containers are not able to run - - `CPS-520 <https://jira.onap.org/browse/CPS-520>`_ Fix docker profile in cps-temporal and cps-ncmp-dmi-plugin - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis - - `CPS-586 <https://jira.onap.org/browse/CPS-586>`_ App username and password environment variables are missing from temporal docker compose + - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised. + - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties + - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float + - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints + - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL + - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes + - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body This document provides the release notes for Istanbul release. @@ -118,15 +178,15 @@ Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes P Known Limitations, Issues and Workarounds ----------------------------------------- - - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node - *System Limitations* Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3. *Known Vulnerabilities* -None + - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API + - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules + - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts *Workarounds* @@ -138,10 +198,11 @@ Security Notes *Fixed Security Issues* - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed - - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities *Known Security Issues* + - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities + Test Results ------------ * `Integration tests` |
