Remove old subscription documentation 90/141590/2
authoremaclee <lee.anjella.macabuhay@est.tech>
Mon, 28 Jul 2025 09:27:07 +0000 (10:27 +0100)
committeremaclee <lee.anjella.macabuhay@est.tech>
Mon, 28 Jul 2025 12:43:38 +0000 (13:43 +0100)
- removing old subscription documentation as part of new
  implementation of datajob subscriptions

Issue-ID: CPS-2910
Change-Id: I9eaca0ad685b8d8eb9c8ad0624eb248d09b55b1e
Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech>
docs/cm-notification-subscriptions.rst
docs/cps-ncmp-message-status-codes.rst
docs/deployment.rst

index 8b7f5bb..42ade28 100644 (file)
@@ -1,49 +1,17 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2024-2025 Nordix Foundation
+.. Copyright (C) 2024-2025 OpenInfra Foundation Europe. All rights reserved.
 
 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
 .. _cmNotificationSubscriptions:
 
 
-CM Data Subscriptions and Notifications
-#######################################
+CM Data Notifications
+#####################
 
 .. toctree::
    :maxdepth: 1
 
-CM Data Subscriptions
-=====================
-CM Subscriptions are created to subscribe to notifications for CM related changes that happened in the network based on predicates.
-Predicates can be used to filter on CM Handle (id), Datastore and Xpath.
-
-The CM Subscription flow is event driven and adheres to the CNCF Cloud Events Specifications.
-
-Event to create and delete a subscription.
-
-:download:`CM Subscription Event Schema <schemas/ncmp/avc/ncmp-in-event-schema-1.0.0.json>`
-
-Event to receive status of participants in a subscription.
-
-:download:`CM Subscription Response Event Schema <schemas/ncmp/avc/ncmp-out-event-schema-1.0.0.json>`
-
-CM Subscriptions Creation
--------------------------
-To create a subscription, a client sends an event to a configured topic to register its interest with NCMP allowing the client to receive notifications based on the subscription.
-
-CM Subscriptions Deletion
--------------------------
-If a client no longer wishes to receive notifications based on a registered subscription, the client can delete the subscription by providing the subscription id.
-
-CM Subscriptions Response
--------------------------
-The response for the involved subscription participants for the Create and Delete flow can be as follows based on how the DMI Plugin responds back to NCMP.
-    - **ACCEPTED:** DMI Plugin successfully applied the subscription.
-    - **REJECTED:** DMI Plugin failed to apply the subscription.
-    - **PENDING:** DMI Plugin failed to respond within a configured time.
-
-**Note.** The Cm Subscription feature relies on the DMI Plugin support for applying the subscriptions. This support is currently not implemented in the ONAP DMI Plugin.
-
 CM Data Notifications
 =====================
 CM Notifications are triggered by any change in the network, provided the client has already set up a CM Subscription to receive such notifications. Once the events are generated, they are processed by NCMP and forwarded to the client in the same format.
index 799838a..97ffe1e 100644 (file)
@@ -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) 2023-2025 Nordix Foundation
+.. Copyright (C) 2023-2025 OpenInfra Foundation Europe. All rights reserved.
 
 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
 .. _dataOperationMessageStatusCodes:
@@ -14,7 +14,7 @@ CPS-NCMP Message Status Codes
     +=================+======================================================+===================================+
     | 0               | Successfully applied changes                         | Data Operation                    |
     +-----------------+------------------------------------------------------+-----------------------------------+
-    | 1               | ACCEPTED                                             | CM Data Notification Subscription |
+    | 1               | ACCEPTED                                             | Unused                            |
     +-----------------+------------------------------------------------------+-----------------------------------+
     | 100             | CM Handle id(s) is(are) not found                    | All features                      |
     +-----------------+------------------------------------------------------+-----------------------------------+
@@ -24,7 +24,7 @@ CPS-NCMP Message Status Codes
     +-----------------+------------------------------------------------------+-----------------------------------+
     | 103             | dmi plugin service is not able to read resource data | Data Operation                    |
     +-----------------+------------------------------------------------------+-----------------------------------+
-    | 104             | REJECTED                                             | CM Data Notification Subscription |
+    | 104             | REJECTED                                             | Unused                            |
     +-----------------+------------------------------------------------------+-----------------------------------+
     | 107             | southbound system is busy                            | Data Operation                    |
     +-----------------+------------------------------------------------------+-----------------------------------+
index 31673d6..76efea3 100644 (file)
@@ -249,8 +249,6 @@ Below are the list of distributed datastructures that we have.
 +--------------+------------------------------------+-----------------------------------------------------------+
 | cps-ncmp     | trustLevelPerDmiPlugin             | Stores the trust level for the dmi-plugins.               |
 +--------------+------------------------------------+-----------------------------------------------------------+
-| cps-ncmp     | cmNotificationSubscriptionCache    | Stores and tracks cm notification subscription requests.  |
-+--------------+------------------------------------+-----------------------------------------------------------+
 | cps-ncmp     | cpsAndNcmpLock                     | Cps and NCMP distributed lock for various use cases.      |
 +--------------+------------------------------------+-----------------------------------------------------------+
 | cps-ncmp     | cmHandleIdPerAlternateId           | Stores cm handle ids per alternate ids.                   |