Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This document specifies ONAP modeling design principles and guidelines for release 2+

Principles

1-  Requirement driven and prioritize per release

2-  Based on existing implementation and maintain backward compatibility

3-  Keep the distinction and consistency between Information model and its data model representation(s).

a)  DM does not need to match exactly the IM; DM can represent the IM

b)  DM are pruned and refactored from IM

c)  Discuss extensibility guidelines to be progressed (TBD)

 

Guidelines

1- Initially focus on a Unified Information Model and its TOSCA construct representation for Service and Resource.

2-   Best effort to align terminology with ETSI (IFA11 and IFA14) 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.

3-  Identify the gaps in either information modeling (in terms of information elements) or data model (in terms of types/constructs) we need to fulfill the functional/non-functional requirements derived from the usecases and prioritize per release.

a)  Initial round should be based on SDC Data Model and OpenECOMP Information Model

b)   Identify existing construct 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.

4-  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.

6-  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.

7-  Create a (class) diagram which outlines ONAP DM relationship to TOSCA Simple Profile 1.2