References
- CPS-858Getting issue details... STATUS
Open Issues & Decisions
# | Issue | Notes | Decision |
---|---|---|---|
1 | should dataspaceName be given another name? | dataspaces are private to an application (e.g. NCMP) they should not be shared kieran mccarthy what do you mean by dataspaceName? | omit for now - put in later if needed/required. |
2 | should schema urn be generalized, how might it impact publication to ORAN R1? | The schema of the payload is dictated by the source of the event kieran mccarthy what do you refer to here? Ans : the schema refers to 'org.onap'. Emailed ORAN guys to identify how to close the gap between ORAN and ONAP. | . |
3 | should "ncmp" be used rather than "cps" in the type definitions | i.e. org.onap.cps.cmhandle-lcm-event or org.onap.ncmp.cmhandle-lcm-event? NCMP owns these events, 'cps' should not appear (even if cps is emitting them) NCMP java classnames begin with org.onap.cps.ncmp – Tony does not care kieran mccarthy , where does this type come from? | schema urn should refer to ncmp - not cps. |
4 | should a bulk cmhandle event be supported? | Prefer to delay this decision, but keep it in mind so we do not need to break compatibility to support it. -- Could be tricky as with horizontal scale NCMP, multiple will be emitting simulatneously | leave out of scope for now |
Input Reference Material
RFC 8639 : Subscription to YANG Notifications
Alternatives
Alternative event headers include
Alt #1
Alt #1 : |
---|
|
Alt #2 Based on current CPS event |
---|
{ <event body> } } |
Proposal Details
Scope covers the Create, Update and Delete of CM Handles.
Update is required as an application must know when we go from ADVISED to READY state.
Proposal is via the main scenarios.... the schema can reflect this.
cmhandle Event Type | Detail | Event |
---|---|---|
CREATE | Add New CM Handle. CM Handle added to NCMP in ADVISED state with publicCmhandleProperties | { "schema": "org.onap.ncmp:cmhandle-lcm-event-schema:v1", "id": "77b8f114-4562-4069-8234-6d059ff742ac", "source": "org.onap.ncmp", "type": "org.onap.ncmp.cmhandle-lcm-event", "content": { "observedTimestamp": "2020-12-01T00:00:00.000+0000", # time of received REST registration request "cmhandleId": "43t345tbnfd85435" "operation" : "CREATE", "data" : { # May add new payload info in future, e.g. publicCmHandleProperties "state" : { "cmhandleState" : "ADVISED" } } } } |
UPDATE | Update cmhandle. schemaSet is also sent in the event as it has been updated along | { "schema": "urn:cps:org.onap.ncmp:cmhandle-lcm-event-schema:v1", "id": "77b8f114-4562-4069-8234-6d059ff742ac", "source": "urn:cps:org.onap.ncmp", "type": "org.onap.cps.cmhandle-lcm-event", "content": { "observedTimestamp": "2020-12-01T00:00:00.000+0000", "cmhandleId": 43t345tbnfd85435 "operation" : "UPDATE", "data": { # only changed properties are returned "state" : { "cmhandleState" : "READY" }, "schemaSet": ["schema-name-1", "schema-name-2", "schema-name-3", "schema-name-4", "schema-name-5"] # list of all yang modules } } } } |
UPDATE | Update cmhandle Multiple updates to a cmhandle | { "schema": "urn:cps:org.onap.ncmp:cmhandle-lcm-event-schema:v2", "id": "77b8f114-4562-4069-8234-6d059ff742ac", "source": "urn:cps:org.onap.ncmp", "type": "org.onap.cps.cmhandle-lcm-event", "content": { "observedTimestamp": "2020-12-01T00:00:00.000+0000", "cmhandleId": 43t345tbnfd85435 "operation" : "UPDATE", "data": { "publicCmhandleProperties" : [ "property-name-1" : null # indicates the property has been deleted/removed from the cmhandle "property-name-2" : "some-prop-value-2" # indicates the property has been modified. "property-name-3" : "some-prop-value-3" # This is a new cmhandle property added. ] } } } } |
UPGRADE | Upgrade cmhandle SchemaSet change. | { "originalSchemaSet" : ["schema-name-1", "schema-name-2", "schema-name-3", "schema-name-4", "schema-name-5.1"], |
DELETE | Delete cmhandle | { "schema": "org.onap.ncmp:cmhandle-lcm-event-schema:v1", "id": "77b8f114-4562-4069-8234-6d059ff742ac", "source": "org.onap.ncmp", "type": "org.onap.ncmp.cmhandle-lcm-event", "content": { "observedTimestamp": "2020-12-01T00:00:00.000+0000", "cmhandleId": 43t345tbnfd85435 "operation" : "DELETE" } |