Versions Compared

Old Version 9

changes.mady.by.user Niamh Core

Saved on

compared with

New Version 10

changes.mady.by.user Niamh Core

Saved on

Key

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

...

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

Issues and Decisions


IssueNotesDecision
1How will hostname and port be provided when DMI-Plugin register itself and its list of cmHandles with NCMP

The team thinks that the information should instead be provided in the form of a ‘host-name’ and a ‘port’  (there was some debate on service-name v. host-name but it was settled on host-name)


e.g. "dmi-plugin" : { <host-name>,  <port> }


Where the host-name is unique. (the DB might assign an internal unique ID for each entry but that is just for indexing and x-referencing in a relation DB and this ID is not to be used/ exposed externally)


DMI URI

DMI URI format to follow below pattern Sandeep Shah

...


UsecaseREST MethodURIExample
1Add a data resource for a cmHandlePOST

{dmi-root}/dmi/v1/data/ch/<cmhandle>/ds/ncmp-datastore:running/{parent-data-resource-identifier}

{

<new-yang-data-resource>

}

Content-Type: application/json

"data" payload : yang-data+json

see example 4 CPS-391Spike: Define and Agree NCMP REST Interface#RESTAPI
2Delete a data resource for a cmHandlePUT{dmi-root}/dmi/v1/data/ch/<cm-handle>/ds/ncmp-datastore:running/{resource-identifier}see example 7 CPS-391Spike: Define and Agree NCMP REST Interface#RESTAPI
3Patch a data resource for a cmHandlePATCH

{dmi-root}/dmi/v1/data/ch/<cm-handle>/ds/ncmp-datastore:running/{resource-identifier}

{
<yang-data-for-merging>
}

Content-Type: application/json

"data" payload : yang-data+json

see example 5 CPS-391Spike: Define and Agree NCMP REST Interface#RESTAPI
4Patch multiple child resources for a single cmHandlePATCH

{dmi-root}/dmi/v1/data/ch/<cm-handle>/ds/ncmp-datastore:running/{resource-identifier}


Content-Type: application/json

"data" payload : yang-patch+json

see example 6 CPS-391Spike: Define and Agree NCMP REST Interface#RESTAPI
5Execute a yang action on a cmhandle instancePOST

dmi-root}/dmi/v1/data/ch/<cm-handle>/ds/ncmp-datastore:operational/{resource-identifier}/{action}


input: {
"param1Name" :"param1Value”,
"param2Name" : "param2Value”

}


Note : If the "action" statement has no "input" section, the request message MUST NOT include a message-body

see example 10 CPS-391Spike: Define and Agree NCMP REST Interface#RESTAPI
6Execute an rpc operationPOST

{dmi-root}/dmi/v1/operations/ch/<cm-handle>/ds/ncmp-datastore:operational/ {module-name}:{action}

{
input: {
"param1Name" : "param1Value”,
"param2Name" : "param2Value”
}
}

Note: If there is no "input" section, the request MUST NOT include a message-body

see example 11 CPS-391Spike: Define and Agree NCMP REST Interface#RESTAPI
7Read a filtered set of data under a data resource for a cmHandlePUT

{dmiroot}/dmi/v1/data/ch/<cm-handle>/ds/ncmp-datastore:operational/{resource-identifier}?fields={fields-expression}

OptionDescription
fieldsRequest a subset of the target
resource contents



8Read data resources with specified fields under a given data resource for a given cmHandlePUT

{dmi-root}/dmi/v1/data/ch/<cm-handle>/ds/ncmp-datastore:operational/{resource-identifier}?fields={fields-expression}


OptionDescription
fieldsRequest a subset of the target
resource contents


see example 12 CPS-391Spike: Define and Agree NCMP REST Interface#RESTAPI
9Get data resource with 'fileds' for a cmhandle with a given scope conditionPUT{dmi-root}/dmi/v1/data/ch/{cm-handle}/ds/ncmp-datastore:operational/{resourcepath}?fields={fields}&scope={scope}see example 2 CPS-391Spike: Define and Agree NCMP REST Interface#RESTAPI
10Read descendant nodes to a given depth for a given cmHandlePUT

{dmi-root}/dmi/v1/data/ch/{cm-handle}/ds/ncmp-datastore:operational/{resource-identifier}?depth={level}


OptionDescription
depthRequest limited sub-tree depth in
the reply content
If '1' then only immediate resource
is retrieved
If '2' then resource plus next level
resources are retrieved


see example 12 CPS-391Spike: Define and Agree NCMP REST Interface#RESTAPI
11Replace data for a CMHandlePUT

{dmi-root}/dmi/v1/data/ch/<cm-handle>/ds/ncmp-datastore:running/{resource-identifier}

{

   data : {

            .... the complete tree config to be replaced

           }

}

see example 12 CPS-391Spike: Define and Agree NCMP REST Interface#RESTAPI


DMI Inventory and Sync



Use CaseRest MethodURIExample
1DMI registers a new data source with NCMP POST

{ncmp-root}/ncmp/v1/dmi-plugin/
{
    "dmi-plugin-id : { dmi-plugin-id }
     "dmi-source-id" : { unique-data-source-id }
}


dmi-plugin-id should be resolvable service name ink8s DNS

Scenario : Register/Create a new dmi-plugin data source in NCMP
Method : POST
URI : {ncmp-root}/ncmp/v1/dmi-plugin/

Header :
Content-Type: application/json

Body :
{
"dmi-plugin-id : "service:sample-service",
"dmi-source-id" : "sample"
}

Success Response :
HTTP/1.1 202 Accepted
Date: Thu, 26 Jan 2021 20:56:30 GMT
Server: example-server
{}


Error Response:
HTTP/1.1 409 Conflict
Date: Thu, 26 Jan 2021 20:56:30 GMT
Server: example-server
{
"error" : {
"error-type" : "protocol",
"error-tag" : "data exists",
"error-message" : "Datasource service:sample-service/sample already
registered/created"
}
}


An error will tell the DMI Plugin that this datasource has already been processed - no need to recover the cmhandles again.

2Delete a data source from NCMP DMI Plugin NCMPDELETE{ncmp-root}/ncmp/v1/dmi-pluigin/ { dmi-plugin-id}/dmi-source/ { unique-data-source-id }

Scenario
Remove a data source and all related NCMP handles from NCMP


Method :
DELETE
URI
{ncmp-root}/ncmp/v1/cmhandle-source/dmi-pluigin/service:sample-service/dmi-source/sample-dmi-source
Header :
Content-Type: application/json
Body :
{}


Success Response :
HTTP/1.1 202 Accepted
Date: Thu, 26 Jan 2021 20:56:30 GMT
Server: example-server
{}


Error Response:
HTTP/1.1 409 Conflict
Date: Thu, 26 Jan 2021 20:56:30 GMT
Server: example-server
{
"error" : {
"error-type" : "protocol",
"error-tag" : "data exists",
"error-message" : "Datasource service:sample-service/sample-dmi-source already
registered/created"
     }
}
An error will tell the DMI Plugin that this datasource has already been processed - no need to recover the cmhandles again.

3

NCMP requests cmhandles for a datasource (may be refresh of existing
datasource or for a newly registered datasource)


NCMP DMI plugin

GET

{dmi-root}/v1/dmi-source/{unique-data-source-id}?topic={topic-id}


Content-Type: application/json

Note - the following will refresh ALL dmi data sources managed by a dmi plugin
{dmi-root}/v1/dmi-source?topic={topic-id}

Scenario : NCMP requests sync of cmhandles for a datasource
Method : GET
URI : {dmi-root}/v1/dmi-source/dmi-source-sample?topic={topic-id}
Header :
Content-Type: application/json
Body :
{}


Event Body :
{
"dmiPluginId" : "service:sample-service", //should be resolvable sevicename in k8s DNS
"dmi-source-id" : "sample-id"
"createcmhandles" : [
    {
       "cmhandle" : "sample-cmhandle-1",
       "additionalProperties" :
    {
        "subsystemId" : "sample-subsystemId-1"
         "targetId" : "sample-targedId-1"
     }
},
    {
         "cmhandle" : "sample-cmhandle-2",
         "additionalProperties" :
     {
         "subsystemId" : "sample-subsystemId-2"
           "targetId" : "sample-targedId-2"
     }
 }
...
...
],

4Notify of change to CMHandle(s)
Topic : 'NCMP_INVENTORY' / sync request topic
The topic name should come from Data Catalog OR should DMI registry store the topic from the initial NCMP sync request?)

Topic : NCMP_INVENTORY


Event Body :
  {
    "dmiPluginId" : "service:sample-service",
    "dmi-source-id" : "dmi-source-id-001"
      "createcmhandles" : # Newly discovered/created cmhandles
      {
        "cmhandle" : "cmhandle-001",
        "additionalProperties" :
          {
            "subsystemId" : "subsystemId-001"
              "targetId" : "targetId-001"
          }
      },
    {
      "cmhandle" : "cmhandle-002",
      "additionalProperties" :
        {
          "subsystemId" : "subsystemId-001"
            "targetId" : "targetId-002"
        }
    }
    ...
    ...
  ],
    "updatedcmhandles" : # For example the cmhandle has got rehomes to a new system.
    {
      "cmhandle" : "cmhandle-003",
      "additionalProperties" :
        {
          "subsystemId" : "subsystemId-001"
            "targetId" : "targetId-001"
        }
    },
    {
      "cmhandle" : "cmhandle-004",
      "additionalProperties" :
        {
          "subsystemId" : "subsystemId-001"
            "targetId" : "targetId-002"
        }
    }
    ...
    ...
  ],
    "removedcmhandles" : [ "cmhandle-005", .... ], # array of cmhandles that have been deleted
    from the network.
    "migratedcmhandles" : [
    {
      "cmhandle" : "cmhandle-005",
      "additionalProperties" :
        {
          "subsystemId" : "subsystemId-001"
            "targetId" : "targetId-001"
        }
    },
    {
      "cmhandle" : "cmhandle-006",
      "additionalProperties" :
        {
          "subsystemId" : "subsystemId-001"
            "targetId" : "targetId-002"
        }
    }
    ...
      ...
    ]
  }

...