Versions Compared

Key

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

...

Requirements

Functional

#

Interface

Requirement

Additional Information

1CPS-E-08
Event from clients to create a new subscription with the dmi's responsible for managing the underlying devices.
NCMP will forward 'CM Notifications Subscription' LCM Create events to the appropriate DMI Plugins responsible for the CM Handles is defined in the LCM Events. 
2CPS-E-08
Event from clients to delete an ongoing subscription with the dmi's responsible for managing the underlying devices.
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. 
3CPS-E-08NCMP responds using Kafka message(s) with the result of the LCM operation
These messages wil use agreed status fields:
  • StatusCode  (to be included in documentation)
  • StatusMessage

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

Error Handling

#

Error Scenario

Expected behavior

1Non responding DMIs (configurable timeout)An error message listing the 'pending' CM Handle IDs 
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 (after timeout defined in #1) responding DMIsA message contain the (now) successful CM Handle IDs TBC
No need to merge late messages from different DMIs

Capabilities

#

Parameter

Expectation

Notes

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

Out-of-scope

  • Working with the wildcards.Subscription Delete ( which would be taken part of other story ) , only list of specific CM Handle IDs are supported
  • Subscription Update scenario scenarios for an ongoing subscription.

...

  • Page to keep track of the underlying use case for Subscription Create and Subscription Delete.
  • The events used will adhere to CNCF Cloud Events.
  • NCMP wil not be responsible for keeping the 'state' of any subscription and thus decide which CM Events should be forwarded

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

...