diff options
| author |   DylanB95EST <dylan.byrne@est.tech> | 2022-08-08 15:22:54 +0100 |
|---|---|---|
| committer | DylanB95EST <dylan.byrne@est.tech> | 2022-08-09 10:56:54 +0100 |
| commit | dc65647fc26fc276cafdc94c9561cafe32684842 (patch) | |
| tree | ef551ee432e2a61382afd9db6ea64af402eb7fb7 | |
| parent | 57ba6b73a739b3c6dbbe7c68c79359f443dfc33d (diff) | |
Module Sync, Data Sync, Retry Mechanism RTD
- Add Documentation for Module Sync, Data Sync,
and Retry Mechanism Proccesses for RTD
- Update CPS-Core header on the Index to just CPS
- Add Cps-NCMP Customizations for retry mechanism and
data sync
Issue-ID: CPS-1181
Change-Id: Idb76de380e49e42ca337cabcf2708b940e15f46f
Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
| -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 |
4 files changed, 60 insertions, 4 deletions
diff --git a/docs/cps-scheduled-processes.rst b/docs/cps-scheduled-processes.rst new file mode 100644 index 0000000000..01fe66aae4 --- /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 c0d8b60294..11cf77f870 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 df4ea95185..c1427ad381 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 7cc2c4ce6a..bc1019abe7 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 |