References

Requirements

Functional


Interface

Requirement

Additional Information

Signoff
1CPS-E-08eNCMP will forward 'CM Notifications Subscription' LCM Create events to the appropriate DMI Plugins responsible for the CM Handles (ids) defined in the LCM Events. 
The message sent to DMI should include the private properties for each CM-Handle

 

2CPS-E-08e

NCMP will forward 'CM Notifications Subscription' LCM Delete events to the appropriate DMI Plugins responsible for the CM Handles is defined in the LCM Events. 
The message sent to DMI should include the private properties for each CM-Handle.

A delete should only be forwarded if there is no other subscription for cmhandle datastore path.


 

3CPS-E-08eNCMP responds using Kafka message(s) with the result of the LCM operation
These messages will use agreed status fields:
  • StatusCode  (to be included in documentation)
  • StatusMessage
  • result
  • errorInfo  (NEW to be fleshed out)

Action: Define error details later
Now in separate Epic, see  CPS-1865 - Getting issue details... STATUS


4CPS-E-08eAll events should use Cloud Events formathttps://cloudevents.io/

5CPS-E-08eMessages should be processed in the order they are created (received)It will depend on DMIs responding within 30s.
Subscription-id should be used as Kafka 'key' to ensure this.

6CPS-E-08.eNCMP is to merge CM Notification Subscriptions create request and forward those to DMI plugin. (Interface to be added).
  • Prevent unnecessary subscription updates to nodes already involved in a subscription to the same path and datastore.
  • For possible combinations, see table below

7CPS-E-08.e

Last lights out: upon subscription Delete request only when there is no more subscription for a cm-handle & xpath & datastore combination a subscription-delete request will be sent to the relevant DMI(s).


8CPS-E-08.eA single client subscription request should result into a maximum of one request per DMI. Of course there can be several messages if more than 1 DMI is involved.

9CPS-E-08.eAmalgamate response should include rejected/accepted/pending DMI responses received within 30 seconds. A client shall be notified of available DMI subscription information after 30 seconds.  Subsequent DMI subscription updates shall be notified to clients as they become available.
  • Same schema for all notifications.
  • Subsequent notifications contains the state of all cmhandles involved in the subscription. 

10CPS-NCMP-I-01CM Handle deletion should NOT update subscription details. Do NOT delete dmi-subscription entry until owning subscription is deleted, see issue #4 below

11CPS-E-08.eBackward compatible with 'basic' created/delete operations.. 


Error Handling 


Error Scenario

Expected behavior

Sign-off

1Non responding DMIs (configurable timeout)An error message listing the 'pending' CM Handle IDs. statusMessage/statusCode to be agreed. 
2Non Existing or non-valid CM Handle IdsAn error message listing the 'rejected' CM Handle IDs.
3DMI Plugin without CM Event subscription supportAn error message listing the 'rejected' CM Handle IDs 
4Late Response (after timeout defined in #1) from DMIA list of outcomes (complete status on how many cmhandles are pending/rejected/accepted) from client subscription is returned in response. 

statusMessage/statusCode to be agreed. 

 

5Create for existing subscription idThe whole subscription will be rejected. statusMessage/statusCode to be agreed. 

 

6Delete for non-existing subscription idThe whole delete subscription will be rejected. statusMessage/statusCode to be agreed. 

 

7Error upon error

An error scenario on a second subscription for the same cm-handle/xpath as a previous subscription which did not complete successfully (yet)

to be discussed, see Error Upon Error Combinations


Characteristics


Parameter

Expectation

Notes

Sign-off

1Frequency of LCM Subscription EventsNo high volume of such events is expected
For testing purpose 1 LCM event per minute would suffice.

kieran mccarthy confirmed

 

2Number of SubscriptionsMax: 200

kieran mccarthy confirmed

3CM Handles per Subscription

Avg: 200

Max: 500 (document only)

kieran mccarthy to confirm
Note: consider limit and future 'simple' ALL (wildcard) option when above that limit

4Xpaths per Cm HandleAvg: 10

kieran mccarthy 

5Status update processing time(Order of 30) seconds (NCMP side)

kieran mccarthy 

Out-of-scope

  1. Subscription Update scenarios for an ongoing subscription.
  2. CM Notification Forwarding Check: When forwarding CM Notification NCMP will not check the content to see if the is a valid active subscription. It is assumed that the DMI Plugin as acted on the 'delete subscription' request (that request is NCMPs responsibility). And of course there wil be timing issues it also possible a CM Notification was send just after the subscription-delete was send (from client) but before the whole change had acted upon that. 
  3. Retry: NCMP will only report when actions are pending or rejected. NCMP will not implement a retry mechanism
  4. Wildcards: Wildcards or similar functionality where one string represent 0 or more xpaths is not covered as part of this requirement but it should be kept in mind as a future possibility
  5. Dynamic Topic: Topic for CM Data Notifications back to client will be hardcode for now. 
    Study should consider compatibility with an 'ALL' cm handles options

Assumptions


Assumption

Notes

1Targets is a collection of xpathscan be implemented as a json array of strings
2for the DMI plugin cm-handle-id, datastore and xpath are the key to a unique subscriptionthe client-id and subscription name are not relevant for the DMI (should not be included in the request) as this would break the concept of merging!

Issues & Decisions


IssueNotes Decision
1Is it intended that CM Notification subscription request  cover (all) descendants of the given xpath too?!e.g.. if a child is removed and there is a subscription for the parent node, will a notification be send (grandchild, child leaf updates etc.) I hope NOT!
Consider:
  • Risk of client effectively subscribing to ALL data in a cm handle by specifying top level datanode(s)
  • Complexity (i.e. cost of) of merge operation. It might even required NCMP to check relevant dat model
  • Future use of wildcards, could be a viable alternative for including descendants


Descendent don't need to be taken into account

2Could xpath point to an element that does not exist (yet)if not how, how can I client be informed about a create event? 

xpath can point to an element that does not exist (yet)

CPS/NCMP Does not need to check Xpath

3Should NCMP support re-homing, moving of a CM Handle from one DMI to another?assume only trough delete & create 

only trough delete & create

4CM Handle Delete: Should DMI or Clients be sent a subscription update 

do NOT delete dmi-subscription entry until owning subscription is deleted
(just ignore upon future delete if cm handle is gone altogether)

Note. LCM is already broadcast (today) 


No, subscription update

  • Need to upgrade to CloudEevent format
  • Add subscription id (name+client id) to header (so client can filter)
5Validation of xpathoptions order of implement and also performance cost!
  1. none
  2. xpath-parser
  3. model check
  4. instance check

  1. None
6can DMI plugin 'reject' a subscription create (for a given cm-handle-xpath combination)As NCMP might not validate as per issue#5 the DMI=plugin or component further down might have to reject an invalid xpath...

Priyank Maheshwari 

yes currently DMI can use response to say which cm handles are not accepted i.e. rejected' (but not 'pending') 

7implementation question: should 'rejected' DMI-subscriptions be storednot needed as whole subscription should be rejected

not needed as whole subscription should be rejected

8Dimensioning of DB depends on #cm handles, #subscriptions and #xpaths per subscription, this could be too big for fast processing of updates! 

Need to agree maximum and possibly realistic average/total number of entries based on the characteristics  above
The team is blocked until this becomes clear as it will affect the way the data needs to be modelled exactly.



- kieran mccarthy- Dimensioning has been agreed.  See Characteristics

9Maximum (error) message sizetheoretically all cm handles and all xpaths combinations could be rejected or pending leading to a very large error message!

?? what was agreed ? Kolawole Adebisi-Adeolokun to update what was agree

10can each CM-Handle have different set of xpath(s) per subscriptionthe  current 'basic' solution only supports a common set of datastore/xpaths (filter)

Yes, schema modification allows this

11can the same cm handle/xpath have different subscriptions with different datastores, does that affect the cm data notifications send (which datastore applies)
  • can register on any (passthrough) datastore
    • running
    • operational

  • compulsory, validation needed
  • part of KEY (unique entry) so cmHandle+datastore+xpath is the key 


Although this wiki-page will not be updated where cmHandle+xpath is mentioned as  unique entry etc. this should now include a third field: datastore as well.

12Will migration from 'basic' be supportedPreferred to ask customers to create new subscriptions

No, basic sub. will not be delivered as a separate feature 

13list v list instances filtering

/p/c1
/p/c1[@key=23]
Are these different paths or not (from ncmp point of view)

List entries are unique.
*List instances might not always be supported, depending DMI Plugin impl.

14confirm subscription id (currently subscription name + client id)

previously was clientid and subcrioptionid and we were relying on concatenation of both to be unique

Now only the event would contain subcrioptionid 

15what subscription details should be send when there is a change (in the union)
  1. just delta
  2. just union
  3. union and delta (delta flagged) 

Just Delta

16one DMI rejects whole (see decision #6) subscription (affected cmhandles) but other DMI accepts the same subscription, is this possible how to handle

Yes, this has been analysed

17What all datastores are supported ?

ncmp-datastore:passthrough-running or ncmp-datastore:passthrough-operational ??

or both?

  - kieran mccarthy  Both will be supported

18When NCMP sends subscription request to DMI and then DMI responds back to NCMP , do we need to have a correlationId to track/map the request and response? 

Value: subscriptionID:DMIPluginName (Check if subscriptionId or DMIPlugin name doesn't contain a colon: ) - The seperator is to be chosen by the development team, will try with colon first. 

subscriptionId to be used.


19

Which status codes to be used when the DMI Plugins respond back to NCMP ? 

We already have codes defined in NCMP. Do we reuse the same status codes when DMI Plugin responds back to NCMP with the subscription status ?

Yes, reuse. 

kieran mccarthy - Reuse the same codes defined in NCMP.  

20

Impl. Proposal for Merging of Subscription


Schemas Agreed for the below events ( Source to Destination ) for the positive scenarios.

  1. DME to NCMP
  2. NCMP to DMI-Plugin
  3. DMI-Plugin to NCMP 
  4. NCMP to DME

Solution Proposal

State handling for initial (basic)subscription create/delete use cases (not using concept of 'merging')

Scenario 1
1) Create Sub from Client: CH-1, CH-2
2) All handled by DM1
3) NCMP to DMI request Create sub:  CH-1, CH-2
DMI responds within 30 seconds: Status OK

NCMP Send message to client: Statsu OK (no list with Rejected/Pending)


Scenario 2
1) Create Sub from Client: CH-1, CH-2
2) All handled by DM1
3) NCMP to DMI request Create sub:  CH-1, CH-2
DMI does NOT respond with 30 seconds

NCMP Send message to client: Pending [CH-1, CH-2]

Scenario 3
1) Create Sub from Client: CH-1, CH-2
2) All handled by DM1
3) NCMP to DMI request Create sub:  CH-1, CH-2
DMI responds within 30 seconds: Rejected [CH-2]

NCMP Send message to client: Rejected [CH-2]

Scenario 4:
4 different DMIs each handling 2 Cm Handles, create sub for all CHs 

Scenario 4-part a
DMI1 CH-1, CH-2 All accepted within 30 secs
DMI2 CH-3, CH-4 Mixed result within 30 seconds e.g. Rejected [CH-4]
DMI3 CH-5, CH-6 No result after 30 seconds
DMI4 CH-7, CH-8 No result after 30 seconds

NCMP -> Client : Rejected [CH-4], Pending [ CH-5, CH-6, CH-7, CH-8 ]

4-part b
DMI3 PLugin responds after 40 seconds; status OK
NCMP -> Client : Rejected [CH-4], Pending [ CH-7, CH-8 ]

4-part c
DMI4 PLugin responds after 50 seconds; Rejected [CH-7]
NCMP -> Client : Rejected [CH-4, CH-7]

Note. The above algorithm depends ons storing (in DB using yang modelled data) a cm-handle status for each cm-handle for each subscription!

Merge → Split

  • NCMP treats a Client Subscription as one or more (small) DMI Subscriptions, each of which wil have there own state.
    Each DMI Subscription is related to 1 or more client subscriptions.
    If there is no more related client subscription the DMI Subscription can be deleted (once accepted by DMI Plugin)!

Data Model (not a great diagram...)

 

Create Combinations

Below examples demonstrate what should happen when two separate subscriptions operations are performed:

  1. an operation on subscription 'A' for client id '10
  2. an operation on subscription 'B' for client id '52'
#Existing Subscription A-10Client Create Subscription B-52 RequestDMI Sub Create RequestData Model Before (2nd) CreateData Model After Create
1CH-1, [ /p/c1, /p/c2 ]CH-1, [ /p/c1 ]None
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
A10CH-1/p/c1[ A-10 ]


CH-1/p/c2[ A-10 ]
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
A10CH-1/p/c1[ A-10, B-52 ]
B52CH-1/p/c2[ A-10 ]
2CH-1, [ /p/c1, p/c2 ]CH-1, [ /p/c2, /p/c3 ]CH-1, [ /p/c2, /p/c3 ]
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
A10CH-1/p/c1[ A-10 ]

CH-1/p/c2[ A-10 ]
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
A10CH-1/p/c1[ A-10 ]
B52CH-1/p/c2[ A-10, B-52 ]

CH-1/p/c3[ B-52 ]
3CH-1, [ /p/c1]
CH-2, [ /p/c1]		CH-2, [ /p/c1]
CH-3, [ /p/c1]		CH-3, [ /p/c1]
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
A10CH-1/p/c1[ A-10 ]

CH-2/p/c1[ A-10 ]
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
A10CH-1/p/c1[ A-10 ]
B52CH-2/p/c1[ A-10, B-52 ]

CH-3/p/c1[ B-52 ]
4CH-1, [ /p/c1]CH-1, [ /p/c1/gc1 ]

CH-1, [ /p/c1/gc1 ]

*as per decision 1 the xpath to a parent does NOT include any children...

Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
A10CH-1/p/c1[ A-10 ]
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
A10CH-1/p/c1[ A-10 ]
B52CH-1/p/c1/gc1[ B-52 ]

Create 'Merge' Diagram

Below diagram shows and example for two subscriptions with party overlapping CM Handles and XPaths.

Subscription Merge Example

* Note 1: given the possible combinations the message to DMI needs to be able to specify different xpaths per cm-handle. So a more complex structure is needed for this even ie. an array of CM Handles objects each having their own list of (target) xpaths!
Note 2: as per decision #11'datastore' should be included in all messages as well
Note 3: the correlation-id for message to and from to DMI will be composed from the subscription-id and the dmi-name


Delete Combinations

#Existing Subscription A-10Existing Subscription  B-52Client Delete A-10 RequestDMI Sub update/delete requestData Model* Before BeforeData Model* After Delete
1CH-1, [ /p/c1, p/c2 ]CH-1, [ /p/c1 ]
CH-1, [ p/c2 ]
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
A10CH-1/p/c1[ A-10, B-52 ]
B52CH-1/p/c2[ A-10 ]
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
A10CH-1/p/c1[ A-10 ]

CH-1/p/c2[ A-10 ]
2CH-1, [ /p/c1]
CH-2, [ /p/c1]		CH-2, [ /p/c1]
CH-3, [ /p/c1]

CH-1, [ /p/c1]


Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
A10CH-1/p/c1[ A-10 ]
B52CH-2/p/c1[ A-10, B-52]

CH-3/p/c1[ B-52 ]
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
B52CH-2/p/c1[ B-52 ]

CH-3/p/c1[ B-52 ]
3CH-1, [ /p/c1]

CH-1, [ /p/c1]
CH-2, [ /p/c1]
None
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
A10CH-1/p/c1[ A-10 ]
B52CH-1/p/c2[ A-10, B-52 ]
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
B52CH-2/p/c1[ B-52 ]

* Note:  as per decision #11'datastore' should be included in the 'DMI susbcription' data model too now. 

Error-Upon-Error Combinations 

( To be captured as part of  CPS-1865 - Getting issue details... STATUS )


Previous InteractionCurrent InteractionExpectationNotesSign-Off
1any operation on non-existing cm-handleoperation for same non-existing cm-handlelisted in 'rejected' immediatelybehavior as normal

 

2create operation rejected by DMIcreate for same cm-handle/xpath Submit create request again. 

 

3create pendingcreate for same cm-handle/xpathSet it to pending without submitting a new request. When we get response for previous interaction it is applied for the current interaction as well. 

 

4create pendingdelete for same cm-handle/xpathSet an error 'Conflict/Busy'up to client to retry the operation. 

 

5delete pendingdelete for same cm-handle/xpathSet it to pending without submitting a new request. When we get response for previous interaction it is applied for the current interaction as well. 

 

6delete pendingcreate for same cm-handle/xpathSet an error 'Conflict/Busy'up to client to retry the operation. 

 

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)

Performance considerations

Below options (partly) explored dring CPS teem meeting

  • 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.... 

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.

Operation Specific Impl. Proposals

Create and Merge

Delete

  • No labels