- CPS-1733Getting issue details... STATUS
- CPS-1734Getting issue details... STATUS
Study is required to clearly define the scope and impacts of updating YANG model schema sets for cmhandles.
Requirements
Functional
# | Interface | Requirement | Additional Information |
---|---|---|---|
1 | TBD |
Error Handling
# | Error Scenario | Expected behavior |
---|---|---|
1 |
Capabilities
The assumption is there are 100 modules in each moduleSet and a moduleSet is available from a dmi plugin within 0.5 seconds. Also assume there is a 90% overlap in modules across all CM Handles.# Parameter Expectation Notes 1 Request Frequency
Upgrade to NEW ModuleSetTags2.5 upgrades / second → 150 upgrades / minute 2 Request Frequency
Upgrade to already existing ModuleSetTags5 upgrades / second → 300 upgrades / minute 3 Test Environment 4 Concurrent request TBD 12 clients requests toward 1 NCMP simultaneously
Out-of-scope
- Upgrade of models for cached data (only pass-trough ie. non-cached data upgrade will be supported
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 hash for this new 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?
| |
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 tag | |
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 | |
6 | ModuleSetTag should be able to be used during initial inventory too! | Initial Inventory should be sped up too (capability requirements impacts ?!) | |
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: 'upgardedCmHandles' | The interface currently supports
it possibly could be done as part of 'updatedCmHandles' and look for /recognize the moduleSetTag update but this would be messy and confusing, also then theoretically properties could be updated as the same time as the module set.. |
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 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.
The above proposal would require model updates to NCMP to store the association between a ModuleSetTag supplied by a dmi-plugin (during and updateCmHandles request) and the modules. Initially ModuleSetTag is not known to NCMP. However, after retrieval of the modules for the first time for the cmhandle, NCMP can store the association. Any subsequent cmhandle that references the same ModuleSetTag will not require NCMP to go back to the dmi plugin for the moduleSet.
Reuse the NCMP Inventory API (CPS-NCMP-I-01). URI : POST /v1/ch
Support for upgrade without (empty) ModuleSetTag
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.