CPS-707 Create Detailed NCMP-DMI interfaces diagram

Owned by Toine Siebelink
Last updated: Oct 05, 2021
1 min read

Interface Overview

Current Interface Description

There are 3 distinct parts to the DMI

i) Inventory: The Server side is NCMP, the client the DMI-Plugin

ii) model: The Server side is the DMI-Plugin, the client side is NCMP

iii) data: The server side is DMI-Plugin, the client side is NCMP

Interface

Responsibilities

Target Audience

Current Prefix

Examples URI's

Proposed Change

Interface

Responsibilities

Target Audience

Current Prefix

Examples URI's

Proposed Change

xNF Model Sync

CPS-NCMP-I-01

  1.  Register Plug-in CM-Handles

DMI Plugin Instance

/ncmp

/ncmp/v1/ch

Change prefix to /ncmpInventory

/ncmpInventory/v1/ch

CPS-645: Separate NCMP southbound (DMI) interface from northbound facing 'client' interfaceClosed

DMI-I-01

  1. Retrieve module-references

  2. Retrieve yang module resources

  3. Add Cm-Handle (temporary)

Internal

/dmi

dmi/v1/ch/{cmHandle}/modules/

dmi/v1/ch/{cmHandle}/moduleResources

dmi/v1/inventory/cmHandles

No Uri Changes but 'Generic Data Request Body' is not needed for these methods:

  1. "Retrieve module-references" method only requires 'cmHandleProperties' in request body (payload)

  2. "Retrieve yang module resources" method requires both  'cmHandleProperties' and 'data' payload. 'Data' will contain a well defined  json (object) of module references

CPS-706: get moduleschema/yangresouce endpoint not workingClosed

xNF Data Access

CPS-E-05

  1. Read xNF Data

  2. Create (add) xNF Data

  3. Update xNF Data

  4. Delete xNF Data

External clients, CM Data consumers

(northbound)

/ncmp

ncmp/v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-operational

ncmp/v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running

No Changes

DMI-I-01

  1. Read xNF Data

  2. Create (add) xNF Data

  3. Update xNF Data

  4. Delete xNF Data

Internal
(NCMP)

/dmi

dmi/v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-operational

dmi/v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-running

No changes required, all methods on this interface will use the 'generic data request body' for data access