From: mpriyank Date: Thu, 7 Aug 2025 15:36:00 +0000 (+0100) Subject: RTD update for CM stack use case X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=c0db6729469abd56da63a9140875fc264c77ef68;p=cps.git RTD update for CM stack use case - added support for operational datastore in CPS - note to process the CM Data Notifications from ONAP DMI PLUGIN which is configured for data synchronization Issue-ID: CPS-2918 Change-Id: I808681a1fd14f9d69085439cad15fa315d7ceadf Signed-off-by: mpriyank --- diff --git a/docs/cm-notification-subscriptions.rst b/docs/cm-notification-subscriptions.rst index 42ade288af..9faa94b9dd 100644 --- a/docs/cm-notification-subscriptions.rst +++ b/docs/cm-notification-subscriptions.rst @@ -23,6 +23,6 @@ The CM Notification Event follows the structure outlined in the schema below: :download:`CM Data Notification Event Schema ` **Note.** NCMP uses the CM Notification Event key from the source topic to forward notifications to the client, ensuring that the order of notifications within a topic partition is maintained during forwarding. -**Note.** If the notification key from the source topic is null, NCMP cannot guarantee the order of events within a topic partition when forwarding. +**Note.** If the notification key from the source topic is null, NCMP cannot guarantee the order of events within a topic partition when forwarding. diff --git a/docs/cps-scheduled-processes.rst b/docs/cps-scheduled-processes.rst index 83cba9f8bd..3f33b9e574 100644 --- a/docs/cps-scheduled-processes.rst +++ b/docs/cps-scheduled-processes.rst @@ -18,8 +18,8 @@ Introduction The following section is a list of the current scheduled processes running within the CPS system. -Module Sync ------------ +Module Synchronization +---------------------- The module sync is a user :ref:`configurable timed process`, which is set to search for CM Handles within CPS with an *'ADVISED'* state. Once the CM Handle is processed by the module sync, the CM Handle state is then set to *'READY'*, if the process completes successfully. @@ -28,10 +28,12 @@ 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 ---------- +Data Synchronization +-------------------- The data sync is a user :ref:`configurable timed process`, 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. + +Once the data is synched then the data can be retrieved using the OPERATIONAL datastore directly from the CPS database. \ No newline at end of file diff --git a/docs/modeling.rst b/docs/modeling.rst index 62556b36f6..eed5f1dc34 100644 --- a/docs/modeling.rst +++ b/docs/modeling.rst @@ -124,10 +124,14 @@ Basic Concepts +--------------------------------+-------------------------------------+-------------------------+ | Datastore | Configurations | Data access type | +================================+=====================================+=========================+ - | Passthrough-operational | config-true, config-false | read-only | + | passthrough-operational | config-true, config-false | read-only | +--------------------------------+-------------------------------------+-------------------------+ - | Passthrough-running | config-true | read-write | + | passthrough-running | config-true | read-write | +--------------------------------+-------------------------------------+-------------------------+ + | operational | config-true, config-false | read-only | + +--------------------------------+-------------------------------------+-------------------------+ + + **Note.** The usage of Datastore depends on whether it is supported by the DMI Plugin. Additional information on CPS-NCMP interfaces ---------------------------------------------