You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 4
Next »
This document specifies ONAP modeling design principles and guidelines for release 2+
The Principles section focuses on "what" foundations need to be followed as part of the ONAP Modeling effort, while the Guidelines section focuses on the plan for "how" to achieve the goals described in the Principles section and identifies best practices that may be applied.
Principles
1- Requirements driven and prioritization per release
2- Based on existing implementation and attempt to maintain backward compatibility
a) DM does not need to match exactly the IM; DM can represent the semantics of the IM
b) DM are pruned and refactored from IM
c) Discuss extensibility guidelines to be progressed (TBD)
![](/download/attachments/16001924/image2017-10-17_14-47-25.png?version=1&modificationDate=1508266045000&api=v2)
Guidelines
4- Actively pursue participation from stakeholder projects in the modeling effort.
6- Best effort to align terminology with ETSI (IFA011 and IFA014) where appropriate.
a) Establish a mapping between equivalent terms between ONAP and ETSI NFV ISG and identify the differences.
b) Based on the use cases, select the appropriate model terms if the one-to-one mapping is not possible.
b) Identify existing constructs defined in other SDO specification (e.g. TOSCA NFV Profile and SOL001).
c) Encourage efforts in other SDOs to align with ONAP IM/DM implementation with their specifications (e.g. TOSCA NFV Profile and SOL001) development.
8- When defining new constructs in ONAP Data model
a) Best effort to use TOSCA Simple Profile 1.2 “normatives”
b) Best effort to extend/Derive from Simple Profile 1.2 “normatives”s if direct reference is not possible
c) Otherwise, derive directly from tosca.nodes.root
5- When defining new properties, best effort to put properties on capabilities.
9- When defining new Namespace, in order to avoid namespaces and types name types definitions collision, it is recommended that ONAP uses the rule and guidelines as described in the OASIS TOSCA Simple YAML Profile v1.2.