...
| # | Assumption | Notes |
|---|
Issues & Decisions
| # | Issue | Notes | Decision | |
|---|---|---|---|---|
| 1 | Type of Interface REST or Kafka | REST
Kafka
| meeting Agreed to use REST interface. | |
| 2 | moduleSetTag based on Hash no (yet) implemented! | This study seems to assume the module set tag is already implemented but it isn't! | [kieran mccarthy]: the request it to introduce the module set tag/identifier of some kind for this new upgrade usecase. Not assuming it is there already. Will be costlier but is important for performance to avoid pulling models if they are already known to NCMP. | |
| 3 | Expected Responses | when and what content?
Should follow error handling for Inventory | kieran mccarthy and team. | |
| 4 | Should CM-Handle state change (e.g. to 'locked') 'during' upgrade? | Yes but is important to not be locked for long which makes it important to use the moduleSetTag | kieran mccarthy Should be set to LOCKED until the new moduleSet is associated with the cmhandle. I think there is a LOCKED_UPGRADING if I remember right. Lock reason should mention "upgrade" and have the usual timestamps. A separate notifications will be send with details of the old and new values for moduleSetTag see decision #11 | |
| 5 | moduleSetTag is Optional (owned and defined by DMI Plugin) | Support for upgrade without continues using delete/add cm handle approach. If the update includes an moduleSetTag it would be considered an upgrade | meeting Agreed to use REST interface with "upgradedCmHandles". | |
| 6 | moduleSetTag should be able to be used during initial inventory too! | Initial Inventory should be sped up too (capability requirements impacts ?!) Note. Current inventory 'createdCmHandles' only supports a list of cm handle Ids can this be in backward compatible way be modified to optionally include a moduleSetTag | kieran mccarthy and team. Yes, if need backward incompatible change can be handle as a new version of the interface | |
| 7 | Exact name moduleSetTag | meeting agreed on moduleSetTag | ||
| 8 | How to store: hardcoded (postgress schema), inventory yang model or as additional property (private or public)? | update Inventory Yang Model so it can be queried (without code changes!) like other aspect such as 'state' | meeting agreed to update Yang Model | |
| 9 | additional operation for inventory Interface: 'upgradedCmHandles' | The interface currently supports
it possiblycould be done as part of 'updatedCmHandles' and look for /recognize the moduleSetTag update but this would be messy and confusing, also thentheoretically properties could be updated as the same time as the module set.. | meeting agreed | |
| 10 | Clarify capabilities |
| Part of requirement listed above, to be finalized in a meeting after the holidays on | |
| 11 | Separate Notification on change of moduleSetTag |
| kieran mccarthy separate notification see requirement #6 |
Solution Proposals
Update Inventory REST Interface
| 12 | Reuse schema set name or create a new one? | each cm handle now has a (unique) schema set name which is the same as the cm handle (id). we could simply change the module references but it might be more correct to create a NEW schema set and delete the old one. The name name could be a concatenation of the cm handle (id) and the module set tag |
Solution Proposals
Update Inventory REST Interface
Making the module upgrade request either over REST or Kafka Event with a supplied 'moduleSetTag' property will indicate to NCMP that a cmhandle has a new moduleSet (node has been upgraded). The moduleSetTag is a unique identifier for the set of modules associated with a cmhandle. This event or rest request will trigger ncmp to either retrieve the new module set for this cmhandle from the dmi plugin or if NCMP is already aware of moduleSetTag as part of a previous retrieval for a set of modules for a Making the module upgrade request either over REST or Kafka Event with a supplied 'moduleSetTag' property will indicate to NCMP that a cmhandle has a new moduleSet (node has been upgraded). The moduleSetTag is a unique identifier for the set of modules associated with a cmhandle. This event or rest request will trigger ncmp to either retrieve the new module set for this cmhandle from the dmi plugin or if NCMP is already aware of moduleSetTag as part of a previous retrieval for a set of modules for a cmhandle that supplied this moduleSetTag then it should not re-retrieve the modules from the dmi plugin as it already has them. NCMP should use its stored moduleSetTag to get the set of modules. It can then do a delta with the existing cmhandle moduleSet and update the moduleSet for the cmhandle.
...
- Use new 'upgradedCmHandles' operation to upgrade CH-1
- Find a cmHandle with given 'moduleSetTag'
(if not found use algorithm defined in next section) - Get all module references for cm handle (schemaset) with same tag (CH-2)
- Update module references for the anchor/schemaset CH-1
(See open issue # 12: should we create a NEW schema set and delete the old one ?) - Update inventory for CH-1 with given module set tagUpdate inventory for CH-1 with given module set tag
Support for Upgrade Without Module Set Tag
Note. Same algorithm should be used when Module Set tag is is not set (leaf not present), blank or no other CMHandle cmHandle with same tag can be found
If the moduleSetTag json property is set to "" (empty string) or then it should also indicate that the moduleSet for a cmHandle has been updated but there is no associated moduleSetTag available for that cmHandle. This approach will always result is a full request to the dmi plugin for the module set for the cmHandle.string) or then it should also indicate that the moduleSet for a cmHandle has been updated but there is no associated moduleSetTag available for that cmHandle. This approach will always result is a full request to the dmi plugin for the module set for the cmHandle.
Basically the same steps as during initial inventory can be followed. Except the creation of the cmHandle (anchor) as that already exist
- get all module references from the (upgraded) cm handle (via DMI)
- find out which module references are NEW to CPS-Core
- get the yang resources for the new modules from the (upgraded) cm handle (via DMI)
- create/save a new schema set using the existing module reference and new yang resources
(proposed name for schema set: <cmHandleId>-<moduelSetTag> TC see issue #12) - update the schemaset for the upgraded cm handle
- set the moduleSetTag in the ncmp inventory for the upgraded cm handle
- TBC delete the old schema set of the upgraded cm handle
Proposed JIRAs
| Priority | Component | Description | JIRA | Estimates | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | CPS Core | Expose a java interface to update schema set |
| 5 Days | ||||||||||||
| 2 | NCMP | Update existing REST endpoint add operation to upgrade YANG schema set using moduleSetTag |
| 15 Days | ||||||||||||
| 3 | NCMP | Upgrade inventory YANG model to store moduleSetTag |
| 5 Days | ||||||||||||
| 4 | NCMP | Upgrade anchor to new yang schema set (CPS-Core) Duplicate of #1 |
| 5 Days | ||||||||||||
| 5 | NCMP | Update cmhandle state (lock) during YANG model upgrade |
| 5 Days | ||||||||||||
| 6 | NCMP | Modify existing inventory operations using moduleSetTag as optional attribute |
| 15 Days | ||||||||||||
| 7 | NCMP | Identify and test error scenarios |
| 5 Days | ||||||||||||
| 8 | NCMP | Update DMI Stub for testing purposes and add CSIT test |
| 5 Days | ||||||||||||
| 9 | NCMP | Test and document performance of updating YANG schema set API. |
| 10 Days |
...