Versions Compared

Key

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

...


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


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

...

Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-1865

...

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 Ids

Error Scenario

Expected behavior

Sign-off

1Non responding DMIs (configurable timeout)An error message listing the 'pendingrejected' 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


...

* 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

Delete Combinations

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

Delete Combinations

CH-1, [ p/c2 CH-21, [ /p/c1]

#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 ]


Expand
titleData Model...


Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
A10CH-1/p/c1[ A-10, B-52 ]
B52CH-1/p/c2[ A-10
#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 ]
]




Expand
titleData Model...


1052
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscriberssubscribers
A10CH-1/p/c1[ A-10 ]A

CH-1/p/c1c2[ A-10 , B-52 ]B



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

CH-1, [ /p/c1]



Expand
titleData Model...


[ A-10 ]
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscriberssubscribers
A10A10CH-1/p/c1CH-1/p/c2c1[ A-10 ]
2
B52
CH-1, [ /p/c1]
CH-2
, [
/p/c1
]
CH
[ A-
2, [ /p/c1
10, B-52]

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




Expand
titleData Model...


10B
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribersA
B52CH-2/p/c1[ B-52 ]

CH-13/p/c1[ AB-10 52 ]



352[ ACH-10, B-521, [ /p/c1]
CH-32, [ /p/c1][ B-52 ]

None


Expand
titleData Model...


[ -52 ]
Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
BA5210CH-21/p/c1[ BA-52 10 ]CH-3/p/c1
B
3
52
CH-1, [ /p/c1]
CH-1
, [
/p/
c1]
c2
CH
[ A-
2, [ /p/c1
10, B-52 ]
None




Expand
titleData Model...


Client  Subscription
DMI Subscription
nameclient-idcm-handlexpathsubscribers
AB1052CH-12/p/c1[ A-10 ]
B52CH-1/p/c2[ A-10, B-52 ]
Expand
titleData Model...
Client  SubscriptionDMI 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. 

...

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 
Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-1865
)


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/Retry'

 

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/Retry' - up to client to retry the create operation. 

 

...