...
| Table of Contents |
|---|
Requirements
Functional
| # | Interface | Requirement | Additional Information | Sign Off |
|---|---|---|---|---|
| 1 | CPS-NCMP-I-01 | Upgrade module set for CM-Handle(s) using a moduleSetTag | Module Set Tag is owned (defined) by DMI Plugin |
|
| 2 | CPS-NCMP-I-01 | Initial Inventory shall support (Optional) moduleSetTag too | Exiting performance shall not degrade. |
|
| 3 | CPS-NCMP-I-01 | Update module set for CM-Handle(s) using a Blank (not defined) moduleSetTag | use 'old' algorithm from initial inventory |
|
| 4 | CPS-E-05 | Read moduleSetTag for given CM Handle(id) | Probably no code changes required (just a model change) |
|
| 5 | CPS-E-05 | Query Cm Handle(s) using CPS Path with moduleSetTag | Probably no code changes required (just a model change) |
|
| 6 | CPS-E-05.e (e for events) | A new notification informing the client the old and new value of moduleSetTag | Use same topic as CM Handle LCM Events (and future trust-level change notifications) |
|
...
Note: Only pass-through i.e. non-cached data upgrade is in scope; "ncmp-datastore:passthrough-running" and "ncmp-datastore:passthrough-operational" is in scope.
Assumptions
| # | 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 |
| 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 |
| 13 | Conflicting Error code : Legacy codes for registration v. event status code (dataOperation and Subscrption) | See
ModuleSetTag error scenarios have overlapping codes for 'cm handle not found/not found' Some of these are already in use!!! Can we fix now or live with inconsistencies forever?! NEW
Create a new Jira and agree priority with E// - Prioritise it's a blocker |
|
...
| 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 | Use moduleSetTagCache to be cleared or updates as algorithm wil re-use existing schema set name |
| 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 | CSIT test and demo |
| 5 Days | ||||||||||||
| 9 | NCMP | Test and document performance of updating YANG schema set API. |
| 10 Days | ||||||||||||
| 10 | NCMP | Handle yangTextSchemaSourceSetCache for module set tag |
| 5 Days |
Planning:
- Allow for 2 more user stories each may take 1 week.
- Estimated date of completion is based on 1 person working. There is a possibility that 1 more person will join in between for implementation but there is no clear visibility on when the person can start contributing as of now.
- These are estimates and should not be interpreted as commitments.
...