Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


Previous InteractionCurrent InteractionExpectationNotes
1any operation on rejected for non-existing cm-handleoperation for same non-existing cm-handlelisted in 'rejected' immediatelybehavior as normal
2create operation rejected by DMIcreate for same cm-handle/xpathtry again ?!
3create pendingcreate for same cm-handle/xpathTBD send again or just remain pending?!
4create pendingdelete for same cm-handle/xpath

5delete pendingdelete for same cm-handle/xpath

6delete pendingcreate for same cm-handle/xpath7

Client-Schema Update

Based on Issue#10 , the incoming schema from DME to NCMP :should

  • A single subscription contains multiple predicates
  • Predicates should be an array of Predicates ( currently a single instance )
    • Each predicate contains an array of targets ( cmhandles) - as is.
    • Each predicate contains a single datastore (mandatory) 
    • datastore-xpath-filter should become an array of xpath-filters (instead of pipe separated single string)

...

  • DMI record could reach in millions of instances
  • In memory solution (ie hazelcast) can handle 10s - 100s of Megabytes (add some sample calc)
    • still need persistence if we don't have enough instances
  • use many small messages reduce need for amalgamation
  • amalgamated string-based solution.... 

Storage

...

Solutions

Proposed Data Storage

Use a combination of

  1. Database (yang modelled) for permanent subscription details, subscribers, predicates
  2. In-Memory (hazelcast) for transient subscription details:  state (acceptep, rejected, pending)

Example Flow 1: First Subscription

  • We have the below configuration managed by CPS-NCMP

    #cmhandledmi-plugin
    1ch-1dmi-1
    2ch-2dmi-1
    3ch-3dmi-2
    4ch-4dmi-2
    5ch-5non-responding-dmi


  1. We get a Subscription Create Request with unique subscription-id and a list of predicates(list of targets , datastore and list of filters)

    Code Block
    titleSubscription Create Message
    collapsetrue
    {
    "subscriptionId" : "A-10",
    "predicates" : [
      {
        "targets": [ch-1,ch-2],
        "datastore" : "ncmp-datastore:passthrough-operational",
        "datastore-xpath-filter" : ["p1/c1","p2/c2"]
        },
      { "targets": [ch-3],
        "datastore" : "ncmp-datastore:passthrough-operational",
        "datastore-xpath-filter" : ["p3/c3"]
        }
    ]
     
    }


  2. We persist the incoming request as is in our persistent store using a relevant subscription model ( this model also needs to be revised )
  3. We also maintain a distributed datastructure in Hazelcast to keep track of the request and response to the client.

    SubscriptionIddmi-pluginaffectedCmHandlesstatus
    A-10dmi-1["ch-1","ch-2"]PENDING
    A-10dmi-2["ch-3"]PENDING


  4. Read the requests from the distributed data structure and form the request for the DMI-Plugin and publish it to the internal kafka channel.
  5. If the DMI-Plugin responds back within the configured time , so the request will either be ACCEPTED or REJECTED.
    1. if whole subscription request is ACCEPTED , update the distributed data structure and then store the subscription to the ActiveSubscriptions in cps-cache.
    2. if whole subscription request is REJECTED , update the distributed data structure and send back the response to the client.
    3. if the DMI Plugin fails to respond then the status would remain PENDING only as there is no change.


      SubscriptionIddmi-pluginaffectedCmHandlesstatus
      A-10dmi-1["ch-1","ch-2"]ACCEPTED
      A-10dmi-2["ch-3"]REJECTED



  6. We store the "ActiveSubscriptions" using a new model which will look like below.

    SubscriptionIdcmHandlefilterdatastore
    A-10ch-1p1/c1ncmp-datastore:passthrough-operational
    A-10ch-1p2/c2ncmp-datastore:passthrough-operational
    A-10ch-2p1/c1ncmp-datastore:passthrough-operational
    A-10ch-2p2/c2ncmp-datastore:passthrough-operational



  7. Now based on whatever we have in the distributed map , we will send the response to the clients and may be clear the in-memory structure if required.

...


Example Flow 2: Second Subscription (merge)


  1. We get a new subscription create request.

    Code Block
    languagexml
    title2nd Subscription Create Message
    collapsetrue
    {
    "subscriptionId" : "B-52",
    "predicates" : [
      {
        "targets": [ch-2],
        "datastore" : "ncmp-datastore:passthrough-operational",
        "datastore-xpath-filter" : ["p2/c2" , "p3/c3"]
        }
    ]
    }


  2. We now look at the "ActiveSubscriptions"  if we already have an active subscription either for a combination of "cmhandle and xpath filter and the datastore".

    Current view of ActiveSubscriptions

    SubscriptionIdcmHandlefilterdatastore
    A-10ch-1p1/c1ncmp-datastore:passthrough-operational
    A-10ch-1p2/c2ncmp-datastore:passthrough-operational
    A-10ch-2p1/c1ncmp-datastore:passthrough-operational
    A-10ch-2p2/c2ncmp-datastore:passthrough-operational


    Check if we have ch-2 , p2/c2 and ncmp-datastore:passthrough-operational then directly add to the ActiveSubscription.Similarly check for ch-3 , p3/c3 and ncmp-datastore:passthrough-operational ( which in this case will not be directly to the active subscription)

  3. Now the state of ActiveSubscription is :

    SubscriptionIdcmHandlefilterdatastore
    A-10ch-1p1/c1ncmp-datastore:passthrough-operational
    A-10ch-1p2/c2ncmp-datastore:passthrough-operational
    A-10ch-2p1/c1ncmp-datastore:passthrough-operational
    A-10ch-2p2/c2ncmp-datastore:passthrough-operational
    B-52ch-2p2/c2ncmp-datastore:passthrough-operational


    and state of the in-memory data structure is as follows.

    SubscriptionIddmi-pluginaffectedCmHandlesstatus
    B-52dmi-1["ch-2"]PENDING



  4. Now we send the request to DMI plugin (dmi-1) with just the private properties of the ch-2 with the delta xpath.
    1. DMI Plugin could either apply the whole subscription request or reject the whole subscription. i.e respond with accepted/rejected
  5. Based on the response from DMI plugin the in-memory structure is updated and response is sent back to the clients.

    if DMI says it is accepted then : 

    SubscriptionIddmi-pluginaffectedCmHandlesstatus
    B-52dmi-1["ch-2"]ACCEPTED


    if DMI says it is rejected then : 

    SubscriptionIddmi-pluginaffectedCmHandlesstatus
    B-52dmi-1["ch-2"]REJECTED


    if we get no response within the configured time then :


    SubscriptionIddmi-pluginaffectedCmHandlesstatus
    B-52dmi-1["ch-2"]PENDING


    But we still send some response within the pre-configured time.

  6. if the above request was accepted then we should add it to the list of "ActiveSubscriptions" as well.

    SubscriptionIdcmHandlefilterdatastore
    A-10ch-1p1/c1ncmp-datastore:passthrough-operational
    A-10ch-1p2/c2ncmp-datastore:passthrough-operational
    A-10ch-2p1/c1ncmp-datastore:passthrough-operational
    A-10ch-2p2/c2ncmp-datastore:passthrough-operational
    B-52ch-2p2/c2ncmp-datastore:passthrough-operational
    B-52ch-2p3/c3ncmp-datastore:passthrough-operational


  7. If the status was accepted/rejected then after sending the response to the client we can clear the in-memory structure for subscriptionId B-52.

Kafka Topics

#Topic NameEnvironment VariableSourceDestinationNotes
1
subscription
NCMP_CM_AVC_SUBSCRIPTION
DMEDME/Client-Apps
2
ncmp-dmi-cm-avc-subscription-<dmi-name>
NCMP_FORWARD_CM_AVC_SUBSCRIPTION
NCMPDMI Plugin
3
dmi-ncmp-cm-avc-subscription
NCMP_RESPONSE_CM_AVC_SUBSCRIPTION
DMI PluginNCMP
4
subscription-response
NCMP_OUTCOME_CM_AVC_SUBSCRIPTION
NCMPDME/Client-Apps
5dmi-cm-events
DMI_CM_EVENTS_TOPIC
DMI PluginNCMPactual data notifications as per the subscriptions
6cm-events
NCMP_CM_EVENTS_TOPIC
NCMPDME/Client-AppsNCMP to forward the notifications to the client-apps.

...