diff options
| -rwxr-xr-x | INFO.yaml | 7 | ||||
| -rw-r--r-- | csit/plans/cps/testplan.txt | 1 | ||||
| -rw-r--r-- | csit/tests/cps-data-sync/cps-data-sync.robot | 55 | ||||
| -rw-r--r-- | docker-compose/docker-compose.yml | 1 | ||||
| -rw-r--r-- | docs/cps-scheduled-processes.rst | 44 | ||||
| -rw-r--r-- | docs/deployment.rst | 13 | ||||
| -rwxr-xr-x | docs/index.rst | 4 | ||||
| -rw-r--r-- | docs/modeling.rst | 3 |
8 files changed, 118 insertions, 10 deletions
@@ -24,7 +24,7 @@ project_category: '' project_lead: &onap_releng_ptl name: 'Toine Siebelink' email: 'toine.siebelink@est.tech' - id: 'toinesiebelink' + id: 'ToineSiebelink' company: 'Ericsson Software Technology' timezone: 'Europe/Dublin' primary_contact: *onap_releng_ptl @@ -47,11 +47,6 @@ meetings: time: '08:00 America/New_York' committers: - <<: *onap_releng_ptl - - name: 'Toine Siebelink' - email: 'toine.siebelink@est.tech' - company: 'Ericsson Software Technology' - id: 'toinesiebelink' - timezone: 'Europe/Dublin' - name: 'Aditya Puthuparambil' email: 'aditya.puthuparambil@bell.ca' company: 'Bell Canada' diff --git a/csit/plans/cps/testplan.txt b/csit/plans/cps/testplan.txt index c0cf4512d..c59712358 100644 --- a/csit/plans/cps/testplan.txt +++ b/csit/plans/cps/testplan.txt @@ -20,5 +20,6 @@ actuator cps-admin cps-data cps-model-sync +cps-data-sync ncmp-passthrough cm-handle-query
\ No newline at end of file diff --git a/csit/tests/cps-data-sync/cps-data-sync.robot b/csit/tests/cps-data-sync/cps-data-sync.robot new file mode 100644 index 000000000..d37125b15 --- /dev/null +++ b/csit/tests/cps-data-sync/cps-data-sync.robot @@ -0,0 +1,55 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2022 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +*** Settings *** +Documentation NCMP + +Library Collections +Library OperatingSystem +Library RequestsLibrary +Library BuiltIn + +Suite Setup Create Session CPS_URL http://${CPS_CORE_HOST}:${CPS_CORE_PORT} + +*** Variables *** + +${auth} Basic Y3BzdXNlcjpjcHNyMGNrcyE= +${ncmpBasePath} /ncmp + +*** Test Cases *** +Operational state goes to UNSYNCHRONIZED when data sync (flag) is enabled + ${uri}= Set Variable ${ncmpBasePath}/v1/ch/PNFDemo/data-sync + ${params}= Create Dictionary dataSyncEnabled=true + ${headers}= Create Dictionary Authorization=${auth} + ${response}= PUT On Session CPS_URL ${uri} params=${params} headers=${headers} + Should Be Equal As Strings ${response.status_code} 200 + ${verifyUri}= Set Variable ${ncmpBasePath}/v1/ch/PNFDemo/state + ${verifyHeaders}= Create Dictionary Authorization=${auth} + ${verifyResponse}= GET On Session CPS_URL ${verifyUri} headers=${verifyHeaders} + ${verifyResponseJson}= Set Variable ${verifyResponse.json()['state']['dataSyncState']['operational']} + Should Be Equal As Strings ${verifyResponseJson['syncState']} UNSYNCHRONIZED + Sleep 5 + +Operational state goes to SYNCHRONIZED after sometime when data sync (flag) is enabled + ${uri}= Set Variable ${ncmpBasePath}/v1/ch/PNFDemo/state + ${headers}= Create Dictionary Authorization=${auth} + ${response}= GET On Session CPS_URL ${uri} headers=${headers} + ${responseJson}= Set Variable ${response.json()['state']['dataSyncState']['operational']} + Should Be Equal As Strings ${responseJson['syncState']} SYNCHRONIZED
\ No newline at end of file diff --git a/docker-compose/docker-compose.yml b/docker-compose/docker-compose.yml index 4c9919269..8d3a0a357 100644 --- a/docker-compose/docker-compose.yml +++ b/docker-compose/docker-compose.yml @@ -50,6 +50,7 @@ services: notification.async.executor.time-out-value-in-ms: 2000 NOTIFICATION_DATASPACE_FILTER_PATTERNS: '.*' TIMERS_ADVISED-MODULES-SYNC_SLEEP-TIME-MS: 2000 + TIMERS_CM-HANDLE-DATA-SYNC_SLEEP-TIME-MS: 2000 restart: unless-stopped depends_on: - dbpostgresql diff --git a/docs/cps-scheduled-processes.rst b/docs/cps-scheduled-processes.rst new file mode 100644 index 000000000..01fe66aae --- /dev/null +++ b/docs/cps-scheduled-processes.rst @@ -0,0 +1,44 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2022 Nordix Foundation + +.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING +.. cpsScheduledProcesses: + + +CPS Scheduled Processes +####################### + +.. toctree:: + :maxdepth: 1 + +Introduction +============ + +The following section is a list of the current scheduled processes running within the CPS system. + +Module Sync +----------- +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. +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. + +Data Sync +--------- +The data sync is a user :ref:`configurable timed process<additional-cps-ncmp-customizations>`, +which is set to search for CM-Handles with a sync state of *'UNSYNCHRONIZED'*. +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 c0d8b6029..11cf77f87 100644 --- a/docs/deployment.rst +++ b/docs/deployment.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) 2021-2022 Nordix Foundation .. Modifications Copyright (C) 2021 Bell Canada. .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING @@ -278,6 +278,8 @@ Any spring supported property can be configured by providing in ``config.additio | maximumPoolSize | including both idle and in-use connections. | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ +.. _additional-cps-ncmp-customizations: + Additional CPS-NCMP Customizations ================================== +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ @@ -293,6 +295,15 @@ Additional CPS-NCMP Customizations | .sleep-time-ms | | | | | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ +| config.timers.locked-modules-sync | Specifies the delay in milliseconds in which the retry mechanism watch dog | | +| | will wake again after finishing. | ``300000`` | +| .sleep-time-ms | | | +| | | | ++---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ +| config.timers.cm-handle-data-sync | Specifies the delay in milliseconds in which the data sync watch dog will wake again after finishing. | ``30000`` | +| .sleep-time-ms | | | +| | | | ++---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ CPS-Core Docker Installation ============================ diff --git a/docs/index.rst b/docs/index.rst index df4ea9518..c1427ad38 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,8 +11,8 @@ CPS Documentation ################# -CPS Core -======== +CPS +=== .. toctree:: :maxdepth: 1 diff --git a/docs/modeling.rst b/docs/modeling.rst index 7cc2c4ce6..bc1019abe 100644 --- a/docs/modeling.rst +++ b/docs/modeling.rst @@ -125,4 +125,5 @@ Querying CM Handles .. toctree:: :maxdepth: 1 - ncmp-cmhandle-querying.rst
\ No newline at end of file + ncmp-cmhandle-querying.rst + cps-processes.rst
\ No newline at end of file |