Table of Contents |
---|
...
New Delhi (ND)
...
...
India Gate in New Delhi, March 20, 2016 (Credit: A. Savin, WikiCommons)
Requirements
...
ONAP Best Practices (Global Requirements) and similar
...
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
...
Table of Contents |
---|
New Delhi (N) | ||
India Gate in New Delhi, March 20, 2016 (Credit: A. Savin, WikiCommons) |
Requirements
Priority legend | |||||
Preliminary | Priority Agreed | In Progress | Paused/Blocked | Completed | De-scoped |
ONAP Best Practices (Global Requirements) and similar
ONAP Requirement | Notes | CPS- Jira(s) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| CPS-
| |||||||||||
ONAP script might help us with common quality issues and save reviewing time |
|
CPS-CORE / CPS-NCMP Requirements
Priority | Epic/Component/Owner/Team/Target | Description | Notes | Jira(s) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 |
| Data Write/Read Performance | See also CPS-Core Read & Write (large load) Test Results from Wipro/Fujitsu See Montreal Read/Write Performance for latest performance results (23/08) |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
2 |
| Support update of cached data through a message driven solution. Respond to VES Events from Devices in ONAP | Receive VES Event and transform it into a 'standard DMI→NCMP events (schema owned by NCMP) |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
3 |
| CM Handle Connectivity Freshness/Staleness | Need to model what staleness is (current CPS only has concept of model-sync state, nothing about connectivity) | Done:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
4 |
| Update YANG schema-set for CM handle using ModuleSetTag |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
5 |
| Merge CM data subscriptions in NCMP when forwarding it to DMI | Implementing Data Notifications & Subscription Notifications on a US by US basis Delivery of this epic is dependent on - |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
6 |
| Support Alternate ID (3GPP) for CM Handle ID | NCMP's CmHandle registration endpoint shall be changed to accept a new String parameter which proposed name is alternateId. | Done:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
7 |
| CPS & NCMP Feature Enhancement for M Release: Delta Feature | Moved up on Previously Priority 19 |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
8 |
| Update NCMP LCM events to include alternate id | * NCMP LCM event should send notification events with FDN identifier in the alternateid (deprecation period: correlationid=md5-hash, alternateId=FDN) | Done:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
9 |
| Audit Logging. NCMP to support audit logging |
*NEWLY ADDED → Customer installation was impacted |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
10 |
| Support for Async datajobs Not just for reading specific fdn, but rather QUERY Group of FDN , it's just a broadcast to every DMI plugin. The response should mimic sending a broadcast to 2 or more CM Handles CPS Team wil only do java interface. REST Interface is done in DCM | NEW interface aligning with 3GPP i.e FDN instead of CM-HandleIds (Read use case can re-use existing dataOperationz impl. after mapping FDNs to CMHandleIds for input and back for output!) Read, Create, Update, Delete and Action support. I.e for passthrough only * NCMP to introduce a qualifier to be used along with the DMI plugin so NCMP can break the request with multiple cmhandle into batches based on the DMI plugin and the Qualifier (where qualifier should be EMS name / id). |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
11 |
| CPS/NCMP delivery process | Moved up on Not discussed for long time but need new attention so these problems don't continue while building DCM
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
12 |
| Retrieve single module resource No Epic, Single User Story | /v1/ch/{cm-handle}/modules/definitions/{moduleName} | Done:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
13 |
| Forwarding CM Data Notifications based on Subscription |
Interdependent on -
--newly added-- |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
14 |
| Adding limit to legacy batch (bulk) interface | proposed hardcoded limit of 50 cm handles |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
15 |
| Enable Open Telemetry tracing | Configuration impacts only. Ericsson has delivered the required configuration files |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
16 |
Update existing single sync cmhandle APIs to support alternative id (containing FDNs) | 17Replace RestTemplate with WebClient | Merging
with
| NCMP to support the 3GPP ProvMnS CRUD interfaces. NCMP to Support new 3GPP sync single FDN request | Implement new NCMP CRUDAQ sync interface aligned with 3GPP API (Read and write use cases) - Wrapper on existing/legacy API | 18 | Jira Legacy | server | System Jira |
| Update remaining existing/legacy NCMP APIs to support alternateId (FDN) | Update existing/legacy NCMP APIs to support FDN / alternateId Depends on Jira Legacy | server | System Jira
Prometheus metrics http_client_requests_* metrics are not available for every endpoints in CPS NCMP Add state tags to cps.ncmp.lcm.events.publish metrics |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
17 | CPS-1704 | (which now has a lower priority)Now includes||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Jira Legacy |
Jira Legacy | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
- NMCP
- TBC
- Q3 24'
Update existing/legacy NCMP APIs to support FDN / alternateId
Depends on
Jira Legacy | ||
---|---|---|
|
|
Now includes
Jira Legacy | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
|
Agreed with stakeholders on These open issues are not a blocker, we would leave LCM event as Legacy event and proceed with
Jira Legacy | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Jira Legacy | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Jira Legacy server System Jira columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key CPS-2189 - CPS-NCMP
- TBC
- Q 24'
Jira Legacy server System Jira columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key CPS-2008 - CPS-NCMP
- TBC
- Q2 24'
Update existing single sync cmhandle APIs to support alternative id (containing FDNs)
Jira Legacy server System Jira columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key CPS-1992 - CPS-NMCP
- TBC
- TBC
- IDUN-46098
- Q2 24'
NCMP to support the 3GPP ProvMnS CRUD interfaces. NCMP to Support new 3GPP sync single FDN request
Implement new NCMP CRUDAQ sync interface aligned with 3GPP API (Read and write use cases) - Wrapper on existing/legacy API
Jira Legacy server System Jira columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key CPS-2010 - CPS-NCMP
- CPS-NMCP
- TBC
- Q4 24'
NCMP to introduce a qualifier to be used along with the DMI plugin so NCMP can break the request with multiple cmhandle into batches based on the DMI plugin and the Qualifier (where qualifier should be EMS name / id).
* NCMP shall create one or multiple EMS job ids depending on FDNs requested
* NCMP shall provide an interface to get status of an EMS job id (forward request)
* NCMP shall provide an interface to get results of an EMS job id
* NCMP shall send the results to S3
Jira Legacy server System Jira columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key CPS-1915 - CPS-NCMP
- Waqas Ikram (Unlicensed)
- Ericsson Team 2
- TBD
- TBD
TBAC - Access Control for resources to ensure that operators can restrict access control to only those users (human/machines) that are authorized to execute CRUD operations on those resources.
TBAC Study still ongoing, schedule an internal meeting to go through study doc, until sidecar is well define and implemented cps can't do nothing. Sidecar should specify the interfaces.
Jira Legacy | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Jira Legacy server System Jira columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key CPS-1781 - CPS-NCMP
- TBD
- TBD
CM data subscriptions from application to DMI [Part 2].
For all cmhandle (general)
This epic was created to take on additional scope which got added to CPS-1616.
Jira Legacy | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
AVC Subscription, advance filter. Part 2 of cmhandles
It includes creating subscription with patternmatch cmhandles.
Filter on 'Type' instead of list of CM Handle IDs → 'Type' could be defined as the yang module set containing a specific module (name and version)
- TBC
- CPS-NMCP
- TBC
- TBC
Additional field to help clients filter CM AVC Events
(S)
TBC
Currently only custom upgrade is supported. (upon request)
Requirement: It shall be possible to upgrade NCMP-CPS from release N-1 to N (without requiring manual intervention/workarounds). N is defined as any release requested by ESH
- Note. Need to agree version strategy: use current ONAP x.y.z. numbering. Ericsson to communicate when a version is to be 'delivered' and 'y' increased
Technical Debt to be addressed: Liquibase is used in CPS to manage data(upgrades) in CPS
Study: Resolve technical debt (mixed data). NCMP Data upgrade. CPS Core need to support model upgrade so that NCMP can use it,
Liquibase is used in CPS to manage data(upgrades) - Now available.
- Still need to discuss the 'backward incompatible' → What interfaces should NOT be impacted Kieran mention NBI - northbound interfaces
- Propose workshop, Spike needed from CPS
Jira Legacy | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Jira Legacy server System Jira serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key CPS-1796 - CPS-CORE & NCMP
- TBC
- TBC
Spike for documenting Kafka interfaces using AsyncAPI
- Interface Naming
- Cloud Events specifics asyncapi-cloud-events- Roll out for legacy events
- Code Generation (contract first, stubs)
Add label of techdebt Kolawole Adebisi-Adeolokun not an immediate req for
Jira Legacy server System Jira serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key CPS-1704 - CPS-NMCP
- TBC
- TBC
|
Jira Legacy server System Jira columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key CPS-1965 - CPS-NMCP
- TBC
- TBC
AVC Subscription, advance filter. Part 2 of cmhandles
It includes creating subscription with patternmatch cmhandles.
Filter on 'Type' instead of list of CM Handle IDs → 'Type' could be defined as the yang module set containing a specific module (name and version)
- TBC
- CPS-NMCP
- TBC
- TBC
Additional field to help clients filter CM AVC Events
(S)
TBC
Currently only custom upgrade is supported. (upon request)
Requirement: It shall be possible to upgrade NCMP-CPS from release N-1 to N (without requiring manual intervention/workarounds). N is defined as any release requested by ESH
- Note. Need to agree version strategy: use current ONAP x.y.z. numbering. Ericsson to communicate when a version is to be 'delivered' and 'y' increased
Technical Debt to be addressed: Liquibase is used in CPS to manage data(upgrades) in CPS
Study: Resolve technical debt (mixed data). NCMP Data upgrade. CPS Core need to support model upgrade so that NCMP can use it,
Liquibase is used in CPS to manage data(upgrades) - Now available.
- Still need to discuss the 'backward incompatible' → What interfaces should NOT be impacted Kieran mention NBI - northbound interfaces
- Propose workshop, Spike needed from CPS
(XL) - Scope needs to be defined. Risk is scope not identified, efforts might increase.
Jira Legacy | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
can datajob cover this ?, currently no support for 'actions'. Action name at the end of resourceid. split ticket into, action with and without responses.
Currently the passthrough has an 'fields' parameter to do a scoped query. Propose to support this in non-passthrough so it is promoted to a fully supported option, e.g. {ncmp-root}/ncmp/v1/ch/335ff/data/ds/ncmp-datastore:passthrough-operational?
resourceIdentifier=/&options=(fields=ericsson-enm-comtop:ManagedElement/ericsson-enm-
gnbcucp:GNBCUCPFunction/EndpointResource/LocalSctpEndpoint/attributes(sctpEndpointRef),
KMC : Do we support restconf like queries or xpath only?
(L) .*Spec out before Sept'23. No implementation.
Currently the passthrough has an 'fields' parameter to do a scoped query.
scope=ericsson-enm-comtop:ManagedElement/ericsson-enm-gnbcucp:GNBCUCPFunction/
EndpointResource/LocalSctpEndpoint/attributes(interfaceUsed==X2))
KMC : Do we support restconf like queries or xpath only?
(L)*Spec out before Sept'23. No implementation.
TBC
ncmp-datastores:running
for reading data (single CM handle, synchronous only)Read from operations.
(S) - Forward only. No validation or data enhancements (add prefixis)
ncmp-datastores:running
for writing data (single CM handle, synchronous only)(M) - Not sure. Scope not known yet.
Jira Legacy | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Support for HTTPS and authentication
- Use Service-Mesh? Both ONAP and Ericsson (applied ISTIO using Envoy Proxy side-car) are working towards this. Check with Gareth Roper
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
ncmp-datastores:running
for (single CM handle, synchronous only)Scope: Upgrade of model that is cached? Lee Anjella to confirm.
Jira Legacy server System Jira serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Spike needs to be conducted. Dependent of TBAC implementations.
Invoke YANG modelled action
Invoke YANG modelled RPC, Specification required. Rebbot/Reset type of actions on node. Include to the sync one
Always on operational datastore. Supported for nmcp:passthrough-operational and if executed against ncmp:operational then it is always forwarded to dmi plugin. Is there another story for forwarding to be included as a dependency? Always run as sync request. Is this dependent on CPS-1127 - see spin-off user stories table below this on.
KMC : Can we deprioritize - this can be run against passthrough-operational for now. Just have to agree on the API / URL for the action to progress at this stage so that the passthrough-operational form is aligned with final operational form.(S) - for passthrough.
*Spec out before Sept'23. No implementation.
key CPS-1796 - CPS-CORE & NCMP
- TBC
- TBC
Spike for documenting Kafka interfaces using AsyncAPI
- Documentation Generation
- Interface Naming
- Cloud Events specifics asyncapi-cloud-events- Roll out for legacy events
- Code Generation (contract first, stubs)
Add label of techdebt Kolawole Adebisi-Adeolokun not an immediate req for
Jira Legacy server System Jira serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key CPS-1704 - CPS-NMCP
- TBC
- TBC
Jira Legacy | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Spike needs to be conducted. Dependent of TBAC implementations.
Invoke YANG modelled action
Invoke YANG modelled RPC, Specification required. Rebbot/Reset type of actions on node. Include to the sync one
Always on operational datastore. Supported for nmcp:passthrough-operational and if executed against ncmp:operational then it is always forwarded to dmi plugin. Is there another story for forwarding to be included as a dependency? Always run as sync request. Is this dependent on CPS-1127 - see spin-off user stories table below this on.
KMC : Can we deprioritize - this can be run against passthrough-operational for now. Just have to agree on the API / URL for the action to progress at this stage so that the passthrough-operational form is aligned with final operational form.
(S) - for passthrough.
*Spec out before Sept'23. No implementation.
can datajob cover this ?, currently no support for 'actions'. Action name at the end of resourceid. split ticket into, action with and without responses.
Currently the passthrough has an 'fields' parameter to do a scoped query. Propose to support this in non-passthrough so it is promoted to a fully supported option, e.g. {ncmp-root}/ncmp/v1/ch/335ff/data/ds/ncmp-datastore:passthrough-operational?
resourceIdentifier=/&options=(fields=ericsson-enm-comtop:ManagedElement/ericsson-enm-
gnbcucp:GNBCUCPFunction/EndpointResource/LocalSctpEndpoint/attributes(sctpEndpointRef),
KMC : Do we support restconf like queries or xpath only?
(L) .
*Spec out before Sept'23. No implementation.
Currently the passthrough has an 'fields' parameter to do a scoped query.
scope=ericsson-enm-comtop:ManagedElement/ericsson-enm-gnbcucp:GNBCUCPFunction/
EndpointResource/LocalSctpEndpoint/attributes(interfaceUsed==X2))
KMC : Do we support restconf like queries or xpath only?
(L)
*Spec out before Sept'23. No implementation.
TBC
ncmp-datastores:running
for reading data (single CM handle, synchronous only)Read from operations.
(S) - Forward only. No validation or data enhancements (add prefixis)
ncmp-datastores:running
for writing data (single CM handle, synchronous only)TBC
(M) - Not sure. Scope not known yet.
Jira Legacy | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Support for HTTPS and authentication
- Use Service-Mesh? Both ONAP and Ericsson (applied ISTIO using Envoy Proxy side-car) are working towards this. Check with Gareth Roper
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
After restart, trustlevel loses all data. TrustLevel is not currently in use now, however this becomes an issues after TrustLevel restart. The states goes to 'NONE' after TrustLevel restart
TBC
Jira Legacy | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
ncmp-datastores:running
for (single CM handle, synchronous only)Scope: Upgrade of model that is cached? Lee Anjella to confirm.
Jira Legacy | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
|
After restart, trustlevel loses all data. TrustLevel is not currently in use now, however this becomes an issues after TrustLevel restart. The states goes to 'NONE' after TrustLevel restart
TBC
Jira Legacy | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Prometheus metrics http_client_requests_* metrics are not available for every endpoints in CPS NCMP
Add state tags to cps.ncmp.lcm.events.publish metrics
*NCMP to cost and reprioritise
Jira Legacy | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Jira Legacy | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
CM-handle search that returns 200k Nodes Cells
Spin-off user stories, yet to be prioritized
...
Other Information
Platform Maturity
See the centralized wiki page: London Release Platform Maturity Tony Hansen 's Best Practices Badging Status Dashboard
Vendor Neutral
If this project is coming from an existing proprietary codebase, ensure that all proprietary trademarks, logos, product names, etc. have been removed. All ONAP deliverables must comply with this rule and be agnostic of any proprietary symbols.
...