References
CPS-390 - Getting issue details... STATUS
RESTful API Design Specification
Issues and Decisions
| Issue | Notes | Decision | |
|---|---|---|---|
| 1 | How will hostname and port be provided when dmiPlugin 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. "dmiPlugin" : { <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) | Instead of using ‘host-names’ and ‘ports’ parameters between java applications when in the cloud all we need is ‘service-names’ . The mapping of service-names to hosts and ports is done as part of the cloud configuration, in our case Kubernetes. And these are dynamic! The client application can then use a simple dns-lookup to connect to an instance of the service. Using service names also allows any plugin to use implement scaling as they see fit e.g. partitioning |
| 2 | Additional information in request body duplicates cmHandleId this is redundant information | Suggested to remove from request body to avoid possible error scenarios. | Only the one with the additionalInformation is needed and remove body |
| 3 | No need for Sync method, this is basic standard read operation at the root level for that cmHandle | ||
| 4 | Use include 'location' property when request yang-module sources | Suggestion: do include it in the request but allow dmiPlugin to decide to use it or now. Location (this leaf is called schema in older RFC7895) is not mandatory to support in YANG library and nodes may not include it. Another alternative presumably used also by ODL itself is the <get-schema> RPC. The key difference is that the YANG module definition is sent directly over the NETCONF channel, not requiring separate file servers and clients. So this is maybe one more reason that the ONAP DMI plugin currently doesn’t need the location attribute. | Location is not needed for any plugin and could only lead to ambiguity therefore will NOT be included in this request |
DMI URI
DMI URI format to follow below pattern Sandeep Shah
<OP>dmi/<v{vNumber}>/ch/<cmHandle>/<data|operations|dmiAction>/ds/{datastore}/[rp:]<resourcePath>?<query>
| URI | Mandatory or Optional | Description |
|---|---|---|
| <OP> | mandatory | the HTTP method |
| dmi | mandatory | the dmi root resource |
| <v{vNumber}> | mandatory | version of the dmi interface is the target resource URI is the query parameter list |
| <cmHandle> | mandatory | unique (string) identifier of a yang tree instance. |
| <data|operations|dmiAction> | mandatory | yang data, rpc operation or a (non-modeled) dmi action |
| {datastore} | mandatory | mandatory datastore |
| <resourcePath> | optional | the path expression identifying the resource that is being accessed by the operation. If this field is not present, then the target resource is the API itself. |
| <query> | optional | the set of parameters associated with the RESTCONF message; see Section 3.4 of [RFC3986]. RESTCONF parameters have the familiar form of "name=value" pairs. Most query parameters are optional to implement by the server and optional to use by the client. Each optional query parameter is identified by a URI |
Datastore
If the cmhandle metadata indicates that data is not synched in CPS then the request is forwarded to the dmiPlugin
RESTCONF/NETCONF relationship
Request Format for Data Access
{
“operation”: “<operation>”, // Valid operations are: “create”, “read”, “update” and “delete”.
// For update, replace and patch is distinguished by the HTTP method (PUT or PATCH).
“dataType”: “<mimeType>”, // Indicates format for the embedded data.
// Shall use MIME type syntax, e g “application/yang-data+json”.
// required for create and update operations. Optional filter-data for read-operations
“data”: { // Embedded data. Must be valid JSON object.
<data> // required for create and update operations. Optional filter-data for read-operations
},
“additionalProperties”: { // Additional properties for CM handle previously added by DMI plugin and stored in NCMP.
<properties>
}
}
DMI Inventory, Model & Data Sync API
This presentation illustrates the API methods #1, #3 and #4 detailed below
References
Follow principles/patterns of RESTCONF RFC-8040 https://datatracker.ietf.org/doc/html/rfc8040
Follow principles/patterns of yang-patch RFC-8072 https://datatracker.ietf.org/doc/html/rfc8040
Follow principles/patterns of RESTCONF NMDA RFC-8527 https://datatracker.ietf.org/doc/html/rfc8527