CPS-391Spike: Define and Agree NCMP REST Interface
https://lf-onap.atlassian.net/browse/CPS-391
Guiding Principles
NCMP REST Interface will follow/be inspired by RESTConf interface for easy acceptance of and transition to this interface
Will follow ONAP's RESTful API Design Specification
The interface will include the concept of data-stores inspired by Network Management Datastore Architecture (NMDA) and as used in RESTConf
The application should be able to easily switch between 'pass-through' and other datastores (also identical rest endpoint and responses)
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
Issues & Decisions
| Issues | Notes | Decisions |
|---|---|---|---|
1 | KPI for De-registration of 100 CM-handles | This was mentioned. Was this ever agreed, is this a valid use case that needs to be covered together with the Registration ? | Not priority for now, but acceptable if we match the registration req. |
2 | DMI delay | Could we get some feedback on DMI-delays for other use cases as not mentioned in FS document | Awaiting for ETH feedback May 21, 2024 AP On Kolawole Adebisi-Adeolokun and Csaba Kocsis
Jul 2, 2024 Provided |
3 | Number of instances
In some cases, ETH have used 2 instances, can we verify the number of instances for each use case. Some of the req were defined per instance and resources used : Identify which of these ? | Agreed to; CPS use 1 instance currently, but should focus on aligning performance with 2 instances for all use case | Jul 9, 2024 Kolawole Adebisi-Adeolokun Csaba Kocsis |
4 | Input Load Distribution the CM-handle search and ID search | Currently has 5 parallel request between them distributed at 2.5 each. This fractional distribution isn't feasible for parallel processing; the load should be allocated as whole numbers. Load needs to be distributed at. Would it be acceptable to adjust this distribution to either 2 or 3 parallel requests each (and vice versa ) without any negative repercussions?
Agreed to do 6 parallel request combined total and divide the load to 3 parallel request each | Jul 9, 2024 Kolawole Adebisi-Adeolokun Csaba Kocsis |
5 | Regarding CM-handle search and ID search | FS only identified Module performance, are there any testing done towards a combined search of properties and modules in a single query
Confirmed no other testing was previously done on this..... CPS have the capabilities to do mixed testing. ETH tbc on if they want to consider this ( Csaba Kocsis ) |
|
Requirements
Please note this section was added long after the implementation and focuses on characteristic and enhancements after this study only.
Characteristics
| Operation | Concurrent requests/parallel | DMI Delay | Response size | Performance Requirement | Notes | Sign-Off |
|---|---|---|---|---|---|---|---|
1 | Registration of 50,000 CM-handles | 1 (requests are sequential) | 100 ms to get module references | N/A |
|
| May 21, 2024 Csaba Kocsis Toine Siebelink |
2 | De-registration of 2,000 CM-handles | 1 (requests are sequential) | No Module delays | N/A |
| De-registration is currently not mentioned in Stone Tablet KPI or FS, however we have agreed to match the performance of registration for now as de-reg is also not a priority at this point in time
| May 21, 2024 Csaba Kocsis Toine Siebelink Kolawole Adebisi-Adeolokun |
3 | CM-handle ID search with Module filter | 5 parallel request | N/A | 50,000 CM Handles i.e. | 2 seconds/operation |
| Jul 9, 2024 Kolawole Adebisi-Adeolokun Csaba Kocsis |
4 | CM-handle search with Module filter | 5 parallel request | N/A | 50,000 CM Handles i.e. | 15 seconds/operation |
| Jul 9, 2024 Kolawole Adebisi-Adeolokun Csaba Kocsis |
5 | Synchronous single CM-handle pass-through read | 4 (Parallel operations) | 300 ms | 5 KB | 25 request/second |
|
|
6 | Synchronous single CM-handle pass-through write (CUD) | 4 (Parallel operations) | 670 ms | 5 KB | 12.5 request/second |
|
|
7 | Batch/Bulk Read | 60 read request with 200 cmHandles each at 1 req/second. |
|
| 150 cmhandles/second
|
|
|
8 | CM change Notification Event |
|
|
|
|
|
|
Notes
This is for mixed TCs
Single KPIs will be monitored in NCMP owned pipeline with our performance every day(2 hrs interval) - Performance
Test cases 3 through 7 are to run in parallel.
Synchronous single cm-handle pass-through (read) requests
Parameter | Expectation | Notes | Sign-Off |
|---|---|---|---|
Average Response Size | 5KB | Shall not exceed 5KB | Dec 6, 2023 Kolawole Adebisi-Adeolokun |
Concurrent request | 12 clients requests toward 1 NCMP simultaneously | 40ms of overhead on top of DMI latency for each requests, at most for NCMP request. This shall remain within 40ms for 12 parallel requests. Given the DMI delay below; this means up to 240 request per second | Dec 6, 2023 Kolawole Adebisi-Adeolokun |
DMI Delay | 10ms | This is not in control of CPS. Assume DMI is 1.25 seconds average DMI response time for high latency, low latency =10 ms, this should also work for DMI Plugin. I.e 40ms ontop of the DMI. 1.25seconds+40ms= 1.29seconds | Dec 6, 2023Kolawole Adebisi-Adeolokun |
Test Environment | CPS and NCMP requests:
cpu: 2000m
memory: 2Gi
limits:
memory: 3Gi
cpu: 3000m 2. Postgres requests:
cpu: 4000m
memory: 1Gi
limits:
memory: 3Gi
cpu: 6000m |
| Dec 6, 2023 Kolawole Adebisi-Adeolokun |
Security | Disable Basic Authentication in Springboot | If configurable from application yaml, then it’s acceptable. | Dec 6, 2023 Kolawole Adebisi-Adeolokun |
Open Issues & Decisions
RESTCONF/NETCONF relationship
NCMP URI
NCMP URI format to follow below pattern
<OP>/ncmp/<v{vNumber}>/ch/<cmHandle>/<data|operations|{ncmpAction}>/ds/{datastore}?[rp:]{resourcePath}&{options}
Below table shows the proposed interface, actual implementation might deviate from this but can be accessed from
URI |
| Mandatory or Optional |
|---|---|---|
<OP> | the HTTP method | Mandatory |
ncmp / | the ncmp root resource | Mandatory |
<v{vNumber}> | version of the ncmp interface <path> is the target resource URI <query> is the query parameter list | Mandatory |
ch/<cmHandle> | unique (string) identifier of a yang tree instance. | Mandatory |
<data|operations|{ncmpAction}> | request category - yang data, rpc operation or a (non-modelled) ncmp api action. this could be data, operations or ncmpAction (e.g. 'sync-data') | Mandatory |
ds/{datastore} |
| Mandatory |
<resourceIdentifier> | 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. | Optional |
<options> | Parameters with the familiar form of "name=value" pairs. 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 | Optional DMI should be able to support (/pass through) ANY parameter associated with the RESTCONF message; see Section 3.4 of [RFC3986]. |
Datastores
New datastores are defined for ncmp to access the CPS 'running' or 'operational' datastore.
Alternatively, the request can be sent directly to the 'device' itself (bypassing CPS datastores) using one of the 'passthrough-*' datastores options as below
The new ncmp datastores required for ONAP Release I include :
Datastore, Paths and Format Combinations for Read Operations
| State | Input | Behavior | Data | Notes | ||||
|---|---|---|---|---|---|---|---|---|---|
# | Data-Sync | Datastore parameter | Expected resourcePath format | Accept-Header | Fields (filter) | Data Source | Included DataNodes | ||
1 | On | Not Specified | cpsPath | application/yang-data+json | N/A | Not supported | N/A | N/A |
|
2 | On | Not Specified | cpsPath | application/json | N/A | Not supported | N/A | N/A |
|
3 | Off | Not Specified | cpsPath | application/yang-data+json | N/A | Not supported | N/A | N/A |
|
4 | Off | Not Specified | cpsPath | N/A | N/A | Not supported | N/A | N/A | there are NO DataNode objects in CPS to output as JSON) |
5 | Off | Not Specified | other then cpsPath | N/A | N/A | Not supported | N/A | N/A | Not supported Since NCMP can only convert cpsPaths |
6 | On | Off | ncmp/passthrough-operational | NCMP does not parse | NCMP does not parse | depends on DMI-Plugin | Resolve DMI plugin Forward request to plugin Output received response | DMI-Plugin | config + | The DMI plugin may error if the RP or accept header are not supported. The DMI plugin may forward the request without processing too. |
7 | On | Off | ncmp/passthrough-running | NCMP does not parse | NCMP does not parse | depends on DMI-Plugin | Resolve DMI plugin Forward request to plugin Output received response | DMI-Plugin | config-only |
|
8 | On | ncmp/operational | cpsPath | application/yang-data+json |
| Read from cache output: application/yang-data+json | CPS-Core | config + | NCMP/CPS-Core needs to remove DataNode wrapping |
9 | On | ncmp/operational | cpsPath | application/json |
| Read from cache output: application/json | CPS-Core | config + | Output will use DataNode wrapping (as is from CPS-Core) For forwarding (cached config off) dmi-reposne need to be wrapped explicitly in 'DataNode' |
10 | Off | ncmp/operational | cpsPath | application/yang-data+json | to be determined in spike, see issue #28
| Resolve DMI plugin Convert cpsPath to RESTConfPath* Forward request to plugin | Read from DMI plugin Output application/yang-data+json | DMI-Plugin | config + |
|
11 | On | Off | ncmp/running | cpsPath | application/yang-data+json | to be determined in spike, see issue #28 | Resolve DMI plugin Convert cpsPath to RESTConfPath* Forward request to plugin | Read from DMI plugin Output application/yang-data+json | DMI-Plugin | config-only |
|
*Note Convert cpsPath to RESTConfPath wil only support 'absolute' cpsPath for conversion no query-type paths
Read Example
Works Items for above.
# | Description | Component | Enables |
|---|---|---|---|
1 | Forward request from NCMP to CPS-Core | NCMP | 8,9 |
2 | Forward request from NCMP to DMI-Plugin | NCMP | 6,7 |
3 | Convert json (dataNode) to yang-data+json | CPS-Core/NCMP | 8 |
4 | Convert cpsPath to RESTConf Path | NCMP | 10,11 |
5 | Enhance &fields parameter where needed | NCMP | 10,11+fields option |
6 | NOT Supported | N/A | 1,2,3,4,5 |
Datastore, Paths and Format Combinations for Write Operations
Write operations are only supported on the ncmp-datastores:running and ncmp-datastores:passthrough-running datastores
The Data Target for all write operation is DMI-Plugin
Write operations are only supported for config=true data
Fields and similar parameters are not supported for write operations
| State | Input | Behavior | Notes | |||
|---|---|---|---|---|---|---|---|
# | Data-Sync | Operation | Datastore parameter | Expected resourcePath format | Content-Type | ||
1 | On | Off | Create | ncmp/passthrough-running | NCMP does not parse | NCMP only checks it is valid JSON, then embeds the data in a larger JSON structure (see CPS-390 page) | Resolve DMI plugin Forward request to plugin Output received response (success or failure) | The DMI plugin may error if the RP or content type are not supported. The DMI plugin may forward the request without processing too. |
2 | On | Off | Replace | ncmp/passthrough-running | NCMP does not parse | NCMP only checks it is valid JSON, then embeds the data in a larger JSON structure (see CPS-390 page) | Resolve DMI plugin Forward request to plugin Output received response (success or failure) | The DMI plugin may error if the RP or content type are not supported. The DMI plugin may forward the request without processing too. |
3 | On | Off | Delete | ncmp/passthrough-running | NCMP does not parse | NCMP doesn't expect any input data from application, will create request body to DMI plugin without embedded data. | Resolve DMI plugin Forward request to plugin Output received response (success or failure) | The DMI plugin may error if the RP or content type are not supported. The DMI plugin may forward the request without processing too. |
4 | On | Off | Patch | ncmp/passthrough-running | NCMP does not parse | NCMP only checks it is valid JSON, then embeds the data in a larger JSON structure (see CPS-390 page) | Resolve DMI plugin Forward request to plugin Output received response (success or failure) | The DMI plugin may error if the RP or content type are not supported. The DMI plugin may forward the request without processing too. |
5 | On | Off | Create | ncmp/running | cpsPath | application/yang-data+json | Resolve DMI plugin Convert cpsPath to RESTConfPath Forward request to plugin Output received response (success or failure) |
|
6 | On | Off | Update | ncmp/running | cpsPath | application/yang-data+json | Resolve DMI plugin Convert cpsPath to RESTConfPath Forward request to plugin Output received response (success or failure) |
|
7 | On | Off | Delete | ncmp/running | cpsPath | N/A | Resolve DMI plugin Convert cpsPath to RESTConfPath Forward request to plugin Output received response (success or failure) |
|
8 | On | Off | Patch | ncmp/running | cpsPath | application/yang-data+json (*plain patch) | Resolve DMI plugin Convert cpsPath to RESTConfPath Forward request to plugin Output received response (success or failure) |
|
9 | On | Off | Patch | ncmp/running | cpsPath | application/yang-patch+json | Resolve DMI plugin Convert cpsPath to RESTConfPath Forward request to plugin Output received response (success or failure) |
|
Write Example
Write Example
Sync & Model API
NCMP / DMI Overview
when field function is used to list attributes in child will the parent still be part of output? (Joe K might be able to test this