Note - a separate contribution has since been made on the topic of a root hierarchy. Portions of this contribution therefore need to be updated, but the lower level detail regarding onboarding and platform concepts still need to be discussed.
Diagrams
Figure 1 - RootEntity
Figure 2 - Descriptor (basis for all design time classes)
Figure 3 - Onboarding and Platform Class Interrelationships
Classes
RootEntity class
Qualified Name: Common::Root::RootObjectClasses::RootEntity
Description:
This is the top of the ONAP class hierarchy. The purpose of the RootEntity is to define a set of attributes that are common to all entities that derive from it. These properties enable us to name, describe, and identify all objects in the environment.
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Attributes for Class RootEntity
| Attribute Name | Type | Mult. | Description | Stereotypes |
name | String | 1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 1 | Defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.
| OpenModelAttribute
|
Descriptor (EntitySpecification) class
Qualified Name: Common::Root::RootObjectClasses::Descriptor (EntitySpecification)
Description:
This is an abstract base class that is used to define the common characteristics (attributes, constraints, and relationships) of a design time entity.
Parent class: RootEntity
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Attributes for Class Descriptor (EntitySpecification)
| Attribute Name | Type | Mult. | Description | Stereotypes |
validFor | TimePeriod | 1 | The period during which the descriptor is valid.
| OpenModelAttribute
|
status | String | 1 | The condition of the specification, such s active, inactive, or planned.
| OpenModelAttribute
|
descriptorVersion | String | 1 | Identifies the version of the descriptor.
| OpenModelAttribute
|
name | String | 1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 1 | Defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.
| OpenModelAttribute
|
Entity class
Qualified Name: Common::Root::RootObjectClasses::Entity
Description:
This is an abstract class that extends the RootEntity class in order to represent classes of objects that represent runtime instances (VnfInstance, ServiceInstance,etc).
Parent class: RootEntity
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Attributes for Class Entity
| Attribute Name | Type | Mult. | Description | Stereotypes |
name | String | 1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 1 | Defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 | Unambiguously distinguishes different object instances. It is the naming attribute of the object. Identifier of this information element. This attribute shall be globally unique.
| OpenModelAttribute
|
OnboardingNfDescriptor class
Qualified Name: Common::Network::NetworkObjectClasses::OnboardingNfDescriptor
Description:
OnboardingNfDescriptor is an abstract class that extends Descriptor to represent classes of objects that represent onboarded network function descriptors.
This class is abstract.
Parent class: Descriptor (EntitySpecification)
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Attributes for Class OnboardingNfDescriptor
| Attribute Name | Type | Mult. | Description | Stereotypes |
ProviderName | String | 1 | Provider of the NF and of the NFD being onboarded.
| OpenModelAttribute
|
productInfoName | String | 0..1 | Human readable name for the NF Product. Can change during the NF Product lifetime.
| OpenModelAttribute
|
softwareVersion | String | 1 | Software version of the NF. This is changed when there is any change to the software that is included in the NF Package.
| OpenModelAttribute
|
localizationLanguages | String | 0..* | Information about localization languages of the NF (includes e.g. strings in the NFD). valueRange: refer to ISO936 https://www.iso.org/iso-639-language-codes.html
| OpenModelAttribute
|
productInfoDescription | String | 0..1 | Human readable description of the NF Product. Can change during the NF Product lifetime.
| OpenModelAttribute
|
defaultLocalizationLanguage | String | 0..1 | valueRange: refer to ISO936 https://www.iso.org/iso-639-language-codes.html condition: Shall be present if "localizationLanguage" is present and shall be absent otherwise. Default localization language that is instantiated if no information about selected localization language is available.
| OpenModelAttribute
|
_onboardingcpdescriptor | OnboardingCpDescriptor | 0..1 |
| OpenModelAttribute
|
_onboardingvldescriptor | OnboardingVLDescriptor | 0..1 |
| OpenModelAttribute
|
validFor | TimePeriod | 1 | The period during which the descriptor is valid.
| OpenModelAttribute
|
status | String | 1 | The condition of the specification, such s active, inactive, or planned.
| OpenModelAttribute
|
descriptorVersion | String | 1 | Identifies the version of the descriptor.
| OpenModelAttribute
|
name | String | 1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 1 | Defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 | Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object.
| OpenModelAttribute
|
PlatformDescriptor (InternalModel) class
Qualified Name: Common::Network::NetworkObjectClasses::PlatformDescriptor (InternalModel)
Description:
PlatformDescriptor is an abstract class that extends Descriptor to represent classes of objects that represent platofrm or internal descriptors.
This class is abstract.
Parent class: Descriptor (EntitySpecification)
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Attributes for Class PlatformDescriptor (InternalModel)
| Attribute Name | Type | Mult. | Description | Stereotypes |
invariantID | Identifier | 1 | ID that spans multiple versions of the same descriptor.
| OpenModelAttribute
|
classification | 1 | Type/Role/Function (a datatype). Classification may be a base type.
| OpenModelAttribute
| |
validFor | TimePeriod | 1 | The period during which the descriptor is valid.
| OpenModelAttribute
|
status | String | 1 | The condition of the specification, such s active, inactive, or planned.
| OpenModelAttribute
|
descriptorVersion | String | 1 | Identifies the version of the descriptor.
| OpenModelAttribute
|
name | String | 1 | Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).
| OpenModelAttribute
|
description | String | 1 | Defines a textual free-form description of the object.
| OpenModelAttribute
|
id | Identifier | 1 | Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object.
| OpenModelAttribute
|
PlatformNfDescriptor class
Qualified Name: Common::Network::NetworkObjectClasses::PlatformNfDescriptor
Description:
PlatformNfDescriptor is an abstract class that extends PlatformDescriptor to represent classes of design time objects that represent internal, or platform network function descriptors.
This class is abstract.
Parent class: PlatformDescriptor (InternalModel)
Applied Stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Attributes for Class PlatformNfDescriptor
| Attribute Name | Type | Mult. | Description | Stereotypes |
platformcpdescriptor | PlatformCpDescriptor | 0..1 |
| OpenModelAttribute
|
platformvldescriptor | PlatformVLDescriptor | 0..1 |
| OpenModelAttribute
|
invariantID | Identifier | 1 | ID that spans multiple versions of the same descriptor.
| OpenModelAttribute
|
classification | 1 | Type/Role/Function (a datatype). Classification may be a base type.
| OpenModelAttribute
| |
validFor | TimePeriod | 1 | The period during which the descriptor is valid.
| OpenModelAttribute
|
status | String | 1 | The condition of the specification, such s active, inactive, or planned.
| OpenModelAttribute
|
descriptorVersion | String | 1 | Identifies the version of the descriptor.
| OpenModelAttribute
|