aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api/swagger/ncmp/openapi-inventory.yaml8
-rw-r--r--docs/deployment.rst28
-rwxr-xr-xdocs/release-notes.rst30
3 files changed, 65 insertions, 1 deletions
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index 6203c857a..af6b004b1 100644
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -265,22 +265,26 @@ components:
key: my-property
cmHandleProperties:
key: my-property
+ moduleSetTag: my-module-set-tag
- cmHandle: my-cm-handle
publicCmHandleProperties:
key: my-property
cmHandleProperties:
key: my-property
+ moduleSetTag: my-module-set-tag
createdCmHandles:
- cmHandle: my-cm-handle
publicCmHandleProperties:
key: my-property
cmHandleProperties:
key: my-property
+ moduleSetTag: my-module-set-tag
- cmHandle: my-cm-handle
publicCmHandleProperties:
key: my-property
cmHandleProperties:
key: my-property
+ moduleSetTag: my-module-set-tag
dmiPlugin: my-dmi-plugin
dmiModelPlugin: my-dmi-model-plugin
dmiDataPlugin: my-dmi-data-plugin
@@ -325,6 +329,7 @@ components:
key: my-property
cmHandleProperties:
key: my-property
+ moduleSetTag: my-module-set-tag
properties:
cmHandle:
example: my-cm-handle
@@ -339,6 +344,9 @@ components:
example: my-property
type: string
type: object
+ moduleSetTag:
+ example: my-module-set-tag
+ type: string
required:
- cmHandle
type: object
diff --git a/docs/deployment.rst b/docs/deployment.rst
index 3807d71d6..acc32e364 100644
--- a/docs/deployment.rst
+++ b/docs/deployment.rst
@@ -310,3 +310,31 @@ CPS-Core Docker Installation
CPS-Core can also be installed in a docker environment. Latest `docker-compose <https://github.com/onap/cps/blob/master/docker-compose/docker-compose.yml>`_ is included in the repo to start all the relevant services.
The latest instructions are covered in the `README <https://github.com/onap/cps/blob/master/docker-compose/README.md>`_.
+
+CPS-Core and NCMP Distributed Datastructures
+============================================
+
+CPS-Core and NCMP both internally uses embedded distributed datastructure to replicate the state across various instances for low latency.
+These instances require some additional ports to be available. The default range starts from 5701 and based on the number of instances configured they are incremented sequentially.
+
+Below are the list of distributed datastructures that we have.
+
++--------------+---------------------------------+----------------------------------------------------------+
+| Component | Datastructure name | Use |
++==============+=================================+==========================================================+
+| cps-core | anchorDataCache | Used to resolve prefix for the container name. |
++--------------+---------------------------------+----------------------------------------------------------+
+| cps-ncmp | moduleSyncStartedOnCmHandles | Watchdog process to register cmHandles. |
++--------------+---------------------------------+----------------------------------------------------------+
+| cps-ncmp | dataSyncSemaphores | Watchdog process to sync data from the nodes. |
++--------------+---------------------------------+----------------------------------------------------------+
+| cps-ncmp | moduleSyncWorkQueue | Queue used internally for workers to pick the task. |
++--------------+---------------------------------+----------------------------------------------------------+
+| cps-ncmp | forwardedSubscriptionEventCache | Keeps track of the LCM Subscription Events. |
++--------------+---------------------------------+----------------------------------------------------------+
+| cps-ncmp | untrustworthyCmHandlesSet | Stores untrustworthy cmHandles whose TrustLevel is NONE. |
++--------------+---------------------------------+----------------------------------------------------------+
+| cps-ncmp | trustLevelPerDmiPlugin | Stores the TrustLevel for the dmi-plugins. |
++--------------+---------------------------------+----------------------------------------------------------+
+
+Total number of caches : 7 \ No newline at end of file
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 013617a81..ee0ea9a44 100755
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -16,6 +16,33 @@ CPS Release Notes
.. * * * MONTREAL * * *
.. ========================
+Version: 3.3.8
+==============
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------------------------+
+| **CPS Project** | |
+| | |
++--------------------------------------+--------------------------------------------------------+
+| **Docker images** | onap/cps-and-ncmp:3.3.8 |
+| | |
++--------------------------------------+--------------------------------------------------------+
+| **Release designation** | 3.3.8 Montreal |
+| | |
++--------------------------------------+--------------------------------------------------------+
+| **Release date** | Not yet released |
+| | |
++--------------------------------------+--------------------------------------------------------+
+
+Bug Fixes
+---------
+3.3.8
+
+Features
+--------
+
Version: 3.3.7
==============
@@ -32,13 +59,14 @@ Release Data
| **Release designation** | 3.3.7 Montreal |
| | |
+--------------------------------------+--------------------------------------------------------+
-| **Release date** | Not yet released |
+| **Release date** | 2023 September 20 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
3.3.7
+ - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
Features
--------