...
# | Issue | Notes | Decision | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | Performance issue with current solution | Current solution used inefficient query to populate (first) prefix property for ALL fragments although only used for top level | Will be handled by separate Jira already in progress, see
| ||||||||||||
2 | Top level container is not always defined in first module | This might not be required as the first short-term solution is delivered first | Will be handled by separate Jira
| ||||||||||||
3 | Add prefix for container in same module | This is allowed but not done normally. Team concerned about performance issues and impact on URLs when using this | Ahila P : Prefix is not required for the child modules or nodes, if it carries the same prefix as parent | ||||||||||||
4 | Add prefix to first container when this is not the top level for the module it is defined | retrieve B or C directly (without parent), in that case should the prefix stil be used ie. Module1:/B | Team Prefix required for top level nodes in output | ||||||||||||
5 | /module1:A/B/module2:C/D Which module reference should be inserted in the cpaths for 'Module1' and 'Module2'. Prefix or Name, or last token of namespace?! | See sample from https://github.com/YangModels/yang/blob/main/vendor/cisco/xr/534/ietf-inet-types.yang
(Unfortunately in above example module name and last token of namespace are the same, not sure if this just convention or mandatory CPS Team (made-up) example
| Ahila P It refers to the 'prefix' in the yang model (highlighted in the sample yang model). module ietf-inet-types { namespace "urn:ietf:params:xml:ns:yang:ietf-inet-types"; prefix "inet"; | ||||||||||||
6 | Prefix for (additional) leaves that are defined in a separate module then the container itself | Required, not sure how common this is. DB Solution for this might be quite difficult. Toine's POC should handle it (to be tested) | |||||||||||||
7 | How to handle lists (instead of container) | Possibly ignore [@key=value] part. Small neglectable change of same model defined both under same parent... Toine's Poc can be modified to handle this with help from establish regular-expressions from other use cases | |||||||||||||
8 | Performance Considerations | SchemaContext generation is expensive.
| Use Hazelcast to store 'simplified Model' as defined in Poc Toine | ||||||||||||
9 | Is 'prefix' attribute mandatory for any yang module | what to do if it is not there | Ahila P to checkAhila P checked Documentation not clear btu in practice creating a yang module without prefix gives a 'compilation' liek error in PiYang | base in Ahila's feedback we assume it is mandatory. |
Road Map
- Short Term solution
- No DB changes or DB interaction (after retrieving yang resources) Based on Toine's Poc https://gerrit.nordix.org/c/onap/cps/+/15553
- Lazy loading of 'simplified model'
- Cache simplified Module (for performance reasons) Can built on te solution for
here https://gerrit.onap.org/r/c/cps/+/131493Jira Legacy server System Jira serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key CPS-1326 - This solution should handle Leaf (defined in different module) as well
- Medium term solution
- Update CPS Internal Relation DB Schema and data insert to retain fragment - yang resource relation
- Modify data retrieval to insert module references as required
- retain/modify short term solution for leaves-in-separate modules
- Long term solution
- Modie schema to store attribute module informat when needed i.e. when not defined in same module as container that owns those leaves
- Detailed analysis required
...