Release notes and documentation updates for 3.5.4
- Release notes update
- Update openapi info.version to 3.5.4
- Update scheduled-tasks docs to reflect changes in retry mechanism
- Update deployment docs to update configurable timer parameters
- Remove unused locked-module-sync.sleep-time-ms
Issue-ID: CPS-2457
Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech>
Change-Id: Ieb559bbfe348848c4b8669410861edfeeb6c9bf3
diff --git a/cps-application/src/main/resources/application.yml b/cps-application/src/main/resources/application.yml
index cf9c4fb..3789e92 100644
--- a/cps-application/src/main/resources/application.yml
+++ b/cps-application/src/main/resources/application.yml
@@ -228,8 +228,6 @@
timers:
advised-modules-sync:
sleep-time-ms: 5000
- locked-modules-sync:
- sleep-time-ms: 15000
cm-handle-data-sync:
sleep-time-ms: 30000
subscription-forwarding:
diff --git a/cps-ncmp-rest/docs/openapi/openapi-inventory.yml b/cps-ncmp-rest/docs/openapi/openapi-inventory.yml
index 8c0ad41..d374dcc 100755
--- a/cps-ncmp-rest/docs/openapi/openapi-inventory.yml
+++ b/cps-ncmp-rest/docs/openapi/openapi-inventory.yml
@@ -1,6 +1,6 @@
# ============LICENSE_START=======================================================
# Copyright (C) 2021 Bell Canada
-# Modifications Copyright (C) 2022-2023 Nordix Foundation
+# Modifications Copyright (C) 2022-2024 Nordix Foundation
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -21,7 +21,7 @@
info:
title: NCMP Inventory API
description: NCMP Inventory API
- version: "3.5.2"
+ version: "3.5.4"
servers:
- url: /ncmpInventory
components:
diff --git a/cps-ncmp-rest/docs/openapi/openapi.yml b/cps-ncmp-rest/docs/openapi/openapi.yml
index 78fb141..dd2706a 100755
--- a/cps-ncmp-rest/docs/openapi/openapi.yml
+++ b/cps-ncmp-rest/docs/openapi/openapi.yml
@@ -22,7 +22,7 @@
info:
title: NCMP to CPS Proxy API
description: NCMP to CPS Proxy API
- version: "3.5.2"
+ version: "3.5.4"
servers:
- url: /ncmp
components:
diff --git a/cps-rest/docs/openapi/openapi.yml b/cps-rest/docs/openapi/openapi.yml
index 70f06fb..95c3231 100644
--- a/cps-rest/docs/openapi/openapi.yml
+++ b/cps-rest/docs/openapi/openapi.yml
@@ -1,5 +1,5 @@
# ============LICENSE_START=======================================================
-# Copyright (C) 2021-2023 Nordix Foundation
+# Copyright (C) 2021-2024 Nordix Foundation
# Modifications Copyright (C) 2021 Pantheon.tech
# Modifications Copyright (C) 2021 Bell Canada.
# Modifications Copyright (C) 2022-2024 TechMahindra Ltd.
@@ -23,7 +23,7 @@
info:
title: ONAP Open API v3 Configuration Persistence Service
description: Configuration Persistence Service is a Model Driven Generic Database
- version: "3.5.2"
+ version: "3.5.4"
contact:
name: ONAP
url: "https://onap.readthedocs.io"
diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml
index 87c6378..3069b18 100644
--- a/docs/api/swagger/cps/openapi.yaml
+++ b/docs/api/swagger/cps/openapi.yaml
@@ -9,7 +9,7 @@
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0
title: ONAP Open API v3 Configuration Persistence Service
- version: 3.5.2
+ version: 3.5.4
servers:
- url: /cps/api
security:
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index d710316..a2c7af6 100644
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -2,7 +2,7 @@
info:
description: NCMP Inventory API
title: NCMP Inventory API
- version: 3.5.2
+ version: 3.5.4
servers:
- url: /ncmpInventory
security:
diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml
index 871090f..f93395a 100644
--- a/docs/api/swagger/ncmp/openapi.yaml
+++ b/docs/api/swagger/ncmp/openapi.yaml
@@ -2,7 +2,7 @@
info:
description: NCMP to CPS Proxy API
title: NCMP to CPS Proxy API
- version: 3.5.2
+ version: 3.5.4
servers:
- url: /ncmp
security:
diff --git a/docs/cps-scheduled-processes.rst b/docs/cps-scheduled-processes.rst
index 032b4b1..c204e6c 100644
--- a/docs/cps-scheduled-processes.rst
+++ b/docs/cps-scheduled-processes.rst
@@ -22,9 +22,11 @@
-----------
The module sync is a user :ref:`configurable timed process<additional-cps-ncmp-customizations>`,
which is set to search for CM-Handles within CPS with an *'ADVISED'* state.
-Once the CM-Handle(s) is processed by the module sync, the CM-Handle state is then set to *'READY'*, if the process completes successfully.
+Once the CM-Handle is processed by the module sync, the CM-Handle state is then set to *'READY'*, if the process completes successfully.
If for any reason the module sync fails, the CM-Handle state will then be set to *'LOCKED'*,
and the reason for the lock will also be stored within CPS.
+CM-Handles in the *'LOCKED'* state will be retried when the system has availability. CM-Handles in a *'LOCKED'*
+state are processed by the retry mechanism, by setting CM-Handle state back to *'ADVISED'* so the next sync cycle will process those again.
Data Sync
---------
@@ -33,13 +35,3 @@
Once the CM-Handle(s) with a sync state of *'UNSYNCHRONIZED'* is processed by the data sync,
the CM-Handle sync state is then set to *'SYNCHRONIZED'*, if the process completes successfully.
If the data sync fails, the CM-Handle sync state will remain as *'UNSYNCHRONIZED'*, and will be re-attempted.
-
-Retry Mechanism
----------------
-The retry mechanism is a user :ref:`configurable timed process<additional-cps-ncmp-customizations>`,
-which is used to search for CM-Handles which are currently in a *'LOCKED'* state.
-If the CM-Handle is ready to be retried then, the CM-Handle(s) in a *'LOCKED'* state is processed by the retry mechanism,
-the CM-Handle state is then set to *'ADVISED'*.
-Whether the CM-Handle is ready to be retried is dependent on both the number of attempts to sync the CM-Handle,
-and the last update time of the CM-Handle state.
-With each new attempt to unlock the CM-Handle, the time until the CM-Handle can next be retried is doubled.
diff --git a/docs/deployment.rst b/docs/deployment.rst
index 9d41af5..b49bc71 100644
--- a/docs/deployment.rst
+++ b/docs/deployment.rst
@@ -296,20 +296,15 @@
| | | |
| | See also :ref:`cps_common_credentials_retrieval`. | |
+-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
-| config.ncmp.timers | Specifies the delay in milliseconds in which the module sync watch dog will wake again after finishing. | ``30000`` |
+| config.ncmp.timers | Specifies the delay in milliseconds in which the module sync watch dog will wake again after finishing. | ``5000`` |
| .advised-modules-sync.sleep-time-ms | | |
| | | |
+-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
-| config.ncmp.timers | Specifies the delay in milliseconds in which the retry mechanism watch dog | |
-| .locked-modules-sync.sleep-time-ms | will wake again after finishing. | ``300000`` |
-| | | |
-| | | |
-+-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
| config.ncmp.timers | Specifies the delay in milliseconds in which the data sync watch dog will wake again after finishing. | ``30000`` |
| .cm-handle-data-sync.sleep-time-ms | | |
| | | |
+-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
-| config.additional.ncmp.dmi.httpclient | Specifies the maximum time in seconds, to wait for establishing a connection for the HTTP Client. | ``180`` |
+| config.additional.ncmp.dmi.httpclient | Specifies the maximum time in seconds, to wait for establishing a connection for the HTTP Client. | ``30`` |
| .connectionTimeoutInSeconds | | |
+-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
| config.additional.ncmp.dmi.httpclient | Specifies the maximum number of connections allowed per route in the HTTP client. | ``50`` |
@@ -354,4 +349,4 @@
| cps-ncmp | cmNotificationSubscriptionCache | Stores and tracks cm notification subscription requests. |
+--------------+------------------------------------+-----------------------------------------------------------+
-Total number of caches : 6
\ No newline at end of file
+Total number of caches : 6
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 9c08356..bc267a1 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -39,12 +39,14 @@
Bug Fixes
---------
3.5.4
+ - `CPS-2403 <https://lf-onap.atlassian.net/browse/CPS-2403>`_ Improve lock handling and queue management during CM-handle Module Sync.
Features
--------
3.5.4
- `CPS-2408 <https://lf-onap.atlassian.net/browse/CPS-2408>`_ One Hazelcast instance per JVM to manage the distributed data structures.
+
Version: 3.5.3
==============
diff --git a/integration-test/src/test/resources/application.yml b/integration-test/src/test/resources/application.yml
index f995865..853797a 100644
--- a/integration-test/src/test/resources/application.yml
+++ b/integration-test/src/test/resources/application.yml
@@ -180,8 +180,6 @@
timers:
advised-modules-sync:
sleep-time-ms: 1000
- locked-modules-sync:
- sleep-time-ms: 1000
cm-handle-data-sync:
sleep-time-ms: 30000
subscription-forwarding: