...
| 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 | |
| 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 |
| Team agreed to re-use existing name |
Solution Proposals
Update Inventory REST Interface
...
- should upgrade be dealt with in parallel too? Toine Siebelink recommends this
- should upgrade be done in batches (of 100) too?
- need to use a (new?) state for UPGRADE that the watchdog can see an process
- re-use existing methods and make creating aan anchor optional or create new upgrade specific methods and reuse/slightly duplicate initial inventory methods? Methods like
- org.onap.cps.ncmp.api.inventory.sync.ModuleSyncService#syncAndCreateSchemaSetAndAnchor
- org.onap.cps.ncmp.api.inventory.sync.ModuleSyncService#createSchemaSetAndAnchor
team agreed to re-use ModuleSyncWatchDog and batching with following considerations
- Need to use a new (shared) Hazelcast map with ModuleSetTags as key (value list of module refs) that have been processed (but not saved yet) to be used both inside a batch and different instance to prevent unnecessary trips to DMI/Node
- Watchdog needs to use Lock state AND lock reason to determine what node need to be upgraded
- Initial inventory and upgrade is not likely to happen at the same time but watchdog can handle both, of course performance would be affected if that does occur
- CACHE(s) needs to be cleared or updates as algorithm wil re-use existing schema set name
- Create new upgrade specific methods and reuse/slightly duplicate initial inventory methods
- Legacy (and new) checks for lock need to check the lock-reason too now! To differentiate between failed initial inventory and upgrade
- Probably need more specific (new) failure reasons to differentiate between initial inventory and upgrade failures
- as usual: small commits, early reviews to introduce all this functionality are advised, posisbel steps
- set lock state and reason upon request
- watch dog just list to be upgrade node (and does not mix them up with failed initial inventory)
- perform first upgrade for a new ModuleSetTag
- introduce and use new Hazelcast map
- perform upgrade of an node with a modueleSetTag that is already in cache
- perform upgrade of an node with a modueleSetTag that is already in DB (ie introduce DB query)
- handle failure of upgrade (re-use same retry mechanism as initial inventory but with different lock reason!)
- etc.
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 |
...