diff options
| author |   yxpoke <yangxu5@huawei.com> | 2019-10-16 17:37:36 +0800 |
|---|---|---|
| committer | yxpoke <yangxu5@huawei.com> | 2019-10-16 17:49:59 +0800 |
| commit | a06de8844a8bebc9b8dae1b181ed8a3ed0b95be9 (patch) | |
| tree | 2425677f1819957a457f5f9de20901aaf0f1e70b /docs | |
| parent | dcd02b1fd1f87a8cfc63285f238a62fb99a79b0e (diff) | |
update R5 modelspec
Issue-ID: MODELING-228
Signed-off-by: yxpoke <yangxu5@huawei.com>
Change-Id: Id41a7cc4ef1c78c37d743819d13ecaf521fef298
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ONAP Model Spec/im/BusinessInteraction.rst | 574 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/NSD.rst | 1 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/Root.rst | 751 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/Service.rst | 25 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst | 142 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/index.rst | 3 |
6 files changed, 1391 insertions, 105 deletions
diff --git a/docs/ONAP Model Spec/im/BusinessInteraction.rst b/docs/ONAP Model Spec/im/BusinessInteraction.rst new file mode 100644 index 0000000..820c82e --- /dev/null +++ b/docs/ONAP Model Spec/im/BusinessInteraction.rst @@ -0,0 +1,574 @@ +.. Copyright 2019 +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Business Interaction Model +========================== + +.. contents:: + :depth: 3 +.. + +Class Definition +---------------- + +BusinessInteractionItemRelationship class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses:: BusinessInteractionItemRelationship + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for Class BusinessInteractionItemRelationship** + +================== ========== ========= ===================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= ===================================================== ===================== +type String 1 The type of relationship such as contains, relies on. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +validFor TimePeriod 1 Time period for which the relationship is valid OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= ===================================================== ===================== + +Agreement class +^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::Agreement + +**Description:** + +A type of BusinessInteraction that represents a contract or arrangement, either written or verbal and sometimes enforceable by law. + +**Parent class:** BusinessInteraction + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for class Agreement** + +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +documentNumber String 1 A reference number assigned to an Agreement that follows a prescribed numbering system. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +statementOfIntent String 1 An overview and goals of the Agreement. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +StartDate DateTime 1 Date interaction initiated OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +endDate DateTime 1 The date on which an interaction is closed or completed. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +name String 0..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 + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute + + Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== + +BusinessInteraction class +^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteraction + +**Description:** + +A BusinessInteraction is an arrangement, contract, communication or joint activity between one or more PartyRoles, ResourceRoles, or CustomerAccounts. A BusinessInteraction may consist of one or more BusinessInteractionItems. A BusinessInteractionItem may refer to a Product, Service, Resource, or one of their specifications. A BusinessInteraction is further defined by one or more Places. One BusinessInteraction may reference another BusinessInteraction and one BusinessInteractionItem may reference another BusinessInteractionItem on the same or different BusinessInteraction. Types of BusinessInteractions include : Requests, Responses, Notifications, and Agreements. + +This class is abstract. + +**Parent class:** RootEntity + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for class BusinessInteraction** + +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +StartDate DateTime 1 Date interaction initiated OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +endDate DateTime 1 The date on which an interaction is closed or completed. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +Status String 0..1 The current condition of an interaction, such as open, in research, closed, and so forth OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +name String 0..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 + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute + + Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== + +BusinessInteractionItem class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionItem + +**Description:** + +The purpose for the BusinessInteraction expressed in terms of a ProductSpecification, ProductOffering, ServiceSpecification or ResourceSpecification or may refer to a Product, Service, or Resource. + +This class is abstract. + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for class BusinessInteractionItem** + +================== ======== ========= ======================================================================= ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ======== ========= ======================================================================= ===================== +quantity Integer 1 Quantity of an interaction item involved in an interaction. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +action String 1 The action to take for an InteractionItem, such as add, change, remove. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ======== ========= ======================================================================= ===================== + +BusinessInteractionRelationship class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionRelationship + +**Description:** + +An association between two Interactions. For example, a Notification sent to customers affected by a problem contained on a Trouble Report; a response to a request, an agreement and the interactions that led up to the agreement. + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +**Table** **Attributes for class BusinessInteractionRelationship** + +================== ========== ========= =============================================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= =============================================================================== ===================== +type String 1 A categorization of the relationship, such as bulk, parent/child, and so forth. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +validFor TimePeriod 1 Time period for which the relationship is valid OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= =============================================================================== ===================== + +BusinessInteractionSpec class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionSpec + +**Description:** + +The invariant characteristics (attributes in the business view, and methods, constraints, relationships, and behavior in the system view) and behavior of a BusinessInteraction. This is done by optionally defining a set of BusinessInteractionSpecItems, each of which aggregates one or more other types of Specifications. This helps to ensure that different BusinessInteractions have the same basic characteristics and behavior by deriving them from the same BusinessInteractionSpec. + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +BusinessInteractionVersion class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::BusinessInteractionVersion + +**Description:** + +Version of the business interaction. + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From TMF SID + +Notification class +^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::Notification + +**Description:** + +A communication that informs about something that has or will happen. A Notification is typically one-sided, in that no Response is expected. A Notification can be created as the result of a Request; for example, a Trouble Report may result in Notifications being sent to affected Parties. A Notification is a type of Business Interaction. + +This class is abstract. + +**Parent class:** BusinessInteraction + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From the TMF SID + +Request class +^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::Request + +**Description:** + +The act of asking that something be done that typically involves a Response. Request is a type of Business Interaction. + +This class is abstract. + +**Parent class:** BusinessInteraction + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From the TMF SID + +Response class +^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Business Interaction::ObjectClasses::Response + +**Description:** + +A reply to a Request + +This class is abstract. + +**Parent class:** BusinessInteraction + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +- Reference + +- reference: From the TMF SID diff --git a/docs/ONAP Model Spec/im/NSD.rst b/docs/ONAP Model Spec/im/NSD.rst index 8e027ae..2d4469a 100644 --- a/docs/ONAP Model Spec/im/NSD.rst +++ b/docs/ONAP Model Spec/im/NSD.rst @@ -6,7 +6,6 @@ :depth: 3 .. - |image0| NetworkServiceDescriptorModel diff --git a/docs/ONAP Model Spec/im/Root.rst b/docs/ONAP Model Spec/im/Root.rst new file mode 100644 index 0000000..ddda941 --- /dev/null +++ b/docs/ONAP Model Spec/im/Root.rst @@ -0,0 +1,751 @@ +.. Copyright 2019 +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode + +Root Model +========== + +.. contents:: + :depth: 3 +.. + +Overview +-------- + +**Qualified Name:** Common::Root + +**Description:** + +A set of common business entities that collectively serve as the foundation of the ONAP Information Model. This set of root classess enable the entities in different domains of the Information Model to be associated with each other, providing greater overall coherence. + +Class Definition +---------------- + +DesignEntity class +^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootObjectClasses::DesignEntity + +**Description:** + +A template which describes an OperationalEntity in terms of deployment and operational behavior requirements. + +This class is abstract. + +**Parent class:** Entity + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +**Table** **Attributes for class DesignEntity** + +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +validFor TimePeriod 1 The period during which the design entity is valid. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +status String 1 The condition of the specification, such s active, inactive, or planned. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +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 + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +description String 1 Defines a textual free-form description of the object. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute + + Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== + +Domain class +^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootObjectClasses::Domain + +**Description:** + +Defines a collection of entities that share a common purpose. In addition, each constituent Entity in an Domain is both uniquely addressable and uniquely identifiable within that Domain + +**Parent class:** RootEntity + +**Applied Stereotypes:** + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +Entity class +^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootObjectClasses::Entity + +**Description:** + +This is an abstract class that extends the RootEntity class and represents characteristics and behaviors of concepts that pertain to the NFV managed environment. + +This class is abstract. + +**Parent class:** RootEntity + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +ManagedEntity class +^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootObjectClasses::ManagedEntity + +**Description:** + +A ManagedEntity is used to specify that an Entity is manageable by electronic means. + +**Applied Stereotypes:** + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +**Table** **Attributes for class ManagedEntity** + +========================= ======== ========= ================================================================================================================= ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +========================= ======== ========= ================================================================================================================= ===================== +managementMethodCurrent Integer 1 This is an enumerated integer that defines the particular type of management method that is currently being used. OpenModelAttribute + Permitted Values: + 0: Unknown - partOfObjectKey: 0 + 1: None + 2: CLI - uniqueSet: + 3: SNMP + 4: TL1 - isInvariant: false + 5: CMIP + 6: Proprietary - unsigned: false + + - counter: NA + + - support: MANDATORY +managementMethodSupported Integer 1..\* This is an array of integers that define the different management methods that are supported by this object. OpenModelAttribute + Permitted Values: + 0: Unknown - partOfObjectKey: 0 + 1: None + 2: CLI - uniqueSet: + 3: SNMP + 4: TL1 - isInvariant: false + 5: CMIP + 6: Proprietary - unsigned: false + + - counter: NA + + - support: MANDATORY +========================= ======== ========= ================================================================================================================= ===================== + +OperationalEntity class +^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootObjectClasses::OperationalEntity + +**Description:** + +An OperationalEntity is a deployment in a NFV environment of a DesignEntity. + +This class is abstract. + +**Parent class:** Entity + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +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. + +This class is abstract. + +**Applied Stereotypes:** + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +**Table** **Attributes for class RootEntity** + +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== +name String 0..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 + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +description String 0..1 Defines a textual free-form description of the object. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +id Identifier 1 Unambiguously distinguishes different object instances. It is the naming attribute of the object. OpenModelAttribute + + Identifier of this information element. This attribute shall be globally unique. - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY + + Preliminary +================== ========== ========= ====================================================================================================================================================================================================================================================================================================================================================================== ===================== + +Enumeration definition +---------------------- + +CompositeOperator enumeration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootTypeDefinitons::CompositeOperator + +**Description:** + +The operator being applied to to some group of selectoin critiera. + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- AND + +- OR + +- XOR + +Operator enumeration +^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootTypeDefinitons::Operator + +**Description:** + +The operator being applied to some atomic selection critera. + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- MORETHAN + +- LESSTHAN + +- EQUAL + +Priority enumeration +^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Priority + +**Description:** + +priority - processing priority. + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- HIGH + +- MEDIUM + +- NORMAL + +- LOW + +RuleScope enumeration +^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::RuleScope + +**Description:** + +Defines the scope of the rule. + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- NFVI_POP + +- ZONE + +- ZONE_GROUP + +- NFVI_NODE + +RuleType enumeration +^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::RuleType + +**Description:** + +Specifies the type of rule. + +**Applied Stereotypes:** + +- Preliminary + +**Contains Enumeration Literals:** + +- AFFINITY + +- ANTI_AFFINITY + +Datatype definition +------------------- + +ConfigurableProperties datatype +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::Root::RootTypeDefinitons:: ConfigurableProperties + +**Description:** + +Dynamic, configurable properites of some entity. + +**Applied Stereotypes:** + +- Experimental + +**Table** **Attributes for Data Type ConfigurableProperties** + +================== ============ ========= ==================================================== ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ============ ========= ==================================================== ================================== +properties KeyValuePair 0..\* The specific configurable properties of some entity. Experimental + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ============ ========= ==================================================== ================================== + +DateTime primitive type +^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::DateTime + +**Description:** + +DateTime - RFC 2822 standard date/time format. + +RFC 2822 format + +day-of-week, dd MM yyyy HH':'mm':'ss 'GMT' + +e.g. Tue, 21 Jun 2016 14:05:20 GMT + +File primitive type +^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::File + +**Description:** + +A primitive Type + +**Applied Stereotypes:** + +- Experimental + +Identifier datatype +^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Identifier + +**Applied Stereotypes:** + +- Preliminary + +Key datatype +^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Key + +**Description:** + +key - the key datatype is a tuple which provides the name of a key along with its value and relative order. + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type Key** + +================== ======== ========= ============================================================================== ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ======== ========= ============================================================================== ================================== +keyName String 1 keyName - Name of the key. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +keyOrder Integer 0..1 keyOrder - Relative sequence or order of the key (with respect to other keys). OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +keyValue String 0..1 keyValue - Value of the key. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ============================================================================== ================================== + +KeyValuePair datatype +^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::KeyValuePair + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type KeyValuePair** + +================== ======== ========= =============== ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ======== ========= =============== ================================== +key String 1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +value String 1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= =============== ================================== + +Number primitive type +^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Number + +**Description:** + +This primitive type is a superset of the standard UML numbering primitives, e.g. Integer and Real. + +**Applied Stereotypes:** + +- Preliminary + +Object primitive type +^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Object + +**Description:** + +object - objects are model elements that represent instances of a class or of classes + +**Applied Stereotypes:** + +- Preliminary + +Rule primitive type +^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Rule + +**Description:** + +Primitive type describing a rule. + +**Applied Stereotypes:** + +- Preliminary + +SecurityParameters datatype +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::SecurityParameters + +**Description:** + +The SecurityParameters contains the signature of a NSD, VLD, PNFD or VNFFGD instance together with information required to validate the signature. + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type SecurityParameters** + +================== ======== ========= ========================================================================================================= ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ======== ========= ========================================================================================================= ================================== +signature String 1 Provides the signature of the signed part of the descriptor. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +algorithm String 1 Identifies the algorithm used to compute the signature. OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +certificate 0..1 Provides a certificate or a reference to a certificate to validate the signature. OpenModelAttribute + NOTE: Cardinality of 0 corresponds to the case where the certificate is provided by means outside the NSD + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ========================================================================================================= ================================== + +TimePeriod datatype +^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::TimePeriod + +**Description:** + +A base / value business entity used to represent a period of time, between two timepoints + +**Applied Stereotypes:** + +- Preliminary + +**Table** **Attributes for Data Type TimePeriod** + +================== ======== ========= ================================================= ================================== +**Attribute Name** **Type** **Mult.** **Description** **Stereotypes** +================== ======== ========= ================================================= ================================== +startDateTime DateTime 1 An instant of time, starting at the TimePeriod OpenModelAttribute + Notes: + If null, then represents to the beginning of time - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endDateTime DateTime 1 An instant of time, ending at the TimePeriod: OpenModelAttribute + Notes: + If null, then represents to the end of time - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================================= ================================== + +UnixEpoch primitive type +^^^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::UnixEpoch + +**Description:** + +the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds + +Uri primitive type +^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Uri + +**Description:** + +type string; + +The uri type represents a Uniform Resource Identifier (URI) as defined by STD 66. + +Objects using the uri type MUST be in US-ASCII encoding, and MUST be normalized as described by RFC 3986 Sections 6.2.1, 6.2.2.1, and 6.2.2.2. All unnecessary percent-encoding is removed, and all case-insensitive characters are set to lowercase except for hexadecimal digits, which are normalized to uppercase as described in Section 6.2.2.1. + +The purpose of this normalization is to help provide unique URIs. Note that this normalization is not sufficient to provide uniqueness. Two URIs that are textually distinct after this normalization may still be equivalent. + +Objects using the uri type may restrict the schemes that they permit. For example, 'data:' and 'urn:' schemes might not be appropriate. + +A zero-length URI is not a valid URI. This can be used to express 'URI absent' where required. + +In the value set and its semantics, this type is equivalent to the Uri SMIv2 textual convention defined in RFC 5017. + +reference + +RFC 3986: Uniform Resource Identifier (URI): Generic Syntax + +RFC 3305: Report from the Joint W3C/IETF URI Planning Interest Group: Uniform Resource Identifiers (URIs), URLs, and Uniform Resource Names (URNs): Clarifications and Recommendations + +RFC 5017: MIB Textual Conventions for Uniform Resource Identifiers (URIs); + +**Applied Stereotypes:** + +- Preliminary + +Uuid primitive type +^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Uuid + +**Description:** + +type string { + +pattern + +'[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'; } + +A Universally Unique IDentifier in the string representation defined in RFC 4122. The canonical representation uses lowercase characters. + +The following is an example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6; + +reference + +RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace; + +**Applied Stereotypes:** + +- Preliminary + +Version primitive type +^^^^^^^^^^^^^^^^^^^^^^ + +**Qualified Name:** Common::TypeDefinitions::Version + +**Description:** + +This primitive type defines the version of an element. + +**Applied Stereotypes:** + +- Preliminary
\ No newline at end of file diff --git a/docs/ONAP Model Spec/im/Service.rst b/docs/ONAP Model Spec/im/Service.rst index 642cfa8..8e11e2c 100644 --- a/docs/ONAP Model Spec/im/Service.rst +++ b/docs/ONAP Model Spec/im/Service.rst @@ -2,6 +2,9 @@ .. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode +Service Model +~~~~~~~~~~~~~ + .. contents:: :depth: 3 .. @@ -128,8 +131,6 @@ Applied stereotypes: | | | | MANDATORY | | +-------------+-------------+-------------+-------------------+-----------------+ -.. _attachment-1: - Attachment ---------- @@ -5426,7 +5427,7 @@ VNF involved in a given NS level and the required number of instances. Enumerations ============ - Action +Action ------- Contains Enumeration Literals: @@ -5439,7 +5440,7 @@ Contains Enumeration Literals: - NO_CHANGE: - OrderPriority +OrderPriority -------------- A way that can be used by order requester to prioritize orders in @@ -5459,9 +5460,7 @@ Contains Enumeration Literals: - 4: -.. _orderstate-1: - - OrderState +OrderState ----------- Contains Enumeration Literals: @@ -5483,15 +5482,3 @@ Contains Enumeration Literals: - PARTIAL: - REJECTED: - -Primitives -========== - -Interfaces -========== - -Signals -======= - -Operations -========== diff --git a/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst b/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst index e8a81a0..7d0ba0c 100644 --- a/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst +++ b/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst @@ -1,31 +1,19 @@ -ONAP Vnf Sub Model +.. Copyright 2019 +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -1. .. rubric:: Diagrams - :name: diagrams +ONAP Vnfd and VnfInstance Model +=============================== - 1. .. rubric:: ONAP Vnfd - Topology View - :name: onap-vnfd---topology-view +.. contents:: + :depth: 3 +.. - 2. .. rubric:: ONAP Vnfd View - :name: onap-vnfd-view +Class Definition +---------------- - 3. .. rubric:: VNF Datatypes - :name: vnf-datatypes - - 4. .. rubric:: VNF Instance - :name: vnf-instance - - 5. .. rubric:: Vnf Deployment Flavor - :name: vnf-deployment-flavor - - 6. .. rubric:: Vnf Element Group - :name: vnf-element-group - -2. .. rubric:: Classes - :name: classes - - 7. .. rubric:: BaseConfigGroup - :name: baseconfiggroup +BaseConfigGroup +~~~~~~~~~~~~~~~ Every Vnf contains a BaseConfigGroup. BaseConfigGroup may set Access Control Lists (ACL's) and establish security groups and server groups. @@ -44,8 +32,8 @@ Applied stereotypes: - support: MANDATORY - 8. .. rubric:: DeploymentGroup - :name: deploymentgroup +DeploymentGroup +~~~~~~~~~~~~~~~ DeploymentGroup provides the minimum viable VDU and associated VNFC configuration for a useable VNF. I can have a small, medium, large @@ -61,8 +49,8 @@ Applied stereotypes: - support: MANDATORY - 9. .. rubric:: HomingGroup - :name: hominggroup +HomingGroup +~~~~~~~~~~~ Homing selects what cloud selection strategy will be used. HomingGroup is used to determine where VNF's within a given group are placed with @@ -105,7 +93,7 @@ Applied stereotypes: - Resources are co-located in the same cloud-region. Diversity - Resources are geo-diverse (cannot be co-located). - + * - vnfdMembers - invalid - 1 @@ -457,8 +445,8 @@ Applied stereotypes: - References to VnfVirtualLinkDesc that are part of this group. -13. .. rubric:: ScalingAspect - :name: scalingaspect +ScalingAspect +~~~~~~~~~~~~~ The ScalingAspect class describes the details of an aspect used for horizontal scaling. @@ -471,8 +459,8 @@ Applied stereotypes: - support: MANDATORY - 14. .. rubric:: ScalingGroup - :name: scalinggroup +ScalingGroup +~~~~~~~~~~~~ A ScalingGroup determines which VNFC's (VDU's) are scaled together based on demand. @@ -487,8 +475,8 @@ Applied stereotypes: - support: MANDATORY - 15. .. rubric:: SwImageDesc - :name: swimagedesc +SwImageDesc +~~~~~~~~~~~ The SwImageDesc information element describes requested additional capability for a particular VDU. Such a capability may be for @@ -2210,8 +2198,8 @@ Applied stereotypes: - support: MANDATORY - 29. .. rubric:: VnfExtCpd - :name: vnfextcpd +VnfExtCpd +~~~~~~~~~ Applied stereotypes: @@ -2344,8 +2332,8 @@ Applied stereotypes: - support: MANDATORY - 32. .. rubric:: Vnfc - :name: vnfc +Vnfc +~~~~ An internal component of a VNF providing a VNF Provider a defined sub-set of that VNF's functionality, with the main characteristic that a @@ -2591,8 +2579,8 @@ Applied stereotypes: - support: MANDATORY - 34. .. rubric:: Vnfd - :name: vnfd +Vnfd +~~~~ A Vnfd, or VNF Descriptor, is template which describes a VNF in terms of deployment and operational behaviour requirements. It also contains @@ -3000,11 +2988,11 @@ Applied stereotypes: - References to VnfVirtualLinkDesc that are part of this group. -3. .. rubric:: Data Types - :name: data-types +Data Type definition +-------------------- - 36. .. rubric:: LifecycleManagementScript - :name: lifecyclemanagementscript +LifecycleManagementScript +~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 @@ -3743,11 +3731,11 @@ VNFM. - It provides VNFC configurable properties that can be modified using the ModifyVnfInfo operation. -4. .. rubric:: Enumerations - :name: enumerations +Enumeration definition +---------------------- - 49. .. rubric:: AddressType - :name: addresstype +AddressType +~~~~~~~~~~~ Type of address @@ -3757,8 +3745,8 @@ Contains Enumeration Literals: - IP: - 50. .. rubric:: ClosedLoopStatus - :name: closedloopstatus +ClosedLoopStatus +~~~~~~~~~~~~~~~~ Contains Enumeration Literals: @@ -3766,8 +3754,8 @@ Contains Enumeration Literals: - DISABLED: - 51. .. rubric:: CollectionPeriod - :name: collectionperiod +CollectionPeriod +~~~~~~~~~~~~~~~~ Specifies the periodicity at which the producer will collect performance information. @@ -3783,8 +3771,8 @@ Contains Enumeration Literals: - isolation: - 53. .. rubric:: LcmEvent - :name: lcmevent +LcmEvent +~~~~~~~~ Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point. @@ -3827,8 +3815,8 @@ Contains Enumeration Literals: - EVENT_END_VNFINFO_MODIFICATION: - 54. .. rubric:: OperationalStatus - :name: operationalstatus +OperationalStatus +~~~~~~~~~~~~~~~~~ Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path. @@ -3839,8 +3827,8 @@ Contains Enumeration Literals: - OUT-OF-SERVICE-PATH: - 55. .. rubric:: OrchestrationStatus - :name: orchestrationstatus +OrchestrationStatus +~~~~~~~~~~~~~~~~~~~ Contains Enumeration Literals: @@ -3852,8 +3840,8 @@ Contains Enumeration Literals: - ACTIVE: - 56. .. rubric:: PinningPolicy - :name: pinningpolicy +PinningPolicy +~~~~~~~~~~~~~ Defines the CPU pinning policy. @@ -3863,8 +3851,8 @@ Contains Enumeration Literals: - DYNAMIC: - 57. .. rubric:: PlacementStrategy - :name: placementstrategy +PlacementStrategy +~~~~~~~~~~~~~~~~~ Contains Enumeration Literals: @@ -3874,8 +3862,8 @@ Contains Enumeration Literals: - EXCLUSIVITY: - 58. .. rubric:: ProvStatus - :name: provstatus +ProvStatus +~~~~~~~~~~ Provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems. @@ -3888,8 +3876,8 @@ Contains Enumeration Literals: - CAPPED: - 59. .. rubric:: VnfSource - :name: vnfsource +VnfSource +~~~~~~~~~ Describes the source of the indicator. @@ -3901,8 +3889,8 @@ Contains Enumeration Literals: - BOTH: - 60. .. rubric:: VnicType - :name: vnictype +VnicType +~~~~~~~~ Describes the type of VNIC to which a CP attaches. @@ -3918,18 +3906,4 @@ Contains Enumeration Literals: - DIRECT_PHYSICAL: -- VIRTIO_FORWARDER: - - 5. .. rubric:: Primitives - :name: primitives - - 6. .. rubric:: Interfaces - :name: interfaces - -7. .. rubric:: Signals - :name: signals - -8. .. rubric:: Operations - :name: operations - - +- VIRTIO_FORWARDER:
\ No newline at end of file diff --git a/docs/ONAP Model Spec/im/index.rst b/docs/ONAP Model Spec/im/index.rst index b109321..ccb28f9 100644 --- a/docs/ONAP Model Spec/im/index.rst +++ b/docs/ONAP Model Spec/im/index.rst @@ -12,7 +12,8 @@ ONAP Information Model Specifications .. toctree:: :titlesonly: + Root VnfdAndVnfInstance NSD Service - NSD1 + BusinessInteraction |