From e9d4fc1e6ea5f43811d068db48c3f6847cf0dd66 Mon Sep 17 00:00:00 2001 From: yxpoke Date: Sun, 24 May 2020 22:56:59 +0800 Subject: R6 Model Spec Update Change-Id: I569b33a64bbae425eaec5fa939c57f69ea7e1ed8 Issue-ID: MODELING-363 Signed-off-by: yxpoke --- docs/ONAP Model Spec/im/BusinessInteraction.rst | 574 --- .../im/Common/BusinessInteraction.png | Bin 0 -> 144917 bytes .../im/Common/BusinessInteraction.rst | 582 +++ .../im/Common/DynamicParameters.png | Bin 0 -> 456495 bytes .../im/Common/DynamicParameters.rst | 492 +++ .../im/Common/SelectionCriteria.png | Bin 0 -> 375760 bytes .../im/Common/SelectionCriteria.rst | 252 ++ docs/ONAP Model Spec/im/License/Entitlements.png | Bin 0 -> 42189 bytes docs/ONAP Model Spec/im/License/License.png | Bin 0 -> 50476 bytes docs/ONAP Model Spec/im/License/LicenseKey.png | Bin 0 -> 39933 bytes docs/ONAP Model Spec/im/License/LicenseModel.rst | 1033 +++++ docs/ONAP Model Spec/im/License/RootHierarchy.png | Bin 0 -> 48264 bytes docs/ONAP Model Spec/im/License/RootingLicense.png | Bin 0 -> 41320 bytes docs/ONAP Model Spec/im/NSD.rst | 686 ---- docs/ONAP Model Spec/im/NSD/NSD.png | Bin 0 -> 159420 bytes docs/ONAP Model Spec/im/NSD/NSD.rst | 688 ++++ docs/ONAP Model Spec/im/NSDR4.PNG | Bin 159420 -> 0 bytes .../im/Nested Service final for Rst.PNG | Bin 179392 -> 0 bytes docs/ONAP Model Spec/im/PNF/PNFD.rst | 388 ++ docs/ONAP Model Spec/im/PNFD.rst | 384 -- docs/ONAP Model Spec/im/Root.rst | 751 ---- docs/ONAP Model Spec/im/Root/Root.png | Bin 0 -> 421897 bytes docs/ONAP Model Spec/im/Root/Root.rst | 751 ++++ docs/ONAP Model Spec/im/Service/NestedService.png | Bin 0 -> 240092 bytes .../im/Service/ServiceModel-Nested Service.rst | 1380 +++++++ .../im/Service/ServiceModel-Service order.rst | 395 ++ docs/ONAP Model Spec/im/Service/ServiceOrder.png | Bin 0 -> 349690 bytes .../im/ServiceModel-Nested Service.rst | 613 --- .../im/ServiceModel-Service order.rst | 393 -- docs/ONAP Model Spec/im/ServiceOrderR4.PNG | Bin 349690 -> 0 bytes docs/ONAP Model Spec/im/VES index.rst | 14 - docs/ONAP Model Spec/im/VES/VES index.rst | 14 + docs/ONAP Model Spec/im/VNF/VNF-DF.png | Bin 0 -> 1319975 bytes docs/ONAP Model Spec/im/VNF/VNFD-topo.png | Bin 0 -> 2033901 bytes docs/ONAP Model Spec/im/VNF/VNFD.png | Bin 0 -> 1474238 bytes docs/ONAP Model Spec/im/VNF/VnfdAndVnfInstance.rst | 3927 ++++++++++++++++++++ docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst | 3909 ------------------- docs/ONAP Model Spec/im/index.rst | 21 +- docs/ONAP Model Spec/index.rst | 2 +- docs/Release-notes/index.rst | 15 - docs/Release-notes/release-notes.rst | 45 +- docs/index.rst | 2 +- 42 files changed, 9953 insertions(+), 7358 deletions(-) delete mode 100644 docs/ONAP Model Spec/im/BusinessInteraction.rst create mode 100644 docs/ONAP Model Spec/im/Common/BusinessInteraction.png create mode 100644 docs/ONAP Model Spec/im/Common/BusinessInteraction.rst create mode 100644 docs/ONAP Model Spec/im/Common/DynamicParameters.png create mode 100644 docs/ONAP Model Spec/im/Common/DynamicParameters.rst create mode 100644 docs/ONAP Model Spec/im/Common/SelectionCriteria.png create mode 100644 docs/ONAP Model Spec/im/Common/SelectionCriteria.rst create mode 100644 docs/ONAP Model Spec/im/License/Entitlements.png create mode 100644 docs/ONAP Model Spec/im/License/License.png create mode 100644 docs/ONAP Model Spec/im/License/LicenseKey.png create mode 100644 docs/ONAP Model Spec/im/License/LicenseModel.rst create mode 100644 docs/ONAP Model Spec/im/License/RootHierarchy.png create mode 100644 docs/ONAP Model Spec/im/License/RootingLicense.png delete mode 100644 docs/ONAP Model Spec/im/NSD.rst create mode 100644 docs/ONAP Model Spec/im/NSD/NSD.png create mode 100644 docs/ONAP Model Spec/im/NSD/NSD.rst delete mode 100644 docs/ONAP Model Spec/im/NSDR4.PNG delete mode 100644 docs/ONAP Model Spec/im/Nested Service final for Rst.PNG create mode 100644 docs/ONAP Model Spec/im/PNF/PNFD.rst delete mode 100644 docs/ONAP Model Spec/im/PNFD.rst delete mode 100644 docs/ONAP Model Spec/im/Root.rst create mode 100644 docs/ONAP Model Spec/im/Root/Root.png create mode 100644 docs/ONAP Model Spec/im/Root/Root.rst create mode 100644 docs/ONAP Model Spec/im/Service/NestedService.png create mode 100644 docs/ONAP Model Spec/im/Service/ServiceModel-Nested Service.rst create mode 100644 docs/ONAP Model Spec/im/Service/ServiceModel-Service order.rst create mode 100644 docs/ONAP Model Spec/im/Service/ServiceOrder.png delete mode 100644 docs/ONAP Model Spec/im/ServiceModel-Nested Service.rst delete mode 100644 docs/ONAP Model Spec/im/ServiceModel-Service order.rst delete mode 100644 docs/ONAP Model Spec/im/ServiceOrderR4.PNG delete mode 100644 docs/ONAP Model Spec/im/VES index.rst create mode 100644 docs/ONAP Model Spec/im/VES/VES index.rst create mode 100644 docs/ONAP Model Spec/im/VNF/VNF-DF.png create mode 100644 docs/ONAP Model Spec/im/VNF/VNFD-topo.png create mode 100644 docs/ONAP Model Spec/im/VNF/VNFD.png create mode 100644 docs/ONAP Model Spec/im/VNF/VnfdAndVnfInstance.rst delete mode 100644 docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst delete mode 100644 docs/Release-notes/index.rst (limited to 'docs') diff --git a/docs/ONAP Model Spec/im/BusinessInteraction.rst b/docs/ONAP Model Spec/im/BusinessInteraction.rst deleted file mode 100644 index 820c82e..0000000 --- a/docs/ONAP Model Spec/im/BusinessInteraction.rst +++ /dev/null @@ -1,574 +0,0 @@ -.. 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/Common/BusinessInteraction.png b/docs/ONAP Model Spec/im/Common/BusinessInteraction.png new file mode 100644 index 0000000..08977ed Binary files /dev/null and b/docs/ONAP Model Spec/im/Common/BusinessInteraction.png differ diff --git a/docs/ONAP Model Spec/im/Common/BusinessInteraction.rst b/docs/ONAP Model Spec/im/Common/BusinessInteraction.rst new file mode 100644 index 0000000..3f287a8 --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/BusinessInteraction.rst @@ -0,0 +1,582 @@ +.. 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 +.. + +Diagram +------- + +Business Interaction +^^^^^^^^^^^^^^^^^^^^ + +.. image:: BusinessInteraction.png + +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/Common/DynamicParameters.png b/docs/ONAP Model Spec/im/Common/DynamicParameters.png new file mode 100644 index 0000000..b7d41f8 Binary files /dev/null and b/docs/ONAP Model Spec/im/Common/DynamicParameters.png differ diff --git a/docs/ONAP Model Spec/im/Common/DynamicParameters.rst b/docs/ONAP Model Spec/im/Common/DynamicParameters.rst new file mode 100644 index 0000000..17d1a7e --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/DynamicParameters.rst @@ -0,0 +1,492 @@ +.. Copyright 2020 +.. 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 + +Dynamic Parameters Model +======================== + +Diagrams +-------- + +.. image:: DynamicParameters.png + +Dynamic Parameters +~~~~~~~~~~~~~~~~~~~ + +Classes +------- + +DiscreteValueSpec +~~~~~~~~~~~~~~~~~ + +DiscreteValueSpec represents a specific valid value that a given Parameter can take on. + +**Parent class:** ParmSpecValue + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +================== ======== ========= ================================== ================================================ +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +value String 1 Preliminary A discrete value that the Parameter can take on. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ================================================ + +Parameter +~~~~~~~~~ + +Some parameter that is part of a ParameterGroup. If parameter can only hold certain values, those values are specified via ParameterSpecValue (design time). The actual value is specified via ParameterValue (runtime). + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +================== ============== ========= ================================== ================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +parameterName String 1 Preliminary Name of parameter. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +IsInput Boolean 1 Preliminary Boolean that specifices if this parameter is an input parameter. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +paramvalue ParameterValue 0..\* OpenModelAttribute Parameter can have some number of runtime ParameterValues. Each ParameterValue is also associated with some OperationalEntity (VnfInstance, ServiceInstance, ...). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +isModifiable Boolean 1 Preliminary Bolean that specifices if the value can be modified or changed during the life of this parameter. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +valueType String 1 Preliminary The type of this parameter (integer, string, ...). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +unitOfMeasure String 0..1 Preliminary A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 1 Preliminary Description of the parameter. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ============== ========= ================================== ================================================================================================================================================================================================================================================================================================================== + +ParameterGroup +~~~~~~~~~~~~~~ + +A group of parameters that somehow relate or work together. + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +========================= ========== ========= ================================== ============================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +parameterGroupName String 1 Preliminary Name of ParameterGroup + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +parameterGroupDescription String 1 Preliminary Description of ParameterGroup. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +parameterGroupId Identifier 1 Preliminary ID of ParameterGroup. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================= ========== ========= ================================== ============================== + +ParameterValue +~~~~~~~~~~~~~~ + +The actual value of Parameter (runtime). + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +================== ========= ========= ================================== =========================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +parameter Parameter 1 OpenModelAttribute Runtime ParameterValue is associated with exactly one Parameter. Parameter can have some number of runtime ParameterValues. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +value String 1 Preliminary The actual value of Parameter (runtime). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ========= ========= ================================== =========================================================================================================================== + +ParmSpecValue +~~~~~~~~~~~~~ + +A valid value of parameter (design time). Values can be either a range (RangeValueSpec) or discrete (DiscreteValueSpec). + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +RangeValueSpec +~~~~~~~~~~~~~~ + +RangeValueSpec is generally expected to be of valueType integer or + +RangeValueSpec generally should have a valueType of either integer or real. valueFrom, valueTo, and rangeStep should all be of the same valuetype for some Parameter. + +rangeStep should be greater than zero. + +valueTo should be greater than valueFrom + +**Parent class:** ParmSpecValue + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +================== ======== ========= ================================== ============================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +valueMin String 1 Preliminary The minimum value that a Parameter can take on. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +valueMax String 1 Preliminary The maximum value that the parameter can take on. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +rangeStep String 0..1 Preliminary The specification that a range of values increases in steps, such as a range from 0 to 100 in steps of 5 with the resulting permitted values being 0, 5, 10, 15,...100. This complements the valueFrom and valueTo attributes. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ============================================================================================================================================================================================================================== + +Associations +------------ + +ParameterGroupHasParameter +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A Parameter can be in more than one ParameterGroup, and a ParameterGroup can have some number of Parameters. + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +parameter shared Not navig. 1..\* Parameter OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +dynamicparameter none Not navig. 0..\* ParameterGroup OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== =============== ===================== + +ParameterHasInstanceValue +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============== ================================================================================================================================================================== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +paramvalue composite Navig. 0..\* ParameterValue Parameter can have some number of runtime ParameterValues. Each ParameterValue is also associated with some OperationalEntity (VnfInstance, ServiceInstance, ...). OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +parameter none Navig. 1 Parameter Runtime ParameterValue is associated with exactly one Parameter. Parameter can have some number of runtime ParameterValues. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== ================================================================================================================================================================== ===================== + +OperationalEntityFurtherDefinedByParam +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ================= =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +dynamicparamvalue none Not navig. 0..\* ParameterValue OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +operationalentity none Not navig. 1 OperationalEntity OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ================= =============== ===================== + +DesignEntityFurtherDefinedByParmGroup +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +dynamicparameter none Not navig. 0..\* ParameterGroup OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +designentity none Not navig. 0..\* DesignEntity OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== =============== ===================== + +ParmSpecValueIntantiatedAsDynamicParmValue +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_parametervalue none Not navig. 0..\* ParameterValue OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +parmspecvalueii none Not navig. 0..1 ParmSpecValue OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== =============== ===================== + +ParameterEnumeratedBy SpecValue +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ============= =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +parameter none Not navig. 1 Parameter OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +parmspecvalueii composite Not navig. 0..\* ParmSpecValue OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============= =============== ===================== diff --git a/docs/ONAP Model Spec/im/Common/SelectionCriteria.png b/docs/ONAP Model Spec/im/Common/SelectionCriteria.png new file mode 100644 index 0000000..70d709a Binary files /dev/null and b/docs/ONAP Model Spec/im/Common/SelectionCriteria.png differ diff --git a/docs/ONAP Model Spec/im/Common/SelectionCriteria.rst b/docs/ONAP Model Spec/im/Common/SelectionCriteria.rst new file mode 100644 index 0000000..5452faa --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/SelectionCriteria.rst @@ -0,0 +1,252 @@ +.. Copyright 2020 +.. 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 + +Selection Criteria Model +======================== + +Diagrams +-------- + +SelectionCriteria +~~~~~~~~~~~~~~~~~~ + +.. image:: SelectionCriteria.png + +Classes +------- + +.. _selectioncriteria-1: + +SelectionCriteria +~~~~~~~~~~~~~~~~~ + +SelectionCriteria finds descriptors and instances according to specific properties of those entities. + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +=================== ========== ========= ================================== ============================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +SelectionCriteriaId Identifier 1 Preliminary Unique indentifier of this SelectionCriteria. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ========== ========= ================================== ============================================= + +SelectionCriteriaAtomic +~~~~~~~~~~~~~~~~~~~~~~~ + +A simple (atomic) selection criteria that holds a specific attribute comparision expression. + +**Parent class:** SelectionCriteria + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +=================== ========== ========= ================================== ================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +metricName String 1 Preliminary Name of compared parameter or attribute. + + OpenModelAttribute Name of compared parameter or attribute. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +operator Operator 1 Preliminary Comparison operator, e.g. equal, less than, greater or etc. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +value String 1 Preliminary Compared value (can be a name of a parameter in referenced class). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +valueType String 1 Preliminary The type of the value property (String, Integer, Real, ...). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +SelectionCriteriaId Identifier 1 Preliminary Unique indentifier of this SelectionCriteria. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ========== ========= ================================== ================================================================== + +SelectionCriteriaComposite +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A SelectionCriteria that is an aggregation of multiple selection criterias. Agregation can be for example AND, OR, or XOR logical operations. + +**Parent class:** SelectionCriteria + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +=================== ================= ========= ================================== ===================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +compositeOperator CompositeOperator 1 Preliminary Logical operation for filters composition, e.g. logical AND, OR, XOR. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +SelectionCriteriaId Identifier 1 Preliminary Unique indentifier of this SelectionCriteria. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ================= ========= ================================== ===================================================================== + +Associations +------------ + +DesignEntityHasSelectionCriteria +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +================== =========== ========== ========= ================= =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +designentity none Not navig. 0..\* DesignEntity OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +selectioncriteria none Not navig. 0..\* SelectionCriteria OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ================= =============== ===================== + +SelectionCriteriaCompositeComprisedOfSelectionCriteria +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +========================== =========== ========== ========= ========================== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +selectioncriteria shared Not navig. 2..\* SelectionCriteria OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +selectioncriteriacomposite none Not navig. 0..\* SelectionCriteriaComposite OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +========================== =========== ========== ========= ========================== =============== ===================== + +Enumerations +------------ + +CompositeOperator +~~~~~~~~~~~~~~~~~ + +The operator being applied to to some group of selectoin critiera. + +Contains Enumeration Literals: + +- AND: + +- OR: + +- XOR: + +Operator +~~~~~~~~ + +The operator being applied to some atomic selection critera. + +Contains Enumeration Literals: + +- MORETHAN: + +- LESSTHAN: + +- EQUAL: diff --git a/docs/ONAP Model Spec/im/License/Entitlements.png b/docs/ONAP Model Spec/im/License/Entitlements.png new file mode 100644 index 0000000..a5289f6 Binary files /dev/null and b/docs/ONAP Model Spec/im/License/Entitlements.png differ diff --git a/docs/ONAP Model Spec/im/License/License.png b/docs/ONAP Model Spec/im/License/License.png new file mode 100644 index 0000000..6832518 Binary files /dev/null and b/docs/ONAP Model Spec/im/License/License.png differ diff --git a/docs/ONAP Model Spec/im/License/LicenseKey.png b/docs/ONAP Model Spec/im/License/LicenseKey.png new file mode 100644 index 0000000..157abae Binary files /dev/null and b/docs/ONAP Model Spec/im/License/LicenseKey.png differ diff --git a/docs/ONAP Model Spec/im/License/LicenseModel.rst b/docs/ONAP Model Spec/im/License/LicenseModel.rst new file mode 100644 index 0000000..533dd2f --- /dev/null +++ b/docs/ONAP Model Spec/im/License/LicenseModel.rst @@ -0,0 +1,1033 @@ +.. Copyright 2020 +.. 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 + +License Management Model +======================== + +Diagrams +-------- + +Root Entity Hierarchy +~~~~~~~~~~~~~~~~~~~~~~ + +.. image:: RootHierarchy.png + +License +~~~~~~~~ + +.. image:: License.png + +Rooting License +~~~~~~~~~~~~~~~~ + +.. image:: RootingLicense.png + +License Keys +~~~~~~~~~~~~ + +.. image:: LicenseKey.png + +Entitlements +~~~~~~~~~~~~~ + +.. image:: Entitlements.png + +Classes +------- + +EntitlementPool +~~~~~~~~~~~~~~~ + +Note: description is required according to the inherited attribute, but it presently is optional. + +An EntitlementPool is created for each type of Entitlement that is required for the VNFs. Each Entitlement Pool is assigned a Name and Description for modeling purposes and is uniquely identified by a UUID. In addition, a list of characteristics of the Entitlement Pool are defined. +An EntitlementPool is not specific to a Feature Group. An Entitlement Pool may be related to multiple Feature Groups containing a VNF or even to multiple VNFs. +Purchased entitlements are inventoried in the Entitlement Pools. +Multiple pools for the same type of entitlement may be created based on the constraints. + +**Parent class:** DesignEntity + +Applied stereotypes: + +- Reference + +- **reference: As Built in SDC; Not related to any release usecase.** + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +===================================== ================= ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +\_spPoolLimit PoolLimit 0..\* OpenModelAttribute Pool limits applied by the service provider + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_vendorPoolLimit PoolLimit 0..\* OpenModelAttribute Pool limits applied by the vendor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +entitlementManufactureReferenceNumber String 0..1 OpenModelAttribute Reference number for the entitlement as described by the vendor in their price list / catalog /contract. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +entitlementPurchaseIncrements Integer 0..1 OpenModelAttribute This field contains information to tell a Designer how the entitlement must be purchased. For example, if the entitlement must be purchased in blocks of 1000, the increment would be 1000. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +entitlementPoolThresholdValue Integer 0..1 OpenModelAttribute A description of a threshold that will be assessed for some business purpose (e.g. 20% of entitlement pool remains available). (The threshold of interest to DCAE or Capacity Planning, etc.) This may be an absolute value or a percentage. For example: + when 90% of the pool is in-use, trigger an additional purchase of inventory. + - isInvariant: false + A description of a threshold that will be assessed for some business purpose (e.g. 20% of entitlement pool remains available). (The threshold of interest to DCAE or Capacity Planning, etc.) This may be an absolute value or a percentage. For example: + - valueRange: no range constraint when 90% of the pool is in-use, trigger an additional purchase of inventory. + + - support: MANDATORY + + Preliminary +entitlementPoolThresholdUnits ThresholdUnitType 0..1 OpenModelAttribute Specifies the Units for the ThresholdValue. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +invariantId Identifier 1 OpenModelAttribute Identifier that stays the same irrespective of version. + + - isInvariant: false Identifier that stays the same irrespective of version. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +Version String 1 OpenModelAttribute The version of this entity. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +poolType LicenseGroupType 1 OpenModelAttribute The license key may be 'universal' or 'unique' or 'one-time'. + - A 'universal' value indicates that the same exact license key (string) may be associated with all instances of the VNF. + - isInvariant: false - A 'unique' value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may be returned to the license key pool for reuse. + - A 'one-time' value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may not be reused. + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +validFor TimePeriod 0..1 Preliminary The period during which the design entity is valid. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +status String 1 Preliminary The condition of the specification, such s active, inactive, or planned. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary 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 + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 1 Preliminary Defines a textual free-form description of the object. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +===================================== ================= ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +FeatureGroup +~~~~~~~~~~~~ + +Feature groups represent a set of the features of one or more VNFs. Feature groups may be defined by the vendor and/or by the service provider. A VNF may be related to multiple feature groups. At least one feature group will be related to a VNF. If no sub-sets are needed, a single feature group will be defined that represents the base or core capabilities of the VNF(s) in it. +If an Entitlement Pool or License Key Group is associated with a particular Feature Group, the Feature Group becomes a "constraint" for the pool/group. + +Applied stereotypes: + +- Reference + +- **reference: As Built in SDC; Not related to any release usecase.** + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +======================= ======== ========= ================================== ====================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +featureGroupName String 1 OpenModelAttribute Name of the feature group + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +featureGroupDescription String 0..1 OpenModelAttribute Description of the feature group. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +featureGroupPartNumber String 1 OpenModelAttribute The featureGroupPartNumber specifies the Vnf that this FeatureGroup is related to. + + - isInvariant: false The featureGroupPartNumber specifies the SKU or reference number that the Vendor has for the Vnf that this FeatureGroup is related to. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +======================= ======== ========= ================================== ====================================================================================================================================== + +LicenseAgreement +~~~~~~~~~~~~~~~~ + +An agreement between the service provider and a given vendor granting the service provider to use the vendor's products. Generally the license agreement is specific to a family of vendor products and/or to some service provider's project/product or product family. + +**Parent class:** Agreement + +Applied stereotypes: + +- Reference + +- **reference: As Built in SDC; Not related to any release usecase.** + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +========================== =========== ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +requirementsAndConstraints String 1..\* OpenModelAttribute Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules. + + - isInvariant: false Free form text. Includes information such as operating system or hypervisor required for the VNF. This may also contain factors to be considered in deployment/placement of the VNF instances. These requirements and constraints may need to be abstracted as policies or other business rules. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +licenseTerm LicenseTerm 1 OpenModelAttribute Term of the license: + -fixed term + - isInvariant: false -perpetual + -unlimited + - valueRange: no range constraint -subscription + + - support: MANDATORY + + Preliminary +documentNumber String 1 Preliminary A reference number assigned to an Agreement that follows a prescribed numbering system. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +statementOfIntent String 1 Preliminary An overview and goals of the Agreement. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +StartDate DateTime 1 Preliminary Date interaction initiated + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +endDate DateTime 1 Preliminary The date on which an interaction is closed or completed. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Status String 0..1 Preliminary The current condition of an interaction, such as open, in research, closed, and so forth + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 0..1 Preliminary 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 + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Preliminary Defines a textual free-form description of the object. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================== =========== ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +LicenseKeyPool +~~~~~~~~~~~~~~ + +A License Key Pool is created for each type of License Key that is required for the VNF. +Each License Key Pool is assigned a Name and Description for modeling purposes and is uniquely identified by a UUID. In addition, a list of characteristics of the License Key Pool are defined. +The license key Pool model provides a description to interested systems for the license keys that are provided by a vendor. +A license key Pool is not specific to a feature group. A license key Pool may be related to multiple feature groups that a VNF belongs to or even to multiple VNFs. + +**Parent class:** DesignEntity + +Applied stereotypes: + +- Reference + +- **reference: As Built in SDC; Not related to any release usecase.** + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================================= ================= ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +\_spPooLlimit PoolLimit 0..\* OpenModelAttribute Pool limits applied by the service provider + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_vendorPoollimit PoolLimit 0..\* OpenModelAttribute Pool limits applied by the vendor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +poolType LicenseGroupType 1 OpenModelAttribute The license key may be 'universal' or 'unique' or 'one-time'. + - A 'universal' value indicates that the same exact license key (string) may be associated with all instances of the VNF. + - isInvariant: false - A 'unique' value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may be returned to the license key pool for reuse. + - A 'one-time' value indicates that each instance of the VNF must be related to a unique license key (string). When no longer needed, the key may not be reused. + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +thresholdUnits ThresholdUnitType 0..1 OpenModelAttribute Units can be either absolute or a percentage (%). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +thresholdValue Integer 0..1 OpenModelAttribute Specified threshold value for the license key pool. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +keyPurchaseIncrements String 0..1 OpenModelAttribute Specifies how the key must be purchased. If in blocks of 1000, the increment would be 1000. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +invariantId Identifier 1 OpenModelAttribute Identifier that stays the same irrespective of version. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +Version String 1 OpenModelAttribute The version of this entity. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +licenseManufactureReferenceNumber String 0..1 OpenModelAttribute Identifier for the entitlement as described by the vendor in their price list / catalog /contract. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +validFor TimePeriod 0..1 Preliminary The period during which the design entity is valid. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +status String 1 Preliminary The condition of the specification, such s active, inactive, or planned. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 1 Preliminary 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 + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 1 Preliminary Defines a textual free-form description of the object. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id Identifier 1 Preliminary Identifier of this information element. This attribute shall be globally unique. + + OpenModelAttribute Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================================= ================= ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +PoolLimit +~~~~~~~~~ + +A variable set of values that identify the limits that may be imposed by an entitlement instance in the pool. Multiple constraints may be applicable for an instance of entitlement in the pool. For example, an entitlement based on GB and number of sessions. Increments, aggregation function, time scope, threshold value may repeat for each metric in the list. +Limits can be applied by the vendor or the service provider. + +Applied stereotypes: + +- Reference + +- **reference: As Built in SDC; Not related to any release usecase.** + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +=================== ================ ========= ================================== =================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +limitMetricType EPMetricType 1 OpenModelAttribute Specifies if this pool holds entitlements based on usage of the VNF instance (number of users), number of sessions, country, line of business, etc. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +limitMetricValue Integer 1 OpenModelAttribute The value of some limit being applied. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +aggregationFunction AggregationTypes 0..1 OpenModelAttribute Type of aggregation being performed (Peak or Average) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +limitUnits LimitUnits 1 OpenModelAttribute The units of the limit (Trunks, Users, Subscribers, Sessions, tentants, Tokens, Seats, TB, GB, MB, ...) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +time DateTime 0..1 OpenModelAttribute Units time is specified in (day, month, hour, minute, second, millisecond. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +poolMetricTypeOther String 0..1 OpenModelAttribute LimitMetricType if Other enumeration is selected. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +=================== ================ ========= ================================== =================================================================================================================================================== + +Associations +------------ + +LicenseKeyPoolHasSPLimits +~~~~~~~~~~~~~~~~~~~~~~~~~ + +LicenseKey can have some number of service provider based limits applied to it. + +Applied stereotypes: + +================== =========== ========== ========= ============== ============================================================================= ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_spPooLlimit composite Navig. 0..\* PoolLimit Pool limits applied by the service provider OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +licencekeypool none Not navig. 1 LicenseKeyPool lLicenseKeyPool can have some number of service provider specified PoolLimits OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== ============================================================================= ===================== + +LicenseKeyPoolHasVendorLimits +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +LicenseKey can have some number of vendor based limits applied to it. + +Applied stereotypes: + +================== =========== ========== ========= ============== ================================== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_vendorPoollimit composite Navig. 0..\* PoolLimit Pool limits applied by the vendor. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +licencekeypooldesc none Not navig. 1 LicenseKeyPool OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== ================================== ===================== + +EntitlementPoolHasSPPoolLimits +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +An EntitlementPool and the associated Entitlements can have some number of Service Provider based limits. + +Applied stereotypes: + +================== =========== ========== ========= =============== ========================================================================== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_spPoolLimit composite Navig. 0..\* PoolLimit Pool limits applied by the service provider OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +entitlementpool none Not navig. 1 EntitlementPool EntitlementPool can have some number of service provider specified limits. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= =============== ========================================================================== ===================== + +EntitlementPoolHasVendorPoolLimits +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +An EntitlementPool and the associated Entitlements can have some number of Vendor based limits. + +Applied stereotypes: + +================== =========== ========== ========= =============== ==================================================================== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_vendorPoolLimit composite Navig. 0..\* PoolLimit Pool limits applied by the vendor. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +entitlementpool none Not navig. 1 EntitlementPool The EntitlementPool can have some number of Vendor specified limits. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= =============== ==================================================================== ===================== + +FeatureGroupHasEntitlementPool +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A FeatureGroup can have one or more EntitlementPools associated with it. + +Applied stereotypes: + +================== =========== ========== ========= =============== =============================================================== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +entitlementpool none Not navig. 1..\* EntitlementPool The EntitlementPool can be related to one FeatureGroup OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +featuregroup none Not navig. 0..\* FeatureGroup FeatureGroup can be related to some number of EntitlementPools. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= =============== =============================================================== ===================== + +FeatureGroupHasLicenceKeyPool +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +FeatureGroup can have 1 or more LicenseKeyPools and related LicenseKeys related to it. + +Applied stereotypes: + +================== =========== ========== ========= ============== ================================================================ ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +licencekeypool none Not navig. 0..\* LicenseKeyPool LicenseKeyPool is related to one FeatureGroup OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +featuregroup none Not navig. 0..\* FeatureGroup A feature group can be related to some number of LicenseKeyPools OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============== ================================================================ ===================== + +LicenseAgreementHasFeatureGroup +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +================== =========== ========== ========= ================ =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +featuregroup none Not navig. 1..\* FeatureGroup OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +licenseagreement none Not navig. 1..\* LicenseAgreement OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ================ =============== ===================== + +VendorHasVnfd +~~~~~~~~~~~~~ + +Applied stereotypes: + +================== =========== ========== ========= ======== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +vendor none Not navig. 1 Vendor +vnfd none Not navig. 0..\* Vnfd OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ======== =============== ===================== + +VendorHasLicenseAgreement +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +================== =========== ========== ========= ================ =================================================== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +vendor none Not navig. 1 Vendor A Vendor can have some number of LicenseAgreements. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +licenseagreement none Not navig. 0..\* LicenseAgreement A LicenseAgreement is related to some vendor. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ================ =================================================== ===================== + +VnfHasFeatureGroup +~~~~~~~~~~~~~~~~~~ + +A Vnf can have some number of feature groups. A feature group can apply to one or more Vnfs. + +Applied stereotypes: + +================== =========== ========== ========= ============ =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +featuregroup none Not navig. 0..\* FeatureGroup +vnfd none Not navig. 1..\* Vnfd OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +================== =========== ========== ========= ============ =============== ===================== + +Data Types +---------- + +Enumerations +------------ + +AggregationTypes +~~~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- PEAK: + +- AVERAGE: + +EPMetricType +~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- BWTH: + +- COUNTRY: + +- SESSION: + +- LOB: + +- SITE: + +- USAGE: + +- OTHER: + +LicenseDuration +~~~~~~~~~~~~~~~ + +Units of the entitlement/license term. Valid values: year, quarter, month, day. + +Contains Enumeration Literals: + +- YEAR: + +- QUARTER: + +- MONTH: + +- DAY: + +LicenseGroupType +~~~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- UNIVERSAL: + +- UNIQUE: + +- ONE_TIME: + +LicenseTerm +~~~~~~~~~~~ + +Valid values: +year, quarter, month, day. +Not applicable when license type is Perpetual. + +Contains Enumeration Literals: + +- FIXED_TERM: + +- PERPETUAL: + +- UNLIMITED: + +- OTHER: + +- TRIAL: + +- SUBSCRIPTION: + +LimitUnits +~~~~~~~~~~ + +Contains Enumeration Literals: + +- TRUNKS: + +- USERS: + +- SUBSCRIBERS: + +- SESSIONS: + +- TENANTS: + +- TOKENS: + +- SEATS: + +- TB: + +- GB: + +- MB: + +- OTHER: + +ThresholdUnitType +~~~~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- ABSOLUTE: + +- %: diff --git a/docs/ONAP Model Spec/im/License/RootHierarchy.png b/docs/ONAP Model Spec/im/License/RootHierarchy.png new file mode 100644 index 0000000..b5accd3 Binary files /dev/null and b/docs/ONAP Model Spec/im/License/RootHierarchy.png differ diff --git a/docs/ONAP Model Spec/im/License/RootingLicense.png b/docs/ONAP Model Spec/im/License/RootingLicense.png new file mode 100644 index 0000000..e01ff53 Binary files /dev/null and b/docs/ONAP Model Spec/im/License/RootingLicense.png differ diff --git a/docs/ONAP Model Spec/im/NSD.rst b/docs/ONAP Model Spec/im/NSD.rst deleted file mode 100644 index 2d4469a..0000000 --- a/docs/ONAP Model Spec/im/NSD.rst +++ /dev/null @@ -1,686 +0,0 @@ -.. Copyright 2018 (China Mobile) -.. 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 - -.. contents:: - :depth: 3 -.. - -|image0| - -NetworkServiceDescriptorModel -=============================== - - -NetworkServiceDescriptor ------------------------- - -The NSD class is a deployment template whose instances are used by the -NFVO for the lifecycle management of NSs. For all attributes in this -class, the Producer is SDC and the Consumer is SDC/UUI/VFC - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Preliminaryry - -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| **AttributeName** | **Type** | **Mult.** | **Stereotypes** | **Description**| -| | | | | | -+==========================+============================+=============+===================+================+ -| nsdIdentifier | Identifier | 1 | Preliminary | Identifier | -| | | | | of this NSD | -| | | | OpenModelAttribute| class. It | -| | | | | globally | -| | | | | uniquely | -| | | | - isInvariant: | identifies | -| | | | true | an instance | -| | | | | of the NSD. | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| designer | String | 1 | Preliminary | Identifies | -| | | | | the | -| | | | OpenModelAttribute| designer of | -| | | | | the NSD. | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| version | Version | 1 | Preliminary | Identifies | -| | | | | the version | -| | | | OpenModelAttribute| of the NSD. | -| | | | | | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| nsdName | String | 1 | Preliminary | Provides | -| | | | | the human | -| | | | OpenModelAttribute| readable | -| | | | | name of the | -| | | | | NSD. | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| nsdInvariantId | Identifier | 1 | Preliminary | Identifies | -| | | | | an NSD in a | -| | | | OpenModelAttribute| version | -| | | | | independent | -| | | | | manner. | -| | | | - isInvariant: | This | -| | | | false | attribute is | -| | | | | invariant | -| | | | - valueRange: | across | -| | | | no | versions of | -| | | | range | NSD. | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| autoScalingRule | Rule | 0..\* | Preliminary | Specifies a | -| | | | | rule to | -| | | | OpenModelAttribute| trigger a | -| | | | | scaling | -| | | | | action on a | -| | | | - isInvariant: | NS | -| | | | false | instantiated | -| | | | | according | -| | | | - valueRange: | to the NSD. | -| | | | no | NOTE 1: The | -| | | | range | rule is | -| | | | constraint | based on a | -| | | | | combination | -| | | | | of | -| | | | | assertions | -| | | | - support: | on the | -| | | | MANDATORY | values of | -| | | | | virtualised | -| | | | | resource- | -| | | | | related | -| | | | | performance | -| | | | | metrics and | -| | | | | VNF | -| | | | | Indicators | -| | | | | identified | -| | | | | by the | -| | | | | monitoredInfo | -| | | | | attribute. | -| | | | | NOTE 2: | -| | | | | There may | -| | | | | be multiple | -| | | | | data | -| | | | | sources | -| | | | | (each | -| | | | | identified | -| | | | | as | -| | | | | monitoredInfo) | -| | | | | per rule | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| monitoredInfo | MonitoredData | 0..\* | Preliminary | Identifies | -| | | | | either a | -| | | | OpenModelAttribute| virtualised | -| | | | | resource- | -| | | | | related | -| | | | - isInvariant: | performance | -| | | | false | metric or a | -| | | | | VNF | -| | | | | Indicator. | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| lifeCycleManagementScript| NsLifeCycleManagementScript| 0..\* | Preliminary | Provides a | -| | | | | life cycle | -| | | | OpenModelAttribute| management | -| | | | | script | -| | | | | written in | -| | | | - isInvariant: | a Domain | -| | | | false | Specific | -| | | | | Language | -| | | | - valueRange: | (DSL). | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| \_virtualLinkDesc | NsVirtualLinkDesc | 0..\* | Preliminary | Provides | -| | | | | the | -| | | | OpenModelAttribute| constituent | -| | | | | VLDs. | -| | | | | Cardinality | -| | | | - isInvariant: | of 0 means | -| | | | false | that the NS | -| | | | | is a NF set | -| | | | | with | -| | | | - valueRange: | unspecified | -| | | | no | connectivity. | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| \_vnfdId | Vnfd | 0..\* | Preliminary | References | -| | | | | the VNFD of | -| | | | OpenModelAttribute| a | -| | | | | constituent | -| | | | | VNF. | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -| | | | | | -| | | | PassedByReference | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ -| \_pnfdId | Pnfd | 0..\* | Experimental | References | -| | | | | the PNFD of | -| | | | | a | -| | | | OpenModelAttribute| constituent | -| | | | | PNF. | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -| | | | | | -| | | | PassedByReference | | -+--------------------------+----------------------------+-------------+-------------------+----------------+ - -NsVirtualLinkDesc ------------------ - -The NsVirtualLinkDesc class provides general information enabling the -instantiation of virtual links. For all attributes in this class the -Producer is SDC and the Consumer is SDC/UUI/VFC. - -**Parent class:** VirtualLinkDesc - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Preliminaryry - -+------------------------+-----------------+-------------+-------------------+----------------+ -| **Attribute Name** | **Type** | **Mult.** | **Stereotypes** | **Description**| -+========================+=================+=============+===================+================+ -| vitualLinkDescProvider | String | 0..1 | Preliminary | Defines the | -| | | | | organization | -| | | | OpenModelAttribute| generating | -| | | | | the VLD. | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+------------------------+-----------------+-------------+-------------------+----------------+ -| virtuaLinkDescVersion | Version | 1 | Preliminary | Specifies | -| | | | | the version | -| | | | OpenModelAttribute| of the VLD. | -| | | | | | -| | | | - isInvariant: | | -| | | | false | | -| | | | | | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+------------------------+-----------------+-------------+-------------------+----------------+ -| VirtualLinkDf | VirtualLinkDf | 1 | Preliminary | Specifies | -| | | | | properties | -| | | | OpenModelAttribute| for | -| | | | | instantiating | -| | | | - isInvariant: | a VL | -| | | | false | according | -| | | | | to a | -| | | | | specific | -| | | | - valueRange: | flavour. | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+------------------------+-----------------+-------------+-------------------+----------------+ -| virtualLinkDescId | Identifier | 1 | Preliminary | Uniquely | -| | | | | identifies | -| | | | OpenModelAttribute| a VLD in | -| | | | | the parent | -| | | | | descriptor. | -| | | | - isInvariant: | For | -| | | | false | VnfVirtualL | -| | | | | inkDesc, | -| | | | | the parent | -| | | | | descriptor | -| | | | - valueRange: | is the | -| | | | no | VNFD. For | -| | | | range | NsVirtualLi- | -| | | | constraint | nkDesc, | -| | | | | the parent | -| | | | | descriptor | -| | | | - support: | is the NSD. | -| | | | MANDATORY | Note: the | -| | | | | description | -| | | | | of this | -| | | | | class are | -| | | | | different | -| | | | | in ETSI GS | -| | | | | NFV IFA 011 | -| | | | | and ETSI GS | -| | | | | NFV IFA | -| | | | | 014. The | -| | | | | present | -| | | | | definition | -| | | | | merges the 2 | -| | | | | definitions. | -+------------------------+-----------------+-------------+-------------------+----------------+ -| connectivityType | ConnectivityType| 1 | Preliminary | Specifies | -| | | | | the | -| | | | OpenModelAttribute| protocol | -| | | | | exposed by | -| | | | | a VL and | -| | | | - isInvariant: | the flow | -| | | | false | pattern | -| | | | | supported | -| | | | | by the VL. | -| | | | - valueRange: | | -| | | | no | | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+------------------------+-----------------+-------------+-------------------+----------------+ -| description | String | 0..1 | Preliminary | Provides | -| | | | | human-readable | -| | | | OpenModelAttribute| information | -| | | | | on the | -| | | | - isInvariant: | purpose of | -| | | | false | the VL | -| | | | | (e.g. | -| | | | | control | -| | | | - valueRange: | plane | -| | | | no | traffic). | -| | | | range | | -| | | | constraint | | -| | | | | | -| | | | - support: | | -| | | | MANDATORY | | -+------------------------+-----------------+-------------+-------------------+----------------+ - -Pnfd ----- - -The Pnfd class is a deployment template enabling on-boarding PNFs and -referencing them from an NSD. It focuses on connectivity aspects only. - -**Parent class:** NetworkFunctionDesc - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Experimental - - - -Vnfd ----- - -The Vnfd class is a deployment template enabling on-boarding VNFs and -referencing them from an NSD. - - -ConnectivityType ----------------- - -The ConnectivityType datatype specifies the protocol exposed by a VL and -the flow pattern supported by the VL. - -+--------------+--------------+-----------+-----------+-------------------+----------------+ -| **Attribute | **Type** | **Mult.** | **Access**| **Stereotypes** | **Description**| -| Name** | | | | | | -+==============+==============+===========+===========+===================+================+ -| layerProtocol| LayerProtocol| 1 | RW | Preliminary | identifies | -| | | | | | the | -| | | | | OpenModelAttribute| protocol | -| | | | | | this VL | -| | | | | | gives | -| | | | | - isInvariant: | access to | -| | | | | false | (IPV4, IPV6). | -| | | | | | | -| | | | | - valueRange: | | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+--------------+--------------+-----------+-----------+-------------------+----------------+ -| flowPatternrn| String | 0..1 | RW | Preliminary | Identifies | -| | | | | | the flow | -| | | | | OpenModelAttribute| pattern | -| | | | | | of the | -| | | | | - isInvariant: | connectivity | -| | | | | false | (Line, | -| | | | | | Tree, | -| | | | | | Mesh). | -| | | | | - valueRange: | | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+--------------+--------------+-----------+-----------+-------------------+----------------+ - -MonitoredData(TBD) ------------------- - -The MonitoredData datatype identifies information to be monitored during -the lifetime of a network service instance. - -NsLifeCycleManagementScript ---------------------------- - -The LifeCycleManagementScript information element specifies a script for -the NS. - -+-------------+-----------+-----------+-----------+-------------------+----------------+ -| **Attribute | **Type** | **Mult.** | **Access**| **Stereotypes** | **Description**| -| Name** | | | | | | -+=============+===========+===========+===========+===================+================+ -| event | String | 1..\* | RW | OpenModelAttribute| Describes NS | -| | | | | | lifecycle | -| | | | | - isInvarriant: | event(s) | -| | | | | false | or an | -| | | | | | external | -| | | | | | stimulus | -| | | | | | detected | -| | | | | | on an | -| | | | | - valueRange: | NFVO | -| | | | | no | reference | -| | | | | range | point. | -| | | | | constraint | NOTE 1: A | -| | | | | | minimum | -| | | | | | set of NS | -| | | | | | lifecycle | -| | | | | - support: | events | -| | | | | | triggered | -| | | | | MANDATORY | internally | -| | | | | | by the NFVO | -| | | | | | includes: | -| | | | | | start | -| | | | | | instantiation, | -| | | | | | end | -| | | | | | instantiation, | -| | | | | | start | -| | | | | | scaling, | -| | | | | | end | -| | | | | | scaling, | -| | | | | | start | -| | | | | | healing, | -| | | | | | end | -| | | | | | healing, | -| | | | | | start | -| | | | | | termination, | -| | | | | | end | -| | | | | | termination, | -| | | | | | start | -| | | | | | update, | -| | | | | | end | -| | | | | | update. | -| | | | | | NOTE 2: A | -| | | | | | minimum | -| | | | | | set of | -| | | | | | external | -| | | | | | stimulus | -| | | | | | includes: | -| | | | | | the | -| | | | | | receipt | -| | | | | | of | -| | | | | | request | -| | | | | | message | -| | | | | | of | -| | | | | | instantiation, | -| | | | | | scaling, | -| | | | | | healing, | -| | | | | | termination, | -| | | | | | update of NS. | -+-------------+-----------+-----------+-----------+-------------------+----------------+ -| script | String | 1 | RW | OpenModelAttribute| Includes | -| | | | | | an NS LCM | -| | | | | | script | -| | | | | - isInvarriant: | (e.g., | -| | | | | false | written | -| | | | | | in a DSL) | -| | | | | | triggered | -| | | | | | to react | -| | | | | - valueRange: | to one of the | -| | | | | no | events | -| | | | | range | listed in | -| | | | | constraint | the event | -| | | | | | attribute. | -| | | | | - support: | | -| | | | | MANDATORY | | -+-------------+-----------+-----------+-----------+-------------------+----------------+ - -NsQoS ------ - -The NsQoS datatype specifies quality of service parameters applicable to -a NS VL. - -+---------------------+-----------+-----------+-----------+-------------------+----------------+ -| **Attribute Name** | **Type** | **Mult.** | **Access**|**Stereotypes** | **Description**| -+=====================+===========+===========+===========+===================+================+ -| priority | Integer | 0..1 | RW | Preliminary | Specifies | -| | | | | | the | -| | | | | | priority | -| | | | | OpenModelAttribute| level in | -| | | | | | case of | -| | | | | | congestion | -| | | | | - isInvariant: | on the | -| | | | | false | underlying | -| | | | | | physical | -| | | | | - valueRange: | links. | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+---------------------+-----------+-----------+-----------+-------------------+----------------+ -| latency | Number | 1 | RW | Preliminary | Maximum | -| | | | | | latency | -| | | | | | in ms. | -| | | | | OpenModelAttribute| | -| | | | | | | -| | | | | - isInvariant: | | -| | | | | false | | -| | | | | | | -| | | | | - valueRange: | | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+---------------------+-----------+-----------+-----------+-------------------+----------------+ -| packetDelayVariation| Number | 1 | RW | Preliminary | Maximum | -| | | | | | jitter in | -| | | | | | ms. | -| | | | | OpenModelAttribute| | -| | | | | | | -| | | | | - isInvariant: | | -| | | | | false | | -| | | | | | | -| | | | | - valueRange: | | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+---------------------+-----------+-----------+-----------+-------------------+----------------+ -| packetLossRatio | Number | 0..1 | RW | Preliminary | Maximum | -| | | | | | packet | -| | | | | | loss | -| | | | | OpenModelAttribute| ratio. | -| | | | | | Cardinality | -| | | | | - isInvariant: | is 0 if | -| | | | | false | no | -| | | | | | packetLossRatio| -| | | | | | requirement | -| | | | | - valueRange: | exists. | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+---------------------+-----------+-----------+-----------+-------------------+----------------+ - -VirtualLinkDf -------------- - -The VirtualLinkDf datatype specifies properties for instantiating a VL -according to a specific flavour. - -+-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ -| **Attribute Name** | **Type** | **Mult.** | **Access**|**Stereotypes** | **Description**| -+=======================+==========================+===========+===========+===================+================+ -| flavourId | Identifier | 1 | RW | Preliminary | Identifies | -| | | | | | this | -| | | | | OpenModelAttribute| VirtualLinkDF | -| | | | | | datatype | -| | | | | - isInvariant: | within a | -| | | | | false | VLD. | -| | | | | | | -| | | | | - valueRange: | | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ -| qos | NsQoS | 0..1 | RW | Preliminary | Specifies | -| | | | | | quality | -| | | | | | of | -| | | | | OpenModelAttribute| service | -| | | | | | parameters | -| | | | | - isInvariant: | applicable | -| | | | | false | to a VL. | -| | | | | | | -| | | | | - valueRange: | | -| | | | | no | | -| | | | | range | | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ -| serviceAvaibilityLevel| ServiceAvailabilityLevel | 0..1 | RW | Preliminary | Specifies | -| | | | | | one of | -| | | | | | the three | -| | | | | OpenModelAttribute| levels | -| | | | | | defined | -| | | | | | in ETSI | -| | | | | - isInvariant: | GS NFV-REL | -| | | | | false | 001: | -| | | | | | | -| | | | | | - Level1 | -| | | | | | | -| | | | | - valueRange: | - Level2 | -| | | | | no | | -| | | | | range | - Level3 | -| | | | | constraint | | -| | | | | | | -| | | | | - support: | | -| | | | | MANDATORY | | -+-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ - - - -ServiceAvailabilityLevel ------------------------- - -Specifies one of the three levels defined in ETSI GS NFV-REL 001: -Level 1 Level 2 Level 3 - -Contains Enumeration Literals: - -- LEVEL_1: - -- LEVEL_2: - -- LEVEL_3: - -.. |image0| image:: NSD1.PNG diff --git a/docs/ONAP Model Spec/im/NSD/NSD.png b/docs/ONAP Model Spec/im/NSD/NSD.png new file mode 100644 index 0000000..acd2c5d Binary files /dev/null and b/docs/ONAP Model Spec/im/NSD/NSD.png differ diff --git a/docs/ONAP Model Spec/im/NSD/NSD.rst b/docs/ONAP Model Spec/im/NSD/NSD.rst new file mode 100644 index 0000000..f8ce8df --- /dev/null +++ b/docs/ONAP Model Spec/im/NSD/NSD.rst @@ -0,0 +1,688 @@ +.. Copyright 2018 (China Mobile) +.. 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 + +NetworkServiceDescriptorModel +=============================== + +.. contents:: + :depth: 3 +.. + +Diagram +------- + +.. image:: NSD.png + +NetworkServiceDescriptor +------------------------ + +The NSD class is a deployment template whose instances are used by the +NFVO for the lifecycle management of NSs. For all attributes in this +class, the Producer is SDC and the Consumer is SDC/UUI/VFC + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + +- Preliminaryry + ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| **AttributeName** | **Type** | **Mult.** | **Stereotypes** | **Description**| +| | | | | | ++==========================+============================+=============+===================+================+ +| nsdIdentifier | Identifier | 1 | Preliminary | Identifier | +| | | | | of this NSD | +| | | | OpenModelAttribute| class. It | +| | | | | globally | +| | | | | uniquely | +| | | | - isInvariant: | identifies | +| | | | true | an instance | +| | | | | of the NSD. | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| designer | String | 1 | Preliminary | Identifies | +| | | | | the | +| | | | OpenModelAttribute| designer of | +| | | | | the NSD. | +| | | | | | +| | | | - isInvariant: | | +| | | | false | | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| version | Version | 1 | Preliminary | Identifies | +| | | | | the version | +| | | | OpenModelAttribute| of the NSD. | +| | | | | | +| | | | | | +| | | | - isInvariant: | | +| | | | false | | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| nsdName | String | 1 | Preliminary | Provides | +| | | | | the human | +| | | | OpenModelAttribute| readable | +| | | | | name of the | +| | | | | NSD. | +| | | | - isInvariant: | | +| | | | false | | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| nsdInvariantId | Identifier | 1 | Preliminary | Identifies | +| | | | | an NSD in a | +| | | | OpenModelAttribute| version | +| | | | | independent | +| | | | | manner. | +| | | | - isInvariant: | This | +| | | | false | attribute is | +| | | | | invariant | +| | | | - valueRange: | across | +| | | | no | versions of | +| | | | range | NSD. | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| autoScalingRule | Rule | 0..\* | Preliminary | Specifies a | +| | | | | rule to | +| | | | OpenModelAttribute| trigger a | +| | | | | scaling | +| | | | | action on a | +| | | | - isInvariant: | NS | +| | | | false | instantiated | +| | | | | according | +| | | | - valueRange: | to the NSD. | +| | | | no | NOTE 1: The | +| | | | range | rule is | +| | | | constraint | based on a | +| | | | | combination | +| | | | | of | +| | | | | assertions | +| | | | - support: | on the | +| | | | MANDATORY | values of | +| | | | | virtualised | +| | | | | resource- | +| | | | | related | +| | | | | performance | +| | | | | metrics and | +| | | | | VNF | +| | | | | Indicators | +| | | | | identified | +| | | | | by the | +| | | | | monitoredInfo | +| | | | | attribute. | +| | | | | NOTE 2: | +| | | | | There may | +| | | | | be multiple | +| | | | | data | +| | | | | sources | +| | | | | (each | +| | | | | identified | +| | | | | as | +| | | | | monitoredInfo) | +| | | | | per rule | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| monitoredInfo | MonitoredData | 0..\* | Preliminary | Identifies | +| | | | | either a | +| | | | OpenModelAttribute| virtualised | +| | | | | resource- | +| | | | | related | +| | | | - isInvariant: | performance | +| | | | false | metric or a | +| | | | | VNF | +| | | | | Indicator. | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| lifeCycleManagementScript| NsLifeCycleManagementScript| 0..\* | Preliminary | Provides a | +| | | | | life cycle | +| | | | OpenModelAttribute| management | +| | | | | script | +| | | | | written in | +| | | | - isInvariant: | a Domain | +| | | | false | Specific | +| | | | | Language | +| | | | - valueRange: | (DSL). | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| \_virtualLinkDesc | NsVirtualLinkDesc | 0..\* | Preliminary | Provides | +| | | | | the | +| | | | OpenModelAttribute| constituent | +| | | | | VLDs. | +| | | | | Cardinality | +| | | | - isInvariant: | of 0 means | +| | | | false | that the NS | +| | | | | is a NF set | +| | | | | with | +| | | | - valueRange: | unspecified | +| | | | no | connectivity. | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| \_vnfdId | Vnfd | 0..\* | Preliminary | References | +| | | | | the VNFD of | +| | | | OpenModelAttribute| a | +| | | | | constituent | +| | | | | VNF. | +| | | | - isInvariant: | | +| | | | false | | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | +| | | | | | +| | | | PassedByReference | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ +| \_pnfdId | Pnfd | 0..\* | Experimental | References | +| | | | | the PNFD of | +| | | | | a | +| | | | OpenModelAttribute| constituent | +| | | | | PNF. | +| | | | | | +| | | | - isInvariant: | | +| | | | false | | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | +| | | | | | +| | | | PassedByReference | | ++--------------------------+----------------------------+-------------+-------------------+----------------+ + +NsVirtualLinkDesc +----------------- + +The NsVirtualLinkDesc class provides general information enabling the +instantiation of virtual links. For all attributes in this class the +Producer is SDC and the Consumer is SDC/UUI/VFC. + +**Parent class:** VirtualLinkDesc + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + +- Preliminaryry + ++------------------------+-----------------+-------------+-------------------+----------------+ +| **Attribute Name** | **Type** | **Mult.** | **Stereotypes** | **Description**| ++========================+=================+=============+===================+================+ +| vitualLinkDescProvider | String | 0..1 | Preliminary | Defines the | +| | | | | organization | +| | | | OpenModelAttribute| generating | +| | | | | the VLD. | +| | | | | | +| | | | - isInvariant: | | +| | | | false | | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++------------------------+-----------------+-------------+-------------------+----------------+ +| virtuaLinkDescVersion | Version | 1 | Preliminary | Specifies | +| | | | | the version | +| | | | OpenModelAttribute| of the VLD. | +| | | | | | +| | | | - isInvariant: | | +| | | | false | | +| | | | | | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++------------------------+-----------------+-------------+-------------------+----------------+ +| VirtualLinkDf | VirtualLinkDf | 1 | Preliminary | Specifies | +| | | | | properties | +| | | | OpenModelAttribute| for | +| | | | | instantiating | +| | | | - isInvariant: | a VL | +| | | | false | according | +| | | | | to a | +| | | | | specific | +| | | | - valueRange: | flavour. | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++------------------------+-----------------+-------------+-------------------+----------------+ +| virtualLinkDescId | Identifier | 1 | Preliminary | Uniquely | +| | | | | identifies | +| | | | OpenModelAttribute| a VLD in | +| | | | | the parent | +| | | | | descriptor. | +| | | | - isInvariant: | For | +| | | | false | VnfVirtualL | +| | | | | inkDesc, | +| | | | | the parent | +| | | | | descriptor | +| | | | - valueRange: | is the | +| | | | no | VNFD. For | +| | | | range | NsVirtualLi- | +| | | | constraint | nkDesc, | +| | | | | the parent | +| | | | | descriptor | +| | | | - support: | is the NSD. | +| | | | MANDATORY | Note: the | +| | | | | description | +| | | | | of this | +| | | | | class are | +| | | | | different | +| | | | | in ETSI GS | +| | | | | NFV IFA 011 | +| | | | | and ETSI GS | +| | | | | NFV IFA | +| | | | | 014. The | +| | | | | present | +| | | | | definition | +| | | | | merges the 2 | +| | | | | definitions. | ++------------------------+-----------------+-------------+-------------------+----------------+ +| connectivityType | ConnectivityType| 1 | Preliminary | Specifies | +| | | | | the | +| | | | OpenModelAttribute| protocol | +| | | | | exposed by | +| | | | | a VL and | +| | | | - isInvariant: | the flow | +| | | | false | pattern | +| | | | | supported | +| | | | | by the VL. | +| | | | - valueRange: | | +| | | | no | | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++------------------------+-----------------+-------------+-------------------+----------------+ +| description | String | 0..1 | Preliminary | Provides | +| | | | | human-readable | +| | | | OpenModelAttribute| information | +| | | | | on the | +| | | | - isInvariant: | purpose of | +| | | | false | the VL | +| | | | | (e.g. | +| | | | | control | +| | | | - valueRange: | plane | +| | | | no | traffic). | +| | | | range | | +| | | | constraint | | +| | | | | | +| | | | - support: | | +| | | | MANDATORY | | ++------------------------+-----------------+-------------+-------------------+----------------+ + +Pnfd +---- + +The Pnfd class is a deployment template enabling on-boarding PNFs and +referencing them from an NSD. It focuses on connectivity aspects only. + +**Parent class:** NetworkFunctionDesc + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + +- Experimental + + + +Vnfd +---- + +The Vnfd class is a deployment template enabling on-boarding VNFs and +referencing them from an NSD. + + +ConnectivityType +---------------- + +The ConnectivityType datatype specifies the protocol exposed by a VL and +the flow pattern supported by the VL. + ++--------------+--------------+-----------+-----------+-------------------+----------------+ +| **Attribute | **Type** | **Mult.** | **Access**| **Stereotypes** | **Description**| +| Name** | | | | | | ++==============+==============+===========+===========+===================+================+ +| layerProtocol| LayerProtocol| 1 | RW | Preliminary | identifies | +| | | | | | the | +| | | | | OpenModelAttribute| protocol | +| | | | | | this VL | +| | | | | | gives | +| | | | | - isInvariant: | access to | +| | | | | false | (IPV4, IPV6). | +| | | | | | | +| | | | | - valueRange: | | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++--------------+--------------+-----------+-----------+-------------------+----------------+ +| flowPatternrn| String | 0..1 | RW | Preliminary | Identifies | +| | | | | | the flow | +| | | | | OpenModelAttribute| pattern | +| | | | | | of the | +| | | | | - isInvariant: | connectivity | +| | | | | false | (Line, | +| | | | | | Tree, | +| | | | | | Mesh). | +| | | | | - valueRange: | | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++--------------+--------------+-----------+-----------+-------------------+----------------+ + +MonitoredData(TBD) +------------------ + +The MonitoredData datatype identifies information to be monitored during +the lifetime of a network service instance. + +NsLifeCycleManagementScript +--------------------------- + +The LifeCycleManagementScript information element specifies a script for +the NS. + ++-------------+-----------+-----------+-----------+-------------------+----------------+ +| **Attribute | **Type** | **Mult.** | **Access**| **Stereotypes** | **Description**| +| Name** | | | | | | ++=============+===========+===========+===========+===================+================+ +| event | String | 1..\* | RW | OpenModelAttribute| Describes NS | +| | | | | | lifecycle | +| | | | | - isInvarriant: | event(s) | +| | | | | false | or an | +| | | | | | external | +| | | | | | stimulus | +| | | | | | detected | +| | | | | | on an | +| | | | | - valueRange: | NFVO | +| | | | | no | reference | +| | | | | range | point. | +| | | | | constraint | NOTE 1: A | +| | | | | | minimum | +| | | | | | set of NS | +| | | | | | lifecycle | +| | | | | - support: | events | +| | | | | | triggered | +| | | | | MANDATORY | internally | +| | | | | | by the NFVO | +| | | | | | includes: | +| | | | | | start | +| | | | | | instantiation, | +| | | | | | end | +| | | | | | instantiation, | +| | | | | | start | +| | | | | | scaling, | +| | | | | | end | +| | | | | | scaling, | +| | | | | | start | +| | | | | | healing, | +| | | | | | end | +| | | | | | healing, | +| | | | | | start | +| | | | | | termination, | +| | | | | | end | +| | | | | | termination, | +| | | | | | start | +| | | | | | update, | +| | | | | | end | +| | | | | | update. | +| | | | | | NOTE 2: A | +| | | | | | minimum | +| | | | | | set of | +| | | | | | external | +| | | | | | stimulus | +| | | | | | includes: | +| | | | | | the | +| | | | | | receipt | +| | | | | | of | +| | | | | | request | +| | | | | | message | +| | | | | | of | +| | | | | | instantiation, | +| | | | | | scaling, | +| | | | | | healing, | +| | | | | | termination, | +| | | | | | update of NS. | ++-------------+-----------+-----------+-----------+-------------------+----------------+ +| script | String | 1 | RW | OpenModelAttribute| Includes | +| | | | | | an NS LCM | +| | | | | | script | +| | | | | - isInvarriant: | (e.g., | +| | | | | false | written | +| | | | | | in a DSL) | +| | | | | | triggered | +| | | | | | to react | +| | | | | - valueRange: | to one of the | +| | | | | no | events | +| | | | | range | listed in | +| | | | | constraint | the event | +| | | | | | attribute. | +| | | | | - support: | | +| | | | | MANDATORY | | ++-------------+-----------+-----------+-----------+-------------------+----------------+ + +NsQoS +----- + +The NsQoS datatype specifies quality of service parameters applicable to +a NS VL. + ++---------------------+-----------+-----------+-----------+-------------------+----------------+ +| **Attribute Name** | **Type** | **Mult.** | **Access**|**Stereotypes** | **Description**| ++=====================+===========+===========+===========+===================+================+ +| priority | Integer | 0..1 | RW | Preliminary | Specifies | +| | | | | | the | +| | | | | | priority | +| | | | | OpenModelAttribute| level in | +| | | | | | case of | +| | | | | | congestion | +| | | | | - isInvariant: | on the | +| | | | | false | underlying | +| | | | | | physical | +| | | | | - valueRange: | links. | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++---------------------+-----------+-----------+-----------+-------------------+----------------+ +| latency | Number | 1 | RW | Preliminary | Maximum | +| | | | | | latency | +| | | | | | in ms. | +| | | | | OpenModelAttribute| | +| | | | | | | +| | | | | - isInvariant: | | +| | | | | false | | +| | | | | | | +| | | | | - valueRange: | | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++---------------------+-----------+-----------+-----------+-------------------+----------------+ +| packetDelayVariation| Number | 1 | RW | Preliminary | Maximum | +| | | | | | jitter in | +| | | | | | ms. | +| | | | | OpenModelAttribute| | +| | | | | | | +| | | | | - isInvariant: | | +| | | | | false | | +| | | | | | | +| | | | | - valueRange: | | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++---------------------+-----------+-----------+-----------+-------------------+----------------+ +| packetLossRatio | Number | 0..1 | RW | Preliminary | Maximum | +| | | | | | packet | +| | | | | | loss | +| | | | | OpenModelAttribute| ratio. | +| | | | | | Cardinality | +| | | | | - isInvariant: | is 0 if | +| | | | | false | no | +| | | | | | packetLossRatio| +| | | | | | requirement | +| | | | | - valueRange: | exists. | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++---------------------+-----------+-----------+-----------+-------------------+----------------+ + +VirtualLinkDf +------------- + +The VirtualLinkDf datatype specifies properties for instantiating a VL +according to a specific flavour. + ++-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ +| **Attribute Name** | **Type** | **Mult.** | **Access**|**Stereotypes** | **Description**| ++=======================+==========================+===========+===========+===================+================+ +| flavourId | Identifier | 1 | RW | Preliminary | Identifies | +| | | | | | this | +| | | | | OpenModelAttribute| VirtualLinkDF | +| | | | | | datatype | +| | | | | - isInvariant: | within a | +| | | | | false | VLD. | +| | | | | | | +| | | | | - valueRange: | | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ +| qos | NsQoS | 0..1 | RW | Preliminary | Specifies | +| | | | | | quality | +| | | | | | of | +| | | | | OpenModelAttribute| service | +| | | | | | parameters | +| | | | | - isInvariant: | applicable | +| | | | | false | to a VL. | +| | | | | | | +| | | | | - valueRange: | | +| | | | | no | | +| | | | | range | | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ +| serviceAvaibilityLevel| ServiceAvailabilityLevel | 0..1 | RW | Preliminary | Specifies | +| | | | | | one of | +| | | | | | the three | +| | | | | OpenModelAttribute| levels | +| | | | | | defined | +| | | | | | in ETSI | +| | | | | - isInvariant: | GS NFV-REL | +| | | | | false | 001: | +| | | | | | | +| | | | | | - Level1 | +| | | | | | | +| | | | | - valueRange: | - Level2 | +| | | | | no | | +| | | | | range | - Level3 | +| | | | | constraint | | +| | | | | | | +| | | | | - support: | | +| | | | | MANDATORY | | ++-----------------------+--------------------------+-----------+-----------+-------------------+----------------+ + + + +ServiceAvailabilityLevel +------------------------ + +Specifies one of the three levels defined in ETSI GS NFV-REL 001: +Level 1 Level 2 Level 3 + +Contains Enumeration Literals: + +- LEVEL_1: + +- LEVEL_2: + +- LEVEL_3: + +.. |image0| image:: NSD1.PNG diff --git a/docs/ONAP Model Spec/im/NSDR4.PNG b/docs/ONAP Model Spec/im/NSDR4.PNG deleted file mode 100644 index acd2c5d..0000000 Binary files a/docs/ONAP Model Spec/im/NSDR4.PNG and /dev/null differ diff --git a/docs/ONAP Model Spec/im/Nested Service final for Rst.PNG b/docs/ONAP Model Spec/im/Nested Service final for Rst.PNG deleted file mode 100644 index 1c58c42..0000000 Binary files a/docs/ONAP Model Spec/im/Nested Service final for Rst.PNG and /dev/null differ diff --git a/docs/ONAP Model Spec/im/PNF/PNFD.rst b/docs/ONAP Model Spec/im/PNF/PNFD.rst new file mode 100644 index 0000000..76eb837 --- /dev/null +++ b/docs/ONAP Model Spec/im/PNF/PNFD.rst @@ -0,0 +1,388 @@ +.. 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 + +PnfdModel +~~~~~~~~~ + +Classes +------- + +Pnf +~~~ + +An implementation of a NF via a tightly coupled software and hardware system. + +**Parent class:** NetworkFunction + +Applied stereotypes: + +- Future + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== ============================================ +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== ============================================ +\_pnfExtCp PnfExtCp 1..\* OpenModelAttribute External CP of the PNF. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +id String 1 Experimental Identifier of the network function + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +name String 0..1 Experimental + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +type String 1 Experimental Description of the type of network function + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +description String 0..1 Experimental Description of the network function + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +role String 1 Experimental Role the network function will be providing. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ============================================ + +PnfExtCp +~~~~~~~~ + +External CP of the PNF. + +**Parent class:** Cp + +Applied stereotypes: + +- Future + +- OpenModelClass + +- **support: MANDATORY** + +================== ============= ========= ================================== ======================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ============= ========= ================================== ======================================================================================================================================================================== +cpd invalid 1 OpenModelAttribute Cpd used to deploy this PNF CP. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpId Identifier 1 OpenModelAttribute Identifier of the connection point instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpName String 1 OpenModelAttribute Name of the Cp instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpNameAlt String 1 OpenModelAttribute alternative name of the Cp instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpType String 1 OpenModelAttribute Generic description of the type of Cp + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpRole String 1 OpenModelAttribute Role in the network this Cp will be providing + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpFunction String 1 OpenModelAttribute English description of the function this specific Cp will be providing + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpDescription String 1 OpenModelAttribute Cp description + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +cpBandwidth String 1 OpenModelAttribute Cp assigned (actual) bandwidth + + - isInvariant: false Cp (max? assigned?) bandwidth + + - valueRange: no range constraint + + - support: MANDATORY +provStatus String 1 OpenModelAttribute provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems valid value example: PROVISIONED, PREPROVISIONED, CAPPED + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +adminsStatus String 1 OpenModelAttribute Administrative status of the connection point. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +protocol String 1 OpenModelAttribute Protocol used by the Cp + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +trunkMode Boolean 1 OpenModelAttribute Indicator whether the Cp is in trunk mode + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +addressType String 1 OpenModelAttribute Type of address: MAC address or IP address + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +L2addressData L2AddressData 0..1 OpenModelAttribute Only present when addressType is MAC address + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +L3addressData L3AddressData 0..1 OpenModelAttribute Only present when addressType is IP address + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ============= ========= ================================== ======================================================================================================================================================================== + +PnfExtCpd +~~~~~~~~~ + +A PnfExtCpd is a type of Cpd and describes the characteristics of an external interface, a.k.a external CP, where to connect the PNF to a VL. + +**Parent class:** ExtCpd + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +PnfProfile +~~~~~~~~~~ + +The PnfProfile class describes additional data for a given PNF instance used in a DF. + +Applied stereotypes: + +- Future + +- OpenModelClass + +- **support: MANDATORY** + +========================== ========================= ========= ================================== ======================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +========================== ========================= ========= ================================== ======================================================================================================================================== +pnfProfileId Identifier 1 OpenModelAttribute Identifier of this PnfProfile class. It uniquely identifies a PnfProfile. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +pnfVirtualLinkConnectivity NsVirtualLinkConnectivity 1..\* OpenModelAttribute Defines the connection information of the PNF, it contains connection relationship between a PNF connection point and a NS virtual Link. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +========================== ========================= ========= ================================== ======================================================================================================================================== + +Pnfd +~~~~ + +The Pnfd class is a deployment template enabling on-boarding PNFs and referencing them from an NSD. It focuses on connectivity aspects only. + +**Parent class:** NetworkFunctionDesc + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +=================== ================== ========= ================================== ==================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +=================== ================== ========= ================================== ==================================================================================================================== +pnfdId Identifier 1 OpenModelAttribute Identifier of this Pnfd class. It uniquely identifies the PNFD. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +provider String 1 OpenModelAttribute Identifies the provider of the PNFD. NOTE: The provider of the PNFD might be different from the provider of the PNF. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +version Version 1 OpenModelAttribute Identifies the version of the PNFD + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +security SecurityParameters 0..1 OpenModelAttribute Provides a signature to prevent tampering. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +functionDescription String 1 OpenModelAttribute Describes the PNF function. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +pnfdInvariantId Identifier 1 OpenModelAttribute Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD. + + - isInvariant: true + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute Provides the human readable name of the PNFD. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +\_pnfExtCpd PnfExtCpd 1..\* OpenModelAttribute Specifies the characteristics of one or more connection points where to connect the PNF to a VL. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +=================== ================== ========= ================================== ==================================================================================================================== + +Data Types +---------- + +SwVersion +~~~~~~~~~ + +The software versions associated with the pnfd + +Applied stereotypes: + +- Future + +================== ======== ========= ========== ================================== ===================== +**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** +================== ======== ========= ========== ================================== ===================== +active String 1 RW OpenModelAttribute The active software + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +passive String 0..\* RW OpenModelAttribute The passive software + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +recovery String 0..\* RW OpenModelAttribute The recovery software + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ========== ================================== ===================== \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/PNFD.rst b/docs/ONAP Model Spec/im/PNFD.rst deleted file mode 100644 index 1da1ce9..0000000 --- a/docs/ONAP Model Spec/im/PNFD.rst +++ /dev/null @@ -1,384 +0,0 @@ -PnfdModel -~~~~~~~~~ - -Classes -------- - -Pnf -~~~ - -An implementation of a NF via a tightly coupled software and hardware system. - -**Parent class:** NetworkFunction - -Applied stereotypes: - -- Future - -- OpenModelClass - -- **support: MANDATORY** - -================== ======== ========= ================================== ============================================ -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ======== ========= ================================== ============================================ -\_pnfExtCp PnfExtCp 1..\* OpenModelAttribute External CP of the PNF. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -id String 1 Experimental Identifier of the network function - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -name String 0..1 Experimental - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -type String 1 Experimental Description of the type of network function - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -description String 0..1 Experimental Description of the network function - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -role String 1 Experimental Role the network function will be providing. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ================================== ============================================ - -PnfExtCp -~~~~~~~~ - -External CP of the PNF. - -**Parent class:** Cp - -Applied stereotypes: - -- Future - -- OpenModelClass - -- **support: MANDATORY** - -================== ============= ========= ================================== ======================================================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ============= ========= ================================== ======================================================================================================================================================================== -cpd invalid 1 OpenModelAttribute Cpd used to deploy this PNF CP. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpId Identifier 1 OpenModelAttribute Identifier of the connection point instance. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpName String 1 OpenModelAttribute Name of the Cp instance. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpNameAlt String 1 OpenModelAttribute alternative name of the Cp instance. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpType String 1 OpenModelAttribute Generic description of the type of Cp - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpRole String 1 OpenModelAttribute Role in the network this Cp will be providing - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpFunction String 1 OpenModelAttribute English description of the function this specific Cp will be providing - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpDescription String 1 OpenModelAttribute Cp description - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -cpBandwidth String 1 OpenModelAttribute Cp assigned (actual) bandwidth - - - isInvariant: false Cp (max? assigned?) bandwidth - - - valueRange: no range constraint - - - support: MANDATORY -provStatus String 1 OpenModelAttribute provisioning status, used as a trigger for operational monitoring of this resource by service assurance systems valid value example: PROVISIONED, PREPROVISIONED, CAPPED - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -adminsStatus String 1 OpenModelAttribute Administrative status of the connection point. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -protocol String 1 OpenModelAttribute Protocol used by the Cp - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -trunkMode Boolean 1 OpenModelAttribute Indicator whether the Cp is in trunk mode - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -addressType String 1 OpenModelAttribute Type of address: MAC address or IP address - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -L2addressData L2AddressData 0..1 OpenModelAttribute Only present when addressType is MAC address - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -L3addressData L3AddressData 0..1 OpenModelAttribute Only present when addressType is IP address - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ============= ========= ================================== ======================================================================================================================================================================== - -PnfExtCpd -~~~~~~~~~ - -A PnfExtCpd is a type of Cpd and describes the characteristics of an external interface, a.k.a external CP, where to connect the PNF to a VL. - -**Parent class:** ExtCpd - -Applied stereotypes: - -- OpenModelClass - -- **support: MANDATORY** - -- Preliminary - -PnfProfile -~~~~~~~~~~ - -The PnfProfile class describes additional data for a given PNF instance used in a DF. - -Applied stereotypes: - -- Future - -- OpenModelClass - -- **support: MANDATORY** - -========================== ========================= ========= ================================== ======================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -========================== ========================= ========= ================================== ======================================================================================================================================== -pnfProfileId Identifier 1 OpenModelAttribute Identifier of this PnfProfile class. It uniquely identifies a PnfProfile. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -pnfVirtualLinkConnectivity NsVirtualLinkConnectivity 1..\* OpenModelAttribute Defines the connection information of the PNF, it contains connection relationship between a PNF connection point and a NS virtual Link. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -========================== ========================= ========= ================================== ======================================================================================================================================== - -Pnfd -~~~~ - -The Pnfd class is a deployment template enabling on-boarding PNFs and referencing them from an NSD. It focuses on connectivity aspects only. - -**Parent class:** NetworkFunctionDesc - -Applied stereotypes: - -- OpenModelClass - -- **support: MANDATORY** - -- Preliminary - -=================== ================== ========= ================================== ==================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -=================== ================== ========= ================================== ==================================================================================================================== -pnfdId Identifier 1 OpenModelAttribute Identifier of this Pnfd class. It uniquely identifies the PNFD. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -provider String 1 OpenModelAttribute Identifies the provider of the PNFD. NOTE: The provider of the PNFD might be different from the provider of the PNF. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -version Version 1 OpenModelAttribute Identifies the version of the PNFD - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -security SecurityParameters 0..1 OpenModelAttribute Provides a signature to prevent tampering. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -functionDescription String 1 OpenModelAttribute Describes the PNF function. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -pnfdInvariantId Identifier 1 OpenModelAttribute Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD. - - - isInvariant: true - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -name String 1 OpenModelAttribute Provides the human readable name of the PNFD. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -\_pnfExtCpd PnfExtCpd 1..\* OpenModelAttribute Specifies the characteristics of one or more connection points where to connect the PNF to a VL. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -=================== ================== ========= ================================== ==================================================================================================================== - -Data Types ----------- - -SwVersion -~~~~~~~~~ - -The software versions associated with the pnfd - -Applied stereotypes: - -- Future - -================== ======== ========= ========== ================================== ===================== -**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** -================== ======== ========= ========== ================================== ===================== -active String 1 RW OpenModelAttribute The active software - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -passive String 0..\* RW OpenModelAttribute The passive software - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -recovery String 0..\* RW OpenModelAttribute The recovery software - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ========== ================================== ===================== \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/Root.rst b/docs/ONAP Model Spec/im/Root.rst deleted file mode 100644 index ddda941..0000000 --- a/docs/ONAP Model Spec/im/Root.rst +++ /dev/null @@ -1,751 +0,0 @@ -.. 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/Root/Root.png b/docs/ONAP Model Spec/im/Root/Root.png new file mode 100644 index 0000000..171c715 Binary files /dev/null and b/docs/ONAP Model Spec/im/Root/Root.png differ diff --git a/docs/ONAP Model Spec/im/Root/Root.rst b/docs/ONAP Model Spec/im/Root/Root.rst new file mode 100644 index 0000000..ddda941 --- /dev/null +++ b/docs/ONAP Model Spec/im/Root/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/NestedService.png b/docs/ONAP Model Spec/im/Service/NestedService.png new file mode 100644 index 0000000..0e6f992 Binary files /dev/null and b/docs/ONAP Model Spec/im/Service/NestedService.png differ diff --git a/docs/ONAP Model Spec/im/Service/ServiceModel-Nested Service.rst b/docs/ONAP Model Spec/im/Service/ServiceModel-Nested Service.rst new file mode 100644 index 0000000..ffae213 --- /dev/null +++ b/docs/ONAP Model Spec/im/Service/ServiceModel-Nested Service.rst @@ -0,0 +1,1380 @@ +Enhanced Nested Service Model +============================= + +Diagrams +-------- + +Enhanced Nested Service Model +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. image:: NestedService.png + +Classes +------- + +ServiceAtomicDescriptor +~~~~~~~~~~~~~~~~~~~~~~~ + +**Parent class:** ServiceDescriptor + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +====================================== ================================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +\_serviceAtomicInstance ServiceAtomicInstance 0..\* OpenModelAttribute An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_resourceDesc (resourcespecification) ResourceDesc 0..\* OpenModelAttribute Resource components of constituting a serivce descriptor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInvariantId Identifier 1 OpenModelAttribute Constant identifier of the service model. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceId Identifier 1 OpenModelAttribute Versioned identifier of the service model (this uuid is changed for every major version of the service) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute The name of the service model designed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute The description of the service model designed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +category String 1..\* OpenModelAttribute A predefined list which identifies the construct's category. There is a predefined list of service categories. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +version String 1 OpenModelAttribute The service model version. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceType String 0..1 OpenModelAttribute An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceRole String 0..1 OpenModelAttribute An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +icon String 1 OpenModelAttribute The icon path of the service. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +attachment Attachment 0..\* OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +isShared Boolean 1 OpenModelAttribute Describe whether this service descriptor is shared or not in the service design. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +lifecycleManagementScript ServiceLifecycleManagementScript 0..\* OpenModelAttribute Includes a list of events and corresponding management scripts performed for the + Service. + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL + + Preliminary +class8 CustomizedKPIGroup 0..1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +SNSSAIId Identifier 0..1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Experimental +validFor TimePeriod 0..1 OpenModelAttribute The period during which the design entity is valid. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +status String 1 OpenModelAttribute The condition of the specification, such s active, inactive, or planned. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute 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). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute Defines a textual free-form description of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +id Identifier 1 OpenModelAttribute Identifier of this information element. This attribute shall be globally unique. + + - isInvariant: false Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +====================================== ================================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +ServiceAtomicInstance +~~~~~~~~~~~~~~~~~~~~~ + +**Parent class:** ServiceInstance + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +===================== ================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +\_resourceInstance ResourceInstance 0..\* OpenModelAttribute Resource instance components of constituting a service instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInstanceId Identifier 1 OpenModelAttribute Uniquely identifies this instance of a service. + + - isInvariant: false Uniquely identifies this instance of a service. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceInstanceName String 0..1 OpenModelAttribute The name assigned to the service-instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL + + Preliminary +serviceType String 0..1 OpenModelAttribute An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceRole String 1 OpenModelAttribute An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +selfLink Uri 1 OpenModelAttribute URL to endpoint where more details can be gotten. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +orchestrationStatus String 1 OpenModelAttribute Orchestration status of the service instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +nsStatus String 1 OpenModelAttribute Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +instanceSharingNumber Integer 0..1 OpenModelAttribute Record the number of services that are using this service instance. + Note: This attribute can be used when a service instance is prepared to be deleted, the detected number will help to find how many services are using this instance. If number is greater than 1, it shows this instance is used by other service(s), otherwise it can be deleted. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 0..1 OpenModelAttribute 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). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 0..1 OpenModelAttribute Defines a textual free-form description of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +id Identifier 1 OpenModelAttribute Identifier of this information element. This attribute shall be globally unique. + + - isInvariant: false Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +===================== ================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +ServiceCompositeDescriptor +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +ServcieCompositeDescriptor is used to model the design time representation of a service component or network service. + +**Parent class:** ServiceDescriptor + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +====================================== ================================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +\_serviceDescriptor ServiceDescriptor 0..\* OpenModelAttribute Describe the nested relationship between multiple Service Descriptors. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_serviceCompositeInstance ServiceCompositeInstance 0..\* OpenModelAttribute An implementation of composite Service corresponding to a ServiceCompositeDescriptor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +\_resourceDesc (resourcespecification) ResourceDesc 0..\* OpenModelAttribute Resource components of constituting a serivce descriptor. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInvariantId Identifier 1 OpenModelAttribute Constant identifier of the service model. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceId Identifier 1 OpenModelAttribute Versioned identifier of the service model (this uuid is changed for every major version of the service) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute The name of the service model designed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute The description of the service model designed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +category String 1..\* OpenModelAttribute A predefined list which identifies the construct's category. There is a predefined list of service categories. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +version String 1 OpenModelAttribute The service model version. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceType String 0..1 OpenModelAttribute An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceRole String 0..1 OpenModelAttribute An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +icon String 1 OpenModelAttribute The icon path of the service. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +attachment Attachment 0..\* OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +isShared Boolean 1 OpenModelAttribute Describe whether this service descriptor is shared or not in the service design. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +lifecycleManagementScript ServiceLifecycleManagementScript 0..\* OpenModelAttribute Includes a list of events and corresponding management scripts performed for the + Service. + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL + + Preliminary +class8 CustomizedKPIGroup 0..1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +SNSSAIId Identifier 0..1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Experimental +validFor TimePeriod 0..1 OpenModelAttribute The period during which the design entity is valid. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +status String 1 OpenModelAttribute The condition of the specification, such s active, inactive, or planned. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute 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). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute Defines a textual free-form description of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +id Identifier 1 OpenModelAttribute Identifier of this information element. This attribute shall be globally unique. + + - isInvariant: false Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +====================================== ================================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +ServiceCompositeInstance +~~~~~~~~~~~~~~~~~~~~~~~~ + +**Parent class:** ServiceInstance + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +===================== ================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +\_resourceInstance ResourceInstance 0..\* OpenModelAttribute Resource instance components of constituting a service instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +serviceInstanceId Identifier 1 OpenModelAttribute Uniquely identifies this instance of a service. + + - isInvariant: false Uniquely identifies this instance of a service. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceInstanceName String 0..1 OpenModelAttribute The name assigned to the service-instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL + + Preliminary +serviceType String 0..1 OpenModelAttribute An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceRole String 1 OpenModelAttribute An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +selfLink Uri 1 OpenModelAttribute URL to endpoint where more details can be gotten. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +orchestrationStatus String 1 OpenModelAttribute Orchestration status of the service instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +nsStatus String 1 OpenModelAttribute Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +instanceSharingNumber Integer 0..1 OpenModelAttribute Record the number of services that are using this service instance. + Note: This attribute can be used when a service instance is prepared to be deleted, the detected number will help to find how many services are using this instance. If number is greater than 1, it shows this instance is used by other service(s), otherwise it can be deleted. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 0..1 OpenModelAttribute 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). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 0..1 OpenModelAttribute Defines a textual free-form description of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +id Identifier 1 OpenModelAttribute Identifier of this information element. This attribute shall be globally unique. + + - isInvariant: false Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +===================== ================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +ServiceDescriptor +~~~~~~~~~~~~~~~~~ + +ServiceDescriptor is used to model the design time representation of a service. + +**Parent class:** DesignEntity + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +========================= ================================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +serviceInvariantId Identifier 1 OpenModelAttribute Constant identifier of the service model. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceId Identifier 1 OpenModelAttribute Versioned identifier of the service model (this uuid is changed for every major version of the service) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute The name of the service model designed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute The description of the service model designed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +category String 1..\* OpenModelAttribute A predefined list which identifies the construct's category. There is a predefined list of service categories. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +version String 1 OpenModelAttribute The service model version. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceType String 0..1 OpenModelAttribute An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceRole String 0..1 OpenModelAttribute An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +icon String 1 OpenModelAttribute The icon path of the service. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +attachment Attachment 0..\* OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +isShared Boolean 1 OpenModelAttribute Describe whether this service descriptor is shared or not in the service design. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +lifecycleManagementScript ServiceLifecycleManagementScript 0..\* OpenModelAttribute Includes a list of events and corresponding management scripts performed for the + Service. + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL + + Preliminary +class8 CustomizedKPIGroup 0..1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +SNSSAIId Identifier 0..1 OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Experimental +validFor TimePeriod 0..1 OpenModelAttribute The period during which the design entity is valid. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +status String 1 OpenModelAttribute The condition of the specification, such s active, inactive, or planned. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 1 OpenModelAttribute 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). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute Defines a textual free-form description of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +id Identifier 1 OpenModelAttribute Identifier of this information element. This attribute shall be globally unique. + + - isInvariant: false Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +========================= ================================ ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +ServiceInstance +~~~~~~~~~~~~~~~ + +ServiceInstance is used to model the run time representation of a service. + +**Parent class:** OperationalEntity + +Applied stereotypes: + +- OpenModelClass + +- **support: MANDATORY** + +- Preliminary + +===================== ========== ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +serviceInstanceId Identifier 1 OpenModelAttribute Uniquely identifies this instance of a service. + + - isInvariant: false Uniquely identifies this instance of a service. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceInstanceName String 0..1 OpenModelAttribute The name assigned to the service-instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: OPTIONAL + + Preliminary +serviceType String 0..1 OpenModelAttribute An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +serviceRole String 1 OpenModelAttribute An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +selfLink Uri 1 OpenModelAttribute URL to endpoint where more details can be gotten. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +orchestrationStatus String 1 OpenModelAttribute Orchestration status of the service instance. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +nsStatus String 1 OpenModelAttribute Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +instanceSharingNumber Integer 0..1 OpenModelAttribute Record the number of services that are using this service instance. + Note: This attribute can be used when a service instance is prepared to be deleted, the detected number will help to find how many services are using this instance. If number is greater than 1, it shows this instance is used by other service(s), otherwise it can be deleted. + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +name String 0..1 OpenModelAttribute 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). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 0..1 OpenModelAttribute Defines a textual free-form description of the object. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +id Identifier 1 OpenModelAttribute Identifier of this information element. This attribute shall be globally unique. + + - isInvariant: false Unambiguously distinguishes different object instances. It is the naming attribute of the object. + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +===================== ========== ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== + +Associations +------------ + +ServiceCompositeInstanceHasServiceInstance +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +========================== =========== ========== ========= ======================== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_serviceInstance shared Not navig. 1..\* ServiceInstance OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +\_servicecompositeinstance none Not navig. 1..\* ServiceCompositeInstance OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +========================== =========== ========== ========= ======================== =============== ===================== + +SerivceCompositeDescriptorMadeAvailableAsServiceCompositeInstance +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +An implementation of composite Service corresponding to a ServiceCompositeDescriptor. + +Applied stereotypes: + +- Preliminary + +============================ =========== ========== ========= ========================== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_serviceCompositeInstance shared Not navig. 0..\* ServiceCompositeInstance OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +\_servicecompositedescriptor none Not navig. 1 ServiceCompositeDescriptor OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +============================ =========== ========== ========= ========================== =============== ===================== + +ServiceCompositeDescriptorComprisedOfServiceDescriptor +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Describe the nested relationship between multiple Serive Descriptors. + +Applied stereotypes: + +- Preliminary + +========================== =========== ========== ========= ========================== =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_serviceDescriptor shared Not navig. 0..\* ServiceDescriptor OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +servicecompositedescriptor none Not navig. 0..\* ServiceCompositeDescriptor OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +========================== =========== ========== ========= ========================== =============== ===================== + +ServiceAtomicDescriptorMadeAvailableAsServiceAtomicInstance +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. + +Applied stereotypes: + +- Preliminary + +========================= =========== ========== ========= ======================= =============== ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_serviceAtomicInstance shared Not navig. 0..\* ServiceAtomicInstance OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +\_serviceatomicdescriptor none Not navig. 1 ServiceAtomicDescriptor OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +========================= =========== ========== ========= ======================= =============== ===================== + +ServiceAtomicDescriptorReferencesResourceDesc +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Resource components of constituting a serivce descriptor. + +Applied stereotypes: + +- Preliminary + +====================================== =========== ========== ========= ======================= ========================================================= ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_resourceDesc (resourcespecification) none Navig. 0..\* ResourceDesc Resource components of constituting a serivce descriptor. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +\_serviceatomicdescriptor none Not navig. 0..\* ServiceAtomicDescriptor OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +====================================== =========== ========== ========= ======================= ========================================================= ===================== + +ServiceAtomicInstanceReferencesResourceInstance +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Resource instance components of constituting a serivce instance. + +Applied stereotypes: + +- Preliminary + +======================= =========== ========== ========= ===================== ================================================================ ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_resourceInstance none Navig. 0..\* ResourceInstance Resource instance components of constituting a service instance. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +\_serviceatomicinstance none Not navig. 0..\* ServiceAtomicInstance OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +======================= =========== ========== ========= ===================== ================================================================ ===================== + +ServiceCompositeInstanceReferencesResourceInstance +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Resource instance components of constituting a serivce instance. + +Applied stereotypes: + +- Preliminary + +========================== =========== ========== ========= ======================== ================================================================ ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_resourceInstance none Navig. 0..\* ResourceInstance Resource instance components of constituting a service instance. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +\_servicecompositeinstance none Not navig. 0..\* ServiceCompositeInstance OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +========================== =========== ========== ========= ======================== ================================================================ ===================== + +ServiceCompositeDescriptorReferencesResourceDesc +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Resource components of constituting a serivce descriptor. + +Applied stereotypes: + +- Preliminary + +====================================== =========== ========== ========= ========================== ========================================================= ===================== +**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type** **Description** **Stereotypes** +\_resourceDesc (resourcespecification) none Navig. 0..\* ResourceDesc Resource components of constituting a serivce descriptor. OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +\_service compositedescriptor none Not navig. 0..\* ServiceCompositeDescriptor OpenModelAttribute + + - partOfObjectKey: 0 + + - uniqueSet: + + - isInvariant: false + + - unsigned: false + + - counter: NA + + - support: MANDATORY +====================================== =========== ========== ========= ========================== ========================================================= ===================== + +Data Types +---------- + +ServiceLifecycleManagementScript +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The LifeCycleManagementScript information element specifies a script for the service. + +Applied stereotypes: + +- Preliminary + +================== =============== ========= ========== ================================== ========================================================================================================================================================================================================================================================================================================== +**Attribute Name** **Type** **Mult.** **Access** **Stereotypes** **Description** +event ServiceLcmEvent 0..\* RW OpenModelAttribute Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator + reference point. + - isInvariant: false + Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator + - valueRange: no range constraint reference point. + + - support: MANDATORY + + Preliminary +lcmTransitionEvent String 0..\* RW OpenModelAttribute Describes the transition Service lifecycle event(s) that cannot be mapped to any of the enumerated values defined for the event attribute. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +script String 1 RW OpenModelAttribute Includes a Service LCM script (e.g. written in a DSL) triggered to react to one of the events listed in the event attribute. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +scriptDsl String 1 RW OpenModelAttribute Defines the domain specific language (i.e. the type) of script that is provided. Types of scripts could include bash, python, etc. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +scriptInput KeyValuePair 0..\* RW OpenModelAttribute Array of KVP requirements with the key as the parameter name and the value as the parameter that need to be passed as an input to the script. Note: The scriptInput values are passed to the scripts in addition to the parameters received in the operation invocation request or indicator value change. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +================== =============== ========= ========== ================================== ========================================================================================================================================================================================================================================================================================================== + +Enumerations +------------ + +ServiceLcmEvent +~~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- EVENT_START_DEPLOYMENT: + +- EVENT_END_DEPLOYMENT: + +- EVENT_START_CONFIGURATION: + +- EVENT_END_CONFIGURATION: + +- EVENT_START_TERMINATION: + +- EVENT_END_TERMINATION: + +- EVENT_START_DEPLOYMENT: + +- EVENT_END_DEPLOYMENT: + +- EVENT_START_CONFIGURATION: + +- EVENT_END_CONFIGURATION: + +- EVENT_START_TERMINATION: + +- EVENT_END_TERMINATION: diff --git a/docs/ONAP Model Spec/im/Service/ServiceModel-Service order.rst b/docs/ONAP Model Spec/im/Service/ServiceModel-Service order.rst new file mode 100644 index 0000000..c817884 --- /dev/null +++ b/docs/ONAP Model Spec/im/Service/ServiceModel-Service order.rst @@ -0,0 +1,395 @@ +.. Copyright 2020 (China Mobile) +.. 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 Order +~~~~~~~~~~~~~ + +.. contents:: + :depth: 3 +.. + +Diagrams +======== + +.. image:: ServiceOrder.png + +Classes +======= + +OrderItemRelationship +--------------------- + +Enables specifying any kind of relationships between ServiceOrderItems + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== ===================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== ===================================================== +type String 1 Preliminary The type of relationship such as contains, relies on. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== ===================================================== + +OrderRelationship +----------------- + +An association between two ServiceOrders. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== =============================================================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== =============================================================================== +type String 1 Preliminary A categorization of the relationship, such as bulk, parent/child, and so forth. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== =============================================================================== + +ServiceCharacteristic +--------------------- + +A quality or distinctive feature that defines an entity, including the +name of this feature (attribute), and the type of the actual value. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== =========================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== =========================================== +name String 1 Preliminary Name of dynamic characteristic (attribute). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +valueType String 1 Preliminary Type of the dynamic characteristic value. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== =========================================== + +ServiceOrder +------------ + +A type of Request that represents a Customer Order's products decomposed +into the services through which the products are realized. + +**Parent class:** Request + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +======================= ================ ========= ================================== ============================================================================================================================================================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +======================= ================ ========= ================================== ============================================================================================================================================================================= +id String 1 OpenModelAttribute Unique identifier for Interaction. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +externalId String 1 OpenModelAttribute ID given by the order requester and only understandable by him (to facilitate his searches afterwards). It could an order number reference from the triggering system (OM) + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +priority OrderPriority 1 OpenModelAttribute A way that can be used by order requester to prioritize orders in Service Order + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +description String 1 OpenModelAttribute Narrative that explains the interaction and details about the interaction, such as why the interaction is taking place. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +category String 1 OpenModelAttribute Used to categorize the order - Requester valued it and this category can be useful for the Service Order Management system and/or requester (e.g. "broadband", "TV option",). + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +state OrderState 1 OpenModelAttribute State of the order + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +completionDate EDate 1 OpenModelAttribute The date on which an interaction is closed or completed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +requestedStartDate EDate 1 OpenModelAttribute The date that was requested to start processing the order. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +requestedCompletionDate EDate 1 OpenModelAttribute The date on which an interaction is closed or completed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +expectedCompletionDate EDate 1 OpenModelAttribute The date on which an interaction is expected to be completed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +startDate EDate 1 OpenModelAttribute The date on which an interaction is started. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +notificationContact String 1 OpenModelAttribute Contact attached to the order to send back information regarding this order + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +\_serviceOrderItem ServiceOrderItem 1..\* OpenModelAttribute Reference to ServiceOrderItem + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +OrderDate EDate 1 OpenModelAttribute The date the order was placed. + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary +======================= ================ ========= ================================== ============================================================================================================================================================================= + +ServiceOrderItem +---------------- + +The purpose for the ServiceOrder expressed in terms of a +ServiceSpecification or a Service. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ========== ========= ================================== ============================================================================================= +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ========== ========= ================================== ============================================================================================= +id String 1 Preliminary Identifier of the line item (generally it is a sequence number 01, 02, 03, ...). + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +action Action 1 Preliminary The action to take for an InteractionItem, such as add, change, remove. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +state OrderState 1 Preliminary State of the order item: described in the state machine diagram. This is the requested state. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +Quantity Integer 1 Preliminary Quantity of an interaction item involved in an interaction. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ========== ========= ================================== ============================================================================================= + +Value +----- + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- **support: MANDATORY** + +================== ======== ========= ================================== =========================================== +**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** +================== ======== ========= ================================== =========================================== +value String 1 Preliminary The value of a given ServiceCharacteristic. + + OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY +================== ======== ========= ================================== =========================================== + +Enumerations +============ + +Action +------ + +Contains Enumeration Literals: + +- ADD: + +- MODIFY: + +- DELETE: + +- NO_CHANGE: + +OrderPriority +------------- + +A way that can be used by order requester to prioritize orders in +Service Order Management system (from 0 to 4: 0 is the highest priority, +and 4 the lowest). It could be for example valued by BSS based on +customer order requested priority. + +Contains Enumeration Literals: + +- 0: + +- 1: + +- 2: + +- 3: + +- 4: + +OrderState +---------- + +Contains Enumeration Literals: + +- ACKNOWLEDGED: + +- IN_PROGRESS: + +- PENDING: + +- HELD: + +- CANCELLED: + +- COMPLETED: + +- FAILED: + +- PARTIAL: + +- REJECTED: + +.. |image0| image:: ServiceOrderR4.png diff --git a/docs/ONAP Model Spec/im/Service/ServiceOrder.png b/docs/ONAP Model Spec/im/Service/ServiceOrder.png new file mode 100644 index 0000000..5283fa0 Binary files /dev/null and b/docs/ONAP Model Spec/im/Service/ServiceOrder.png differ diff --git a/docs/ONAP Model Spec/im/ServiceModel-Nested Service.rst b/docs/ONAP Model Spec/im/ServiceModel-Nested Service.rst deleted file mode 100644 index bf7ba8c..0000000 --- a/docs/ONAP Model Spec/im/ServiceModel-Nested Service.rst +++ /dev/null @@ -1,613 +0,0 @@ -.. Copyright 2020 (China Mobile) -.. 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 - -Atomic / Composite Service View -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. contents:: - :depth: 3 -.. - - -|image0| - -Classes -======= - -ServiceAtomicDescriptor ------------------------ - -**Parent class:** ServiceDescriptor - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -====================================== ==================================== ========= ================================== ===================================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -====================================== ==================================== ========= ================================== ===================================================================================================================================================== -\_serviceAtomicInstance ServiceAtomicInstance 0..\* OpenModelAttribute An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -\_resourceDesc (resourcespecification) ResourceDesc (ResourceSpecification) 0..\* OpenModelAttribute Resource components of constituting a serivce descriptor. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceInvariantId Identifier 1 Preliminary Constant identifier of the service model. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceId Identifier 1 Preliminary Versioned identifier of the service model (this uuid is changed for every major version of the service) - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -name String 1 Preliminary The name of the service model designed. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -description String 1 Preliminary The description of the service model designed. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -category String 1..\* Preliminary A predefined list which identifies the construct's category. There is a predefined list of service categories. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -version String 1 Preliminary The service model version. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceRole String 0..1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -icon String 1 Preliminary The icon path of the service. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -====================================== ==================================== ========= ================================== ===================================================================================================================================================== - -ServiceAtomicInstance ---------------------- - -**Parent class:** ServiceInstance - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== -\_resourceInstance ResourceInstance 0..\* OpenModelAttribute Resource instance components of constituting a service instance. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceInstanceId Identifier 1 Preliminary Uniquely identifies this instance of a service. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceInstanceName String 0..1 Preliminary The name assigned to the service-instance. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: OPTIONAL -serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceRole String 1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -selfLink Uri 1 Preliminary URL to endpoint where more details can be gotten. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -orchestrationStatus String 1 Preliminary Orchestration status of the service instance. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -nsStatus String 1 Preliminary Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== - -ServiceCompositeDescriptor --------------------------- - -ServcieCompositeDescriptor is used to model the design time -representation of a service component or network service. - -**Parent class:** ServiceDescriptor - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -====================================== ==================================== ========= ================================== ===================================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -====================================== ==================================== ========= ================================== ===================================================================================================================================================== -\_serviceDescriptor ServiceDescriptor 0..\* OpenModelAttribute Describe the nested relationship between multiple Service Descriptors. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -\_serviceCompositeInstance ServiceCompositeInstance 0..\* OpenModelAttribute An implementation of composite Service corresponding to a ServiceCompositeDescriptor. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -\_resourceDesc (resourcespecification) ResourceDesc (ResourceSpecification) 0..\* OpenModelAttribute Resource components of constituting a serivce descriptor. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceInvariantId Identifier 1 Preliminary Constant identifier of the service model. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceId Identifier 1 Preliminary Versioned identifier of the service model (this uuid is changed for every major version of the service) - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -name String 1 Preliminary The name of the service model designed. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -description String 1 Preliminary The description of the service model designed. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -category String 1..\* Preliminary A predefined list which identifies the construct's category. There is a predefined list of service categories. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -version String 1 Preliminary The service model version. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceRole String 0..1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -icon String 1 Preliminary The icon path of the service. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -====================================== ==================================== ========= ================================== ===================================================================================================================================================== - -ServiceCompositeInstance ------------------------- - -**Parent class:** ServiceInstance - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== -\_resourceInstance ResourceInstance 0..\* OpenModelAttribute Resource instance components of constituting a service instance. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceInstanceId Identifier 1 Preliminary Uniquely identifies this instance of a service. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceInstanceName String 0..1 Preliminary The name assigned to the service-instance. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: OPTIONAL -serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceRole String 1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -selfLink Uri 1 Preliminary URL to endpoint where more details can be gotten. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -orchestrationStatus String 1 Preliminary Orchestration status of the service instance. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -nsStatus String 1 Preliminary Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -=================== ================ ========= ================================== ======================================================================================================================================================================================================================================================== - -ServiceDescriptor ------------------ - -ServiceDescriptor is used to model the design time representation of a -service. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -================== ========== ========= ================================== ===================================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ========== ========= ================================== ===================================================================================================================================================== -serviceInvariantId Identifier 1 Preliminary Constant identifier of the service model. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceId Identifier 1 Preliminary Versioned identifier of the service model (this uuid is changed for every major version of the service) - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -name String 1 Preliminary The name of the service model designed. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -description String 1 Preliminary The description of the service model designed. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -category String 1..\* Preliminary A predefined list which identifies the construct's category. There is a predefined list of service categories. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -version String 1 Preliminary The service model version. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceRole String 0..1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -icon String 1 Preliminary The icon path of the service. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ========== ========= ================================== ===================================================================================================================================================== - -ServiceInstance ---------------- - -ServiceInstance is used to model the run time representation of a -service. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -=================== ========== ========= ================================== ======================================================================================================================================================================================================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -=================== ========== ========= ================================== ======================================================================================================================================================================================================================================================== -serviceInstanceId Identifier 1 Preliminary Uniquely identifies this instance of a service. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceInstanceName String 0..1 Preliminary The name assigned to the service-instance. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: OPTIONAL -serviceType String 0..1 Preliminary An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as "TRANSPORT". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -serviceRole String 1 Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -selfLink Uri 1 Preliminary URL to endpoint where more details can be gotten. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -orchestrationStatus String 1 Preliminary Orchestration status of the service instance. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -nsStatus String 1 Preliminary Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status). - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -=================== ========== ========= ================================== ======================================================================================================================================================================================================================================================== - -.. |image0| image:: Nested Service final for Rst.png - diff --git a/docs/ONAP Model Spec/im/ServiceModel-Service order.rst b/docs/ONAP Model Spec/im/ServiceModel-Service order.rst deleted file mode 100644 index ead6beb..0000000 --- a/docs/ONAP Model Spec/im/ServiceModel-Service order.rst +++ /dev/null @@ -1,393 +0,0 @@ -.. Copyright 2020 (China Mobile) -.. 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 Order -~~~~~~~~~~~~~ - -.. contents:: - :depth: 3 -.. - - -|image0| - -Classes -======= - -OrderItemRelationship ---------------------- - -Enables specifying any kind of relationships between ServiceOrderItems - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -================== ======== ========= ================================== ===================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ======== ========= ================================== ===================================================== -type String 1 Preliminary The type of relationship such as contains, relies on. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ================================== ===================================================== - -OrderRelationship ------------------ - -An association between two ServiceOrders. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -================== ======== ========= ================================== =============================================================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ======== ========= ================================== =============================================================================== -type String 1 Preliminary A categorization of the relationship, such as bulk, parent/child, and so forth. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ================================== =============================================================================== - -ServiceCharacteristic ---------------------- - -A quality or distinctive feature that defines an entity, including the -name of this feature (attribute), and the type of the actual value. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -================== ======== ========= ================================== =========================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ======== ========= ================================== =========================================== -name String 1 Preliminary Name of dynamic characteristic (attribute). - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -valueType String 1 Preliminary Type of the dynamic characteristic value. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ================================== =========================================== - -ServiceOrder ------------- - -A type of Request that represents a Customer Order's products decomposed -into the services through which the products are realized. - -**Parent class:** Request - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -======================= ================ ========= ================================== ============================================================================================================================================================================= -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -======================= ================ ========= ================================== ============================================================================================================================================================================= -id String 1 OpenModelAttribute Unique identifier for Interaction. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -externalId String 1 OpenModelAttribute ID given by the order requester and only understandable by him (to facilitate his searches afterwards). It could an order number reference from the triggering system (OM) - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -priority OrderPriority 1 OpenModelAttribute A way that can be used by order requester to prioritize orders in Service Order - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -description String 1 OpenModelAttribute Narrative that explains the interaction and details about the interaction, such as why the interaction is taking place. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -category String 1 OpenModelAttribute Used to categorize the order - Requester valued it and this category can be useful for the Service Order Management system and/or requester (e.g. "broadband", "TV option",). - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -state OrderState 1 OpenModelAttribute State of the order - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -completionDate EDate 1 OpenModelAttribute The date on which an interaction is closed or completed. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -requestedStartDate EDate 1 OpenModelAttribute The date that was requested to start processing the order. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -requestedCompletionDate EDate 1 OpenModelAttribute The date on which an interaction is closed or completed. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -expectedCompletionDate EDate 1 OpenModelAttribute The date on which an interaction is expected to be completed. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -startDate EDate 1 OpenModelAttribute The date on which an interaction is started. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -notificationContact String 1 OpenModelAttribute Contact attached to the order to send back information regarding this order - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -\_serviceOrderItem ServiceOrderItem 1..\* OpenModelAttribute Reference to ServiceOrderItem - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -OrderDate EDate 1 OpenModelAttribute The date the order was placed. - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary -======================= ================ ========= ================================== ============================================================================================================================================================================= - -ServiceOrderItem ----------------- - -The purpose for the ServiceOrder expressed in terms of a -ServiceSpecification or a Service. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -================== ========== ========= ================================== ============================================================================================= -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ========== ========= ================================== ============================================================================================= -id String 1 Preliminary Identifier of the line item (generally it is a sequence number 01, 02, 03, ...). - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -action Action 1 Preliminary The action to take for an InteractionItem, such as add, change, remove. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -state OrderState 1 Preliminary State of the order item: described in the state machine diagram. This is the requested state. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -Quantity Integer 1 Preliminary Quantity of an interaction item involved in an interaction. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ========== ========= ================================== ============================================================================================= - -Value ------ - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- **support: MANDATORY** - -================== ======== ========= ================================== =========================================== -**Attribute Name** **Type** **Mult.** **Stereotypes** **Description** -================== ======== ========= ================================== =========================================== -value String 1 Preliminary The value of a given ServiceCharacteristic. - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY -================== ======== ========= ================================== =========================================== - -Enumerations -============ - -Action ------- - -Contains Enumeration Literals: - -- ADD: - -- MODIFY: - -- DELETE: - -- NO_CHANGE: - -OrderPriority -------------- - -A way that can be used by order requester to prioritize orders in -Service Order Management system (from 0 to 4: 0 is the highest priority, -and 4 the lowest). It could be for example valued by BSS based on -customer order requested priority. - -Contains Enumeration Literals: - -- 0: - -- 1: - -- 2: - -- 3: - -- 4: - -OrderState ----------- - -Contains Enumeration Literals: - -- ACKNOWLEDGED: - -- IN_PROGRESS: - -- PENDING: - -- HELD: - -- CANCELLED: - -- COMPLETED: - -- FAILED: - -- PARTIAL: - -- REJECTED: - -.. |image0| image:: ServiceOrderR4.png diff --git a/docs/ONAP Model Spec/im/ServiceOrderR4.PNG b/docs/ONAP Model Spec/im/ServiceOrderR4.PNG deleted file mode 100644 index 5283fa0..0000000 Binary files a/docs/ONAP Model Spec/im/ServiceOrderR4.PNG and /dev/null differ diff --git a/docs/ONAP Model Spec/im/VES index.rst b/docs/ONAP Model Spec/im/VES index.rst deleted file mode 100644 index 2440f38..0000000 --- a/docs/ONAP Model Spec/im/VES index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. 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 - -VES Model -============= - -.. toctree:: - :maxdepth: 2 - - VES-class-1 - VES-class-2 - VES-datatype - VES-enumeration \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/VES/VES index.rst b/docs/ONAP Model Spec/im/VES/VES index.rst new file mode 100644 index 0000000..2440f38 --- /dev/null +++ b/docs/ONAP Model Spec/im/VES/VES index.rst @@ -0,0 +1,14 @@ +.. 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 + +VES Model +============= + +.. toctree:: + :maxdepth: 2 + + VES-class-1 + VES-class-2 + VES-datatype + VES-enumeration \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/VNF/VNF-DF.png b/docs/ONAP Model Spec/im/VNF/VNF-DF.png new file mode 100644 index 0000000..e5e9d0a Binary files /dev/null and b/docs/ONAP Model Spec/im/VNF/VNF-DF.png differ diff --git a/docs/ONAP Model Spec/im/VNF/VNFD-topo.png b/docs/ONAP Model Spec/im/VNF/VNFD-topo.png new file mode 100644 index 0000000..c03aa05 Binary files /dev/null and b/docs/ONAP Model Spec/im/VNF/VNFD-topo.png differ diff --git a/docs/ONAP Model Spec/im/VNF/VNFD.png b/docs/ONAP Model Spec/im/VNF/VNFD.png new file mode 100644 index 0000000..9832d0a Binary files /dev/null and b/docs/ONAP Model Spec/im/VNF/VNFD.png differ diff --git a/docs/ONAP Model Spec/im/VNF/VnfdAndVnfInstance.rst b/docs/ONAP Model Spec/im/VNF/VnfdAndVnfInstance.rst new file mode 100644 index 0000000..6bb88e4 --- /dev/null +++ b/docs/ONAP Model Spec/im/VNF/VnfdAndVnfInstance.rst @@ -0,0 +1,3927 @@ +.. 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 + +ONAP Vnfd and VnfInstance Model +=============================== + +.. contents:: + :depth: 3 +.. + +Diagrams +-------- + +Vnfd View +~~~~~~~~~ + +.. image:: VNFD.png + +Vnfd Topology View +~~~~~~~~~~~~~~~~~~ + +.. image:: VNFD-topo.png + +Vnfd Deployment Flavor +~~~~~~~~~~~~~~~~~~~~~~ + +.. image:: VNFD-DF.png + +Class Definition +---------------- + +BaseConfigGroup +~~~~~~~~~~~~~~~ + +Every Vnf contains a BaseConfigGroup. BaseConfigGroup may set Access +Control Lists (ACL's) and establish security groups and server groups. +BaseConfigGroup reates/establishs storage for the VM's (OpenStack +Cinder). BaseConfigGroup may establish internal networks such as OAM +(VNF Mgmt) or MNS (Maintenance & Surveillance) established. A very +simple VNF may only have a BaseConfig VnfElementGroup. + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +DeploymentGroup +~~~~~~~~~~~~~~~ + +DeploymentGroup provides the minimum viable VDU and associated VNFC +configuration for a useable VNF. I can have a small, medium, large +deployment configuration. + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +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 +respect to a service component. Homing strategy is as follows: +Colocation - members of the group share the same cloud region (VIM +Domain) isolation - members of the group do not share the same cloud +region. + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - homingStrategy + - HomingStrategy + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + - The homing strategy can be one of the following: + Exclusivity + - Resources within the cloud region are exclusive to the group + Inclusively + - Resources are co-located in the same cloud-region. + Diversity + - Resources are geo-diverse (cannot be co-located). + + * - vnfdMembers + - invalid + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + - + + * - vnfdElementGroupId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this group in the VNFD. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the group. + + * - \_vdu + - Vdu + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to Vdus that are part of this group. + + * - \_vnfVirtualLinkdesc + - LinkDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to VnfVirtualLinkDesc that are part of this group. + + +InstantiationLevel +~~~~~~~~~~~~~~~~~~ + +The InstantiationLevel class describes a given level of resources to be +instantiated within a DF in term of the number of VNFC instances to be +created from each VDU. All the VDUs referenced in the level shall be +part of the corresponding DF and their number shall be within the range +(min/max) for this DF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - levelId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Uniquely identifies a level with the DF. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the level. + + * - scaleInfo + - ScaleInfo + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Represents for each aspect the scale level that corresponds to this instantiationlevel. + scaleInfo shall be present if the VNF supports scaling. + + * - \_vduLevel + - VduLevel + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Indicates the number of instance of this VDU to deploy for this level. + + * - virtualLinkBitRateLevel + - VirtualLinkBitRateLevel + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies bitrate requirements applicable to virtual links created from particular virtual link descriptors for this level. + NOTE: If not present, it is assumed that the bitrate requirements can be derived from those specified in the VduCpd instances applicable to the internal VL. If present in + both the InstantiationLevel and the VduCpd instances applicable to the internal VL, the highest value takes precedence. + +LinkDesc +~~~~~~~~ + +A communication channel that connects two or more devices, nodes, or entities. + +**Parent class:** ResourceDesc (ResourceSpecification) + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + +- Preliminary + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - virtualLinkDescId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Unique identifier of this internal VLD in VNFD. + + * - connectivityType + - ConnectivityType + - 1 + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Specifies the protocol exposed by a VL and the flow pattern supported by the VL. + + * - testAccess + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Specifies test access facilities expected on the VL (e.g. none, passive monitoring, or active (intrusive) loopbacks at endpoints). + + * - description + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Provides human-readable information on the purpose of the VL (e.g. control plane traffic). + + * - monitoringParameter + - MonitoringParameter + - 0..\* + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Defines the virtualised resources monitoring parameters on VLD level. + + * - \_virtuaLlinkDescFlavour + - VirtualLinkDescFlavour + - 1..\* + - OpenModelAttribute + + - isInvariant: false + + - valueRange: no range constraint + + - support: MANDATORY + + Preliminary + - Describes a specific flavour of the VL with specific bitrate requirements. + + +PlacementGroup +~~~~~~~~~~~~~~ + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - placementStrategy + - PlacementStrategy + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + - + + * - strategScope + - invalid + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + - + + * - vnfdElementGroupId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this group in the VNFD. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the group. + + * - \_vdu + - Vdu + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to Vdus that are part of this group. + + * - \_vnfVirtualLinkdesc + - LinkDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to VnfVirtualLinkDesc that are part of this group. + + +ScalingAspect +~~~~~~~~~~~~~ + +The ScalingAspect class describes the details of an aspect used for +horizontal scaling. + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +ScalingGroup +~~~~~~~~~~~~ + +A ScalingGroup determines which VNFC's (VDU's) are scaled together based +on demand. + +**Parent class:** VnfdElementGroup + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +SwImageDesc +~~~~~~~~~~~ + +The SwImageDesc information element describes requested additional +capability for a particular VDU. Such a capability may be for +acceleration or specific tasks. Storage not necessarily related to the +compute, may be Network Attached Storage (NAS) References: +tosca-nfv-YAML-v1.0-wd05-rev02 ETSI GS NFV-IFA 011 V2.1.3 + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - id + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The identifier of this software image. + + * - name + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The name of this software image. + + * - version + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The version of this software image. + + * - checksum + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The checksum of the software image file. + + * - containerFormat + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The container format describes the container file format in which software image is provided. + + * - diskFormat + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The disk format of a software image is the format of the underlying disk image. + + * - minRam + - Number + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The minimal RAM requirement for this software image. The value of the "size" attribute of VirtualMemoryData of the Vdu referencing this + SwImageDesc shall not be smaller than the value of minRam. + + * - minDisk + - Number + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The minimal disk size requirement for this software image. The value of the "size of storage" attribute of the + VirtualStorageDesc referencing this SwImageDesc shall not be smaller than the value of minDisk. + + * - size + - Number + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The size of the software image. + + * - operatingSystem + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the operating system used in the software image. This attribute may also identify if a 32 bit or 64 bit software image is used. + support: + + * - supportedVirtualisationEnvironment + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image. + + * - swImage + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The minimal disk size requirement for this software image. The value of the "size of storage" attribute of the VirtualStorageDesc referencing this SwImageDesc + shall not be smaller than the value of minDisk. + + +Vdu +~~~ + +The Virtualisation Deployment Unit (VDU) is a construct supporting the +description of the deployment and operational behavior of a VNFC. A VNFC +instance created based on the VDU maps to a single virtualisation +container (e.g. a VM). A VNFC will only be in one VNFDesc. If a vendor +wants to use the VNFC in mupliple VNFDesc (their product) they can do +so, but it will be 'repeated'. References: +tosca-nfv-YAML-v1.0-wd05-rev02 ETSI GS NFV-IFA 011 V2.1.3 + +Applied stereotypes: + +- Preliminary +- OpenModelClass +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vduId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this Vdu in VNFD. + + * - name + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable name of the Vdu. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the Vdu. + + * - bootOrder + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Boot order of valid boot devices. + NOTE: If no boot order is defined the default boot order defined in the VIM or NFVI shall be used. + + * - nfviConstraint + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes constraints on the NFVI for the VNFC instance(s) created from this Vdu. For example, aspects of a secure hosting environment + for the VNFC instance that involve additional entities or processes. + NOTE: These are constraints other than stipulating that a VNFC instance has access to a certain resource, as a prerequisite to instantiation. + The attributes virtualComputeDesc and virtualStorageDesc define the resources required for instantiation of the VNFC instance. + + * - monitoringParameter + - MonitoringParameter + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the virtualised resources monitoring parameters on VDU level. + + * - injectFiles + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the information (e.g. URL) about the scripts, config drive metadata, etc. which can be used during Vdu booting process. + + * - configurableProperties + - VnfcConfigurableProperties + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the configurable properties of all VNFC instances based on this VDU. + + * - \_vduCpd + - VduCpd + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes network connectivity between a VNFC instance (based on this Vdu) and an Virtual Link (VL). + + * - \_virtualComputeDesc + - VirtualComputeDesc + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu. + + * - \_virtualStorageDesc + - VirtualStorageDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from + virtualComputeDesc defined for this Vdu. + + * - \_swImageDesc + - SwImageDesc + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the software image which is directly loaded on the virtualisation + container realising this Vdu. + NOTE: More software images can be attached to the virtualisation container using VirtualStorage resources. + + +VduCpd +~~~~~~ + +A VduCpd information element is a type of Cpd and describes network +connectivity between a VNFC instance (based on this VDU) and an internal +VL. + +**Parent class:** Cpd + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - bitrateRequirement + - Number + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Bitrate requirement on this CP. + + * - vnicName + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the name of the vNIC this CP attaches to, e.g. eth0. It will be configured during the Vdu booting process. + + * - vnicOrder + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the order to create the vNIC within the scope of this Vdu. + + * - vnicType + - VnicType + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the type of the vNIC this CP attaches to. + + * - \_virtualNetworkInterfaceRequirements + - VirtualNetworkInterfaceRequirements + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. + + * - cpdId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier of this Cpd information element. + + * - cpRole + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the role of the port in the context of the traffic flow + patterns in the VNF or parent NS. For example a VNF with a tree flow + pattern within the VNF will have legal cpRoles of ROOT and LEAF. + + * - description + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic). + + * - cpProtocol + - CpProtocolData + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the protocol layering information the CP uses for connectivity + purposes and associated information. There shall be one cpProtocol for each layer + protocol as indicated by the attribute layerProtocol. + Editor's note: the attribute "layerProtocol" still needs further discussion and not included in this table. + + * - trunkMode + - Boolean + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other). + + * - allowedAddressData + - AddressData + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - For specifying floating IP(s) to be shared among Cpds, which are reserved for vnfReservedCpd described in the VNFD. + + +VduLevel +~~~~~~~~ + +The VduLevel information element indicates for a given VDU in a given +level the number of instances to deploy. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vduId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Uniquely identifies a VDU. + + * - numberOfInstances + - Integer + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Number of instances of VNFC based on this VDU to deploy for an instantiation level or for a scaling delta. + + +VduProfile +~~~~~~~~~~ + +The VduProfile describes additional instantiation data for a given VDU +used in a DF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vdudId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Uniquely identifies a VDU. + + * - minNumberOfInstances + - Integer + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Minimum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. + + * - maxNumberOfInstances + - Integer + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Maximum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. + + * - localAffinityOrAntiAffinityRule + - LocalAffinityOrAntiAffinityRule + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies affinity or anti-affinity rules applicable between the virtualisation containers (e.g. virtual machines) + to be created based on this VDU. + + * - affinityOrAntiAffinityGroupId + - Identifier + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier(s) of the affinity or anti-affinity group(s) the VDU belongs to. + NOTE: Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity + relationships between the virtualisation container(s) (e.g. virtual machine(s)) to be created using this VDU and the + virtualisation container(s) (e.g. virtual machine(s)) to be created using other VDU(s) in the same group. + + * - watchdog + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Watchdog action to be triggered by the VIM for the VNF in case the heart beat fails, e.g. reset or hard shutdown, etc. + + * - vmBootUpTimeOut + - Integer + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Timeout value for the VNFM to wait before the successful booting up of the VDU. + + +VirtualComputeDesc +~~~~~~~~~~~~~~~~~~ + +The VirtualComputeDesc information element supports the specification of +requirements related to virtual compute resources. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - virtualComputeDescId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this VirtualComputeDesc in the VNFD + + * - logicalNode + - LogicalNodeData + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The logical Node requirements. + + * - requestAdditionalCapabilities + - RequestedAdditionalCapabilityData + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Specifies requirements for additional capabilities. These may be for a range of purposes. + One example is acceleration related capabilities. + + * - computeRequirements + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies compute requirements. + + * - virtualMemory + - VirtualMemoryData + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The virtual memory of the virtualised compute. + + * - virtualCpu + - VirtualCpuData + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The virtual CPU(s) of the virtualised compute. + + +VirtualLinkDescFlavour +~~~~~~~~~~~~~~~~~~~~~~ + +The VirtualLinkDescFlavour describes additional instantiation data for a +given internal VL used in a DF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - qos + - QoS + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - QoS of the VL. + + * - flavourId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies a flavour within a VnfVirtualLinkDesc. + + +VirtualLinkProfile +~~~~~~~~~~~~~~~~~~ + +The VirtualLinkProfile describes additional instantiation data for a +given VL used in a DF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - localAffinityOrAntiAffinityRule + - LocalAffinityOrAntiAffinityRule + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies affinity or anti-affinity rules applicable between the VLs based on this + VnfVirtualLinkDesc. When the cardinality is greater than 1, both affinity rule(s) and anti-affinity + rule(s) with different scopes are applicable to the VLs based on this VnfVirtualLinkDesc. + + * - affinityOrAntiAffinityGroupId + - Identifier + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier(s) of the affinity or anti-affinity group(s) the VnfVirtualLinkDesc belongs to. + NOTE: Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity + relationship between the VL(s) using this VnfVirtualLinkDesc and the VL(s) using other VnfVirtualLinkDesc(s) + in the same group. + + * - maxBitRateRequirements + - LinkBitrateRequirements + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies the minimum bitrate requirements for a VL instantiated + according to this profile. + + * - minBitRateRequirements + - LinkBitrateRequirements + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies the minimum bitrate requirements for a VL instantiated according to this profile. + + * - initiationParameters + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies initiation parameters for the virtual link. + + * - networkType + - NetworkType + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Type of the network + + * - dhcpEnabled + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Indicating whether DHCP is enabled. Default is "FALSE" if not specified otherwise. + + * - vlanTransparent + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Indicating whether "VLAN Transparent Mode" is supported. + Default is "FALSE" if not specified otherwise. + + * - \_virtualLinkDescFlavour + - VirtualLinkDescFlavour + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies a flavour within the VnfVirtualLinkDesc. + + * - \_virtualLinkDesc + - LinkDesc + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Uniquely identifies a Vnf VLD. + + +VirtualNetworkInterfaceRequirements +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This class specifies requirements on a virtual network interface. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - name + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Provides a human readable name for the requirement. + + * - description + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Provides a human readable description of the requirement. + + * - supportMandatory + - Boolean + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or + desirable (FALSE). + + * - networkInterfaceRequirements + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The network interface requirements. An element from an array of key-value pairs that + articulate the network interface deployment requirements + + * - nicIoRequirements + - LogicalNodeData + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - This references (couples) the CPD with any logical node I/O requirements (for network devices) that may have been created. + Linking these attributes is necessary so that so that I/O requirements + that need to be articulated at the logical node level can be associated with the network interface requirements + associated with the CPD. + + +VirtualStorageDesc +~~~~~~~~~~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - id + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this VirtualStorageDesc in the VNFD. + + * - typeOfStorage + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Type of virtualised storage resource (e.g. volume, object). + + * - sizeOfStorage + - Number + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Size of virtualised storage resource (e.g. size of volume, in GB). + + * - vduStorageRequirements + - KeyValuePair + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - An array of key-value pairs that articulate the storage deployment requirements. + + * - rdmaEnabled + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Indicate if the storage support RDMA. + + * - swImageDesc + - Identifier + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Software image to be loaded on the VirtualStorage resource created + based on this VirtualStorageDesc. + +Vnf +~~~ + +An implementation of an NF that can be deployed on a Network Function +Virtualisation Infrastructure (NFVI). + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vnfInstanceId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the VNF instance + + * - vnfInstanceName + - String + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - name of the VNF instance. Multiple names are possible. + + * - vnfProductName + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - name to identify the VNF Product, invariant for the VNF Product lifetime + + * - description + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - description of the VNF instance + + * - vnfProvider + - invalid + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - provider of the VNF model + + * - vnfdId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the VNF model + + * - vnfdVersion + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - version of the VNF model + + * - vnfSoftwareVersion + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Software version of the VNF. This is changed when there is any change to the software that is included in the VNF package + + * - onboardedVnfPkgInfoId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the specific VNF package on which the VNF instance is based + + * - availabilityZone + - invalid + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - availability zone information of the VNF instance + + * - operationalStatus + - OperationalStatus + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - indicator for whether the resource is considered operational. + Valid values are in-service-path and out-of-service-path. + + * - orchestrationStatus + - OrchestrationStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether the VNF instance is instantiated + + * - oamlpv4Address + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - oam ip address, ipv4 + + * - oamlpv6Address + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - oam ip address, ipv6 + + * - instantiatedVnfInfo + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - information specific to an instantiated VNF instance, e.g., vm information + + * - inMaint + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether the VNF instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc. + + * - isClosedLoopDisabled + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether closed loop function is enabled + + * - encryptedAccessFlag + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether this VNF is accessed using SSH + + * - vnfConfigurableProperty + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - indicator for whether autoHeal and autoScale is enabled + + * - nfNamingCode + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - String assigned to this model used for naming purpose. + + * - vnfNamingPolicyId + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Identifier of the policy which has the naming logic for this VNF instance + + * - vnfHomingPolicyId + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Identifier of the policy which provides homing conditions. + + * - nfType + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Generic description of the type of network function + + * - nfFunction + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - English description of network function that the specific VNF deployment is providing. + + * - nfRole + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Role in the network this model will be providing + + * - closedLoopStatus + - ClosedLoopStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Whether closed loop capabilities are enabled for this or not. + + * - \_nfc(vnfcinstance) + - Vnfc + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Relatonship to the NF components that are part of this VNF. + + * - \_vnfd + - Vnfd + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Relationship to the VNF descriptor + + * - \_vnfvirtuallink + - VnfVirtualL ink + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Relationship to VnfVirtualLink + + +VnfDf +~~~~~ + +The VnfDf describes a specific deployment version of a VNF. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - flavorId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier of this DF within the VNFD. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the DF. + + * - \_virtuaLlinkProfile + - VirtualLinkProfile + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the internal VLD along with additional data which is used in this DF. + NOTE 1: This allows for different VNF internal topologies between DFs. + NOTE 2: virtualLink Profile needs to be provided for all VLs that the CPs of the VDUs in the VDU profiles connect to. + + * - \_instantiationLevel + - InstantiationLevel + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the various levels of resources that can be used to instantiate the VNF using this flavour. + Examples: Small, Medium, Large. If there is only one "instantiationLevel" entry, it shall be treated as + the default instantiation level for this DF. + + * - \_affinityOrAntiAffinityGroup + - AffinityOrAntiAffinityGroup + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies affinity or anti-affinity relationship applicable between the virtualisation containers + (e.g. virtual machines) to be created using different VDUs or internal VLs to be created using + different VnfVirtualLinkDesc(s) in the same affinity or anti-affinity group. + NOTE: In the present specification, including either VDU(s) or VnfVirtualLinkDesc(s) into the + same affinity or anti-affinity group is supported. Extension to support including both VDU(s) + and VnfVirtualLinkDesc(s) into the same affinity or anti-affinity group is left for future + specification. + + * - \_scalingAspect + - ScalingAspect + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The scaling aspects supported by this DF of the VNF. + scalingAspect shall be present if the VNF supports scaling. + + * - \_vduProfile + - VduProfile + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes additional instantiation data for the VDUs used in this flavor. + + * - \_placementGroup + - PlacementGroup + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Determine where VNFC's (VDU's) are placed with respect to the VNF + + * - \_baseConfigGroup + - BaseConfigGroup + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - BaseConfigGroup may set Access Control Lists (ACL's) and establish security + groups and server groups. + BaseConfigGroup creates/establishs storage for the VM's (OpenStack Cinder). + BaseConfigGroup may establish internal networks such as OAM (VNF Mgmt) or MNS + (Maintenance & Surveillance) established. + + * - \_deploymentGroup + - DeploymentGroup + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - DeploymentGroup provides the minimum viable VDU and associated VNFC configuration + for a useable VNF. + + * - \_scalinggroup + - ScalingGroup + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the vaious scaling groups within the VNF which identify which vnfcs that need to be scaled together. + + +VnfExtCp +~~~~~~~~ + +Describes an external CP exposed by a VNF. + +**Parent class:** Cp + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + +VnfExtCpd +~~~~~~~~~ + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - \_virtualNetworkInterfaceRequirements + - VirtualNetworkInterfaceRequirements + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. + NOTE: In case of referencing an intCpd via its identifier, the virtualNetworkInterfaceRequirements attribute + of the referenced intCpd applies. + + * - \_vduCpd + - VduCpd + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Reference to the internal VDU CPD which is used to instantiate internal CPs. These internal CPs are, in turn, + exposed as external CPs defined by this external CPD. + + +VnfIndicator +~~~~~~~~~~~~ + +The VnfIndicator information element defines the indicator the VNF +supports. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - id + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier. + + * - name + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The human readable name of the VnfIndicator. + + * - indicatorValue + - String + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the allowed values or value ranges of this indicator. + + * - source + - VnfSource + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describe the source of the indicator. This tells the consumer where to send the + subscription request. + + +VnfVirtualLink +~~~~~~~~~~~~~~ + +**Parent class:** VirtualLink + +Applied stereotypes: + +- OpenModelClass + +- support: MANDATORY + +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 +single instance of this component maps 1:1 against a single +Virtualisation Container. + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vnfcInstanceId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the NFC instance + + * - nfcNamingCode + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - short code of the NFC instance + + * - description + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - description of the NFC instance + + * - vdudId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - identifier of the model of the NFC instance + + * - l3InterfaceIpv4AddressList + - invalid + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - layer-3 interface addresses, ipv4 + + * - l3InterfaceIpv6AddressList + - invalid + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - layer-3 interface addresses, ipv6 + + * - vnfcState + - invalid + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - operating status of the VM valid value example: + STARTED (POWER_ON), + STOPPED (POWER_OFF) + + * - inMaint + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether the NFC instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc. + + * - isClosedLoopDisabled + - Boolean + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether closed loop function is enabled + + * - vnfcInstanceName + - String + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - An intelligent or human readable name of the vnfc instance. Multiple names are possible. + + * - \_vnfcCp + - VnfcCp + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Reference to the connection points of the vnfc + + * - vnfcNamingPolicyId + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Identifier of the policy which has the naming logic for this VNFC instance + + * - nfcFunction + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - English description of network function component that the specific VNFC deployment is providing. + + * - operationalStatus + - OperationalStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - indicator for whether the resource is considered operational. + Valid values are in-service-path and out-of-service-path. + + * - orchestrationStatus + - OrchestrationStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - whether the VNFC instance is instantiated + + * - closedLoopStatus + - ClosedLoopStatus + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Whether closed loop capabilities are enabled for this or not. + + * - \_vdu + - Vdu + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Reference to the VDU + + +VnfcCp +~~~~~~ + +**Parent class:** Cp + +Applied stereotypes: + +- Experimental + +- OpenModelClass + +- support: MANDATORY + +Vnfd +~~~~ + +A Vnfd, or VNF Descriptor, is template which describes a VNF in terms of +deployment and operational behaviour requirements. It also contains +connectivity, interface and virtualised resource requirements. +References: tosca-nfv-YAML-v1.0-wd05-rev02 (tosca.nodes.nfv.vnfd, but +node details are not defined) ETSI GS NFV-IFA 011 V2.1.3 (VNFD) + +**Parent class:** NetworkFunctionDesc + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vnfProvider + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Provider of the VNF and of the VNFD. + + * - vnfProductName + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Name to identify the VNF Product. + Invariant for the VNF Product lifetime. + + * - vnfSoftwareVersion + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Software version of the VNF. + This is changed when there is any change to the + software that is included in the VNF Package. + + * - vnfdVersion + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies the version of the VNFD. + + * - vnfProductInfoName + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable name for the VNF Product. + Can change during the VNF Product lifetime. + + * - vnfProductInfoDescription + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the VNF Product. + Can change during the VNF Product lifetime. + + * - vnfmInfo + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifies VNFM(s) compatible with the VNF described in this version of the VNFD. + + * - localizationLanguage + - String + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Information about localization languages of the VNF (includes e.g. strings in the VNFD). + NOTE: This allows to provide one or more localization languages to support selecting a + specific localization language at VNF instantiation time. + + * - modifiableAttributes + - VnfInfoModifiableAttributes + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the + ModifyVnfInfo operation. + + * - vnfdId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Identifier of this VNFD information element. This attribute shall be globally unique. + NOTE: The VNFD Identifier shall be used as the unique identifier of the VNF Package that + contains this VNFD. Any modification of the content of the VNFD or the VNF Package + shall result in a new VNFD Identifier. + + * - defaultLocalizationLanguage + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Information about localization languages of the VNF (includes e.g. strings in the VNFD). + NOTE: This allows to provide one or more localization languages to support selecting a + specific localization language at VNF instantiation time. + + * - configurableProperties + - VnfConfigurableProperties + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the configurable properties of the VNF (e.g. related to auto scaling and auto healing). + + * - lifecycleManagementScript + - LifecycleManagementScript + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Includes a list of events and corresponding management scripts performed for the VNF. + + * - logo + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - File path of the vendor specified logo. + + * - guide + - String + - 0..1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - UUID of the vendor guide/documentation which is attached to VNF and can be downloaded from the model. + + * - \_vdu + - Vdu + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Virtualisation Deployment Unit. + + * - \_vnfExtCpd + - VnfExtCpd + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes external interface(s) exposed by this VNF enabling connection with a VL. + + * - \_deploymentFlavour + - VnfDf + - 1..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes specific DF(s) of a VNF with specific requirements for capacity and performance. + + * - \_vnfIndicator + - VnfIndicator + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Declares the VNF indicators that are supported by this VNF. + + * - \_virtualComputeDesc + - VirtualComputeDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines descriptors of virtual compute resources to be used by the VNF. + + * - \_virtualStorageDesc + - VirtualStorageDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines descriptors of virtual storage resources to be used by the VNF. + + * - \_intVirtuallinkdesc + - LinkDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Represents the type of network connectivity mandated by the VNF provider + between two or more CPs which includes at least one internal CP. + + * - \_vnfReservedCpd + - VduCpd + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Reserved IP Address for VNF which is not bounded to any + specific VNFC, but assigned manually from outside and potentially + shared as a floating IP among VNFCs. + + * - \_elementGroup + - VnfdElementGroup + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the associated elements of a VNFD for a certain purpose + during VNF lifecycle management. + + +VnfdElementGroup +~~~~~~~~~~~~~~~~ + +A VNFD Element Group is a mechanism for associating elements of a VNFD +(Vdus and VnfVirtualLinkDesc(s)) for a certain purpose, for example, +scaling aspects. A given element can belong to multiple groups. + +Applied stereotypes: + +- Preliminary + +- OpenModelClass + +- support: MANDATORY + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Stereotypes** + - **Description** + + * - vnfdElementGroupId + - Identifier + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of this group in the VNFD. + + * - description + - String + - 1 + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable description of the group. + + * - \_vdu + - Vdu + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to Vdus that are part of this group. + + * - \_vnfVirtualLinkdesc + - LinkDesc + - 0..\* + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - References to VnfVirtualLinkDesc that are part of this group. + + +Data Type definition +-------------------- + +LifecycleManagementScript +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - event + - LcmEvent + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point. + + * - icmTransitionEvent + - String + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Describes the transition VNF lifecycle event(s) that cannot be mapped to any of + the enumerated values defined for the event attribute. + NOTE: At least one of these two attributes shall be included. + + * - script + - String + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Information to locate a VNF LCM script (e.g. written in a DSL as specified in requirement VNF_PACK.LCM.001) + triggered to react to one of the events listed in the event attribute. + + * - scriptDsl + - String + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Defines the domain specific language (i.e. the type) of script that is provided. + Types of scripts could include bash, python, etc. + + * - scriptInput + - KeyValuePair + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Array of KVP requirements with the key as the parameter name and the value as the parameter that need to be passed as an input to the script. + NOTE: The scriptInput values are passed to the scripts in addition to the parameters received in the operation invocation request or + indicator value change. + + +LogicalNodeData +~~~~~~~~~~~~~~~ + +This information element describes compute, memory and I/O requirements +that are to be associated with the logical node of infrastructure. The +logical node requirements are a sub-component of the VDU level +requirements. As an example for illustration purposes, a logical node +correlates to the concept of a NUMA cell in libvirt terminology. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - logicalNodeRequirement + - KeyValuePair + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The logical node-level compute, memory and I/O requirements. An array of key-value pairs + that articulate the deployment requirements. This could include the number of CPU cores + on this logical node, a memory configuration specific to a logical node (e.g. such as + available in the Linux kernel via the libnuma library) or a requirement related to the + association of an I/O device with the logical node. + + +MonitoringParameter +~~~~~~~~~~~~~~~~~~~ + +Specifies the virtualised resource related performance metric to be +tracked by the VNFM, e.g. for auto-scaling purposes. The VNFM collects +the values of performance metrics identified by this information element +from the VIM(s) using one or more locally initiated PM Jobs. These +values can be used as inputs to auto-scaling rules. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - id + - Identifier + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Unique identifier of the monitoring parameter. + + * - name + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Human readable name of the monitoring parameter. + + * - performanceMetric + - String + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - + + * - collectionPeriod + - invalid + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - An attribute that describes the recommended periodicity at which to collect the performance information. + VNFM determines if this parameter is considered. The vendor may provide this information as a guidance for + creating PmJobs if needed. + NOTE: The MANO or NFVI may not support the recommended collectionPeriod based on their functionalities, and can + reject the requests based on the recommended collectionPeriod in this case. + + +QoS +~~~ + +The QoS information element describes QoS data for a given VL used in a +DF. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - latency + - Number + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Maximum latency in ms. + + * - packetDelayVariation + - Number + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Maximum jitter in ms. + + * - packetLossRatio + - Number + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Maximum packet loss ratio. Cardinality is 0 if no packetLossRatio requirement exists. + + +RequestedAdditionalCapabilityData +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This information element describes requested additional capability for a +particular VDU. Such a capability may be for acceleration or specific +tasks. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - supportMandatory + - Boolean + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Indicates whether the requested additional capability is mandatory for successful operation. + + * - requestedAdditionalCapabilityName + - String + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Identifies a requested additional capability for the VDU. + + * - minRequestedAdditionalCapabilityVersion + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Identifies the minimum version of the requested additional capability. + + * - preferredRequestedAdditionalCapabilityVersion + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Identifies the preferred version of the requested additional capability. + + * - targetPerformanceParameters + - KeyValuePair + - 1..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - Identifies specific attributes, dependent on the requested additional capability type. + + +ScaleInfo +~~~~~~~~~ + +The ScaleInfo information element represents a scale level for a +particular scaling aspect. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - aspectId + - Identifier + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Reference to the scaling aspect. + + * - scaleLevel + - Integer + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - The scale level, greater than or equal to 0 + + +VirtualCpuData +~~~~~~~~~~~~~~ + +The VirtualCpuData information element supports the specification of +requirements related to virtual CPU(s) of a virtual compute resource. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - cpuArchitecture + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - CPU architecture type. Examples are x86, ARM. The cardinality can be 0 during the allocation request, if no particular CPU architecture type is requested. + + * - numVirtualCpu + - Integer + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Number of virtual CPUs. + + * - virtualCpuClock + - Number + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Minimum virtual CPU clock rate (e.g. in MHz). The cardinality can be 0 during the allocation request, if no particular value is requested. + + * - virtualCpuOversubscriptionPolicy + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - The CPU core oversubscription policy e.g. the relation of virtual CPU cores to physical CPU cores/threads. The cardinality can be 0 during the allocation request, if no particular value is requested. + + * - vduCpuRequirements + - KeyValuePair + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Array of key-value pair requirements on the Compute (CPU) for the VDU. + + * - virtualCpuPinning + - VirtualCpuPinningData + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - The virtual CPU pinning configuration for the virtualised compute resource. + + +VirtualCpuPinningData +~~~~~~~~~~~~~~~~~~~~~ + +The VirtualCpuPinningData information element supports the specification +of requirements related to the virtual CPU pinning configuration of a +virtual compute resource. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - virtualCpuPinningPolicy + - PinningPolicy + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - The policy can take values of "static" or "dynamic". In case of "static" the virtual CPU cores are requested to be allocated to logical CPU cores according to the rules defined in virtualCpuPinningRules. + In case of "dynamic" the allocation of virtual CPU cores to logical CPU cores is decided by the VIM. (e.g.: SMT (Simultaneous Multi-Threading) requirements). + + * - virtualCpuPinningRule + - invalid + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - A list of rules that should be considered during the allocation of the virtual CPUs to logical CPUs in case of "static" virtualCpuPinningPolicy. + + +VirtualLinkBitRateLevel +~~~~~~~~~~~~~~~~~~~~~~~ + +The VirtualLinkBitRateLevel information element specifies bitrate +requirements applicable to a virtual link instantiated from a particular +VnfVirtualLinkDesc. + +VirtualMemoryData +~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - virtualMemSize + - Number + - 1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Amount of virtual Memory (e.g. in MB). + + * - virtualMemOversubscriptionPolicy + - String + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + + Obsolete + - The memory core oversubscription policy in terms of virtual memory to physical memory on the platform. The cardinality can be 0 during the allocation request, if no particular value is requested. + + * - vduMemRequirements + - KeyValuePair + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - Array of key-value pair requirements on the memory for the VDU. + + * - numaEnabled + - Boolean + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Obsolete + - It specifies the memory allocation to be cognisant of the relevant process/core allocation. The cardinality can be 0 during the allocation request, if no particular value is requested. + + +VnfConfigurableProperties +~~~~~~~~~~~~~~~~~~~~~~~~~ + +This datatype defines the configurable properties of a VNF (e.g. related +to auto scaling and auto healing). For a VNF instance, the value of +these properties can be modified by the VNFM + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - isAutoscaleEnabled + - Boolean + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - It permits to enable (TRUE)/disable (FALSE) the auto-scaling functionality. + NOTE: A cardinality of "0" indicates that configuring this present VNF property is not supported. + + * - isAutohealEnabled + - Boolean + - 0..1 + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - It permits to enable (TRUE)/disable (FALSE) the auto-healing functionality. + NOTE: A cardinality of "0" indicates that configuring this present VNF property is not supported. + + * - additionalConfigurableProperty + - String + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - + + +VnfInfoModifiableAttributes +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This datatype defines the VNF-specific extension and metadata attributes +of the VnfInfo that are writeable via the ModifyVnfInfo operation. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - extension + - invalid + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - "Extension" attributes of VnfInfo that are writeable. + + * - metadata + - invalid + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Experimental + - Metadata" attributes of VnfInfo that are writeable + + +VnfcConfigurableProperties +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This datatype defines the configurable properties of a VNFC. For a VNFC +instance, the value of these properties can be modified through the +VNFM. + +.. list-table:: + :header-rows: 1 + + + * - **AttributeName** + - **Type** + - **Mult.** + - **Access** + - **Stereotypes** + - **Description** + + * - additionalVnfcConfigurableProperty + - String + - 0..\* + - RW + - OpenModelAttribute + + - isInvariant: false + - valueRange: no range constraint + - support: MANDATORY + + Preliminary + - It provides VNFC configurable properties that can be modified using the ModifyVnfInfo operation. + + +Enumeration definition +---------------------- + +AddressType +~~~~~~~~~~~ + +Type of address + +Contains Enumeration Literals: + +- MAC: + +- IP: + +ClosedLoopStatus +~~~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- ENABLED: + +- DISABLED: + +CollectionPeriod +~~~~~~~~~~~~~~~~ + +Specifies the periodicity at which the producer will collect performance +information. + +Contains Enumeration Literals: + +HomingStrategy +~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- Colocation: + +- isolation: + +LcmEvent +~~~~~~~~ + +Describes VNF lifecycle event(s) or an external stimulus detected on a +VNFM reference point. + +Contains Enumeration Literals: + +- EVENT_START_INSTANTIATION: + +- EVENT_END_INSTANTIATION: + +- EVENT_START_SCALING: + +- EVENT_END_SCALING: + +- EVENT_START_SCALING_TO_LEVEL: + +- EVENT_END_SCALING_TO_LEVEL: + +- EVENT_START_HEALING: + +- EVENT_END_HEALING: + +- EVENT_START_TERMINATION: + +- EVENT_END_TERMINATION: + +- EVENT_START_VNF_FLAVOR_CHANGE: + +- EVENT_END_VNF_FLAVOR_CHANGE: + +- EVENT_START_VNF_OPERATION_CHANGE: + +- EVENT_END_VNF_OPERATION_CHANGE: + +- EVENT_START_VNF_EXT_CONN_CHANGE: + +- EVENT_END_VNF_EXT_CONN_CHANGE: + +- EVENT_START_VNFINFO_MODIFICATION: + +- EVENT_END_VNFINFO_MODIFICATION: + +OperationalStatus +~~~~~~~~~~~~~~~~~ + +Indicator for whether the resource is considered operational. Valid +values are in-service-path and out-of-service-path. + +Contains Enumeration Literals: + +- IN-SERVICE-PATH: + +- OUT-OF-SERVICE-PATH: + +OrchestrationStatus +~~~~~~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- INVENTORIED: + +- ASSIGNED: + +- CREATED: + +- ACTIVE: + +PinningPolicy +~~~~~~~~~~~~~ + +Defines the CPU pinning policy. + +Contains Enumeration Literals: + +- STATIC: + +- DYNAMIC: + +PlacementStrategy +~~~~~~~~~~~~~~~~~ + +Contains Enumeration Literals: + +- COLOCATION: + +- ISOLATION: + +- EXCLUSIVITY: + +ProvStatus +~~~~~~~~~~ + +Provisioning status, used as a trigger for operational monitoring of +this resource by service assurance systems. + +Contains Enumeration Literals: + +- PROVISIONED: + +- PREPROVISIONED: + +- CAPPED: + +VnfSource +~~~~~~~~~ + +Describes the source of the indicator. + +Contains Enumeration Literals: + +- VNF: + +- EM: + +- BOTH: + +VnicType +~~~~~~~~ + +Describes the type of VNIC to which a CP attaches. + +Contains Enumeration Literals: + +- NORMAL: + +- MACVTAP: + +- DIRECT: + +- BAREMETAL: + +- DIRECT_PHYSICAL: + +- VIRTIO_FORWARDER: \ No newline at end of file diff --git a/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst b/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst deleted file mode 100644 index 7d0ba0c..0000000 --- a/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst +++ /dev/null @@ -1,3909 +0,0 @@ -.. 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 - -ONAP Vnfd and VnfInstance Model -=============================== - -.. contents:: - :depth: 3 -.. - -Class Definition ----------------- - -BaseConfigGroup -~~~~~~~~~~~~~~~ - -Every Vnf contains a BaseConfigGroup. BaseConfigGroup may set Access -Control Lists (ACL's) and establish security groups and server groups. -BaseConfigGroup reates/establishs storage for the VM's (OpenStack -Cinder). BaseConfigGroup may establish internal networks such as OAM -(VNF Mgmt) or MNS (Maintenance & Surveillance) established. A very -simple VNF may only have a BaseConfig VnfElementGroup. - -**Parent class:** VnfdElementGroup - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -DeploymentGroup -~~~~~~~~~~~~~~~ - -DeploymentGroup provides the minimum viable VDU and associated VNFC -configuration for a useable VNF. I can have a small, medium, large -deployment configuration. - -**Parent class:** VnfdElementGroup - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -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 -respect to a service component. Homing strategy is as follows: -Colocation - members of the group share the same cloud region (VIM -Domain) isolation - members of the group do not share the same cloud -region. - -**Parent class:** VnfdElementGroup - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - homingStrategy - - HomingStrategy - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - The homing strategy can be one of the following: - Exclusivity - - Resources within the cloud region are exclusive to the group - Inclusively - - Resources are co-located in the same cloud-region. - Diversity - - Resources are geo-diverse (cannot be co-located). - - * - vnfdMembers - - invalid - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - - - * - vnfdElementGroupId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier of this group in the VNFD. - - * - description - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable description of the group. - - * - \_vdu - - Vdu - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - References to Vdus that are part of this group. - - * - \_vnfVirtualLinkdesc - - LinkDesc - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - References to VnfVirtualLinkDesc that are part of this group. - - -InstantiationLevel -~~~~~~~~~~~~~~~~~~ - -The InstantiationLevel class describes a given level of resources to be -instantiated within a DF in term of the number of VNFC instances to be -created from each VDU. All the VDUs referenced in the level shall be -part of the corresponding DF and their number shall be within the range -(min/max) for this DF. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - levelId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Uniquely identifies a level with the DF. - - * - description - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable description of the level. - - * - scaleInfo - - ScaleInfo - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Represents for each aspect the scale level that corresponds to this instantiationlevel. - scaleInfo shall be present if the VNF supports scaling. - - * - \_vduLevel - - VduLevel - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Indicates the number of instance of this VDU to deploy for this level. - - * - virtualLinkBitRateLevel - - VirtualLinkBitRateLevel - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies bitrate requirements applicable to virtual links created from particular virtual link descriptors for this level. - NOTE: If not present, it is assumed that the bitrate requirements can be derived from those specified in the VduCpd instances applicable to the internal VL. If present in - both the InstantiationLevel and the VduCpd instances applicable to the internal VL, the highest value takes precedence. - -LinkDesc -~~~~~~~~ - -A communication channel that connects two or more devices, nodes, or entities. - -**Parent class:** ResourceDesc (ResourceSpecification) - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -- Preliminary - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - virtualLinkDescId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary - - Unique identifier of this internal VLD in VNFD. - - * - connectivityType - - ConnectivityType - - 1 - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary - - Specifies the protocol exposed by a VL and the flow pattern supported by the VL. - - * - testAccess - - String - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary - - Specifies test access facilities expected on the VL (e.g. none, passive monitoring, or active (intrusive) loopbacks at endpoints). - - * - description - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary - - Provides human-readable information on the purpose of the VL (e.g. control plane traffic). - - * - monitoringParameter - - MonitoringParameter - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary - - Defines the virtualised resources monitoring parameters on VLD level. - - * - \_virtuaLlinkDescFlavour - - VirtualLinkDescFlavour - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - - valueRange: no range constraint - - - support: MANDATORY - - Preliminary - - Describes a specific flavour of the VL with specific bitrate requirements. - - -PlacementGroup -~~~~~~~~~~~~~~ - -**Parent class:** VnfdElementGroup - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - placementStrategy - - PlacementStrategy - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - - - * - strategScope - - invalid - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - - - * - vnfdElementGroupId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier of this group in the VNFD. - - * - description - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable description of the group. - - * - \_vdu - - Vdu - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - References to Vdus that are part of this group. - - * - \_vnfVirtualLinkdesc - - LinkDesc - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - References to VnfVirtualLinkDesc that are part of this group. - - -ScalingAspect -~~~~~~~~~~~~~ - -The ScalingAspect class describes the details of an aspect used for -horizontal scaling. - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -ScalingGroup -~~~~~~~~~~~~ - -A ScalingGroup determines which VNFC's (VDU's) are scaled together based -on demand. - -**Parent class:** VnfdElementGroup - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -SwImageDesc -~~~~~~~~~~~ - -The SwImageDesc information element describes requested additional -capability for a particular VDU. Such a capability may be for -acceleration or specific tasks. Storage not necessarily related to the -compute, may be Network Attached Storage (NAS) References: -tosca-nfv-YAML-v1.0-wd05-rev02 ETSI GS NFV-IFA 011 V2.1.3 - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - id - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The identifier of this software image. - - * - name - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The name of this software image. - - * - version - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The version of this software image. - - * - checksum - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The checksum of the software image file. - - * - containerFormat - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The container format describes the container file format in which software image is provided. - - * - diskFormat - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The disk format of a software image is the format of the underlying disk image. - - * - minRam - - Number - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The minimal RAM requirement for this software image. The value of the "size" attribute of VirtualMemoryData of the Vdu referencing this - SwImageDesc shall not be smaller than the value of minRam. - - * - minDisk - - Number - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The minimal disk size requirement for this software image. The value of the "size of storage" attribute of the - VirtualStorageDesc referencing this SwImageDesc shall not be smaller than the value of minDisk. - - * - size - - Number - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The size of the software image. - - * - operatingSystem - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies the operating system used in the software image. This attribute may also identify if a 32 bit or 64 bit software image is used. - support: - - * - supportedVirtualisationEnvironment - - String - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies the virtualisation environments (e.g. hypervisor) compatible with this software image. - - * - swImage - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The minimal disk size requirement for this software image. The value of the "size of storage" attribute of the VirtualStorageDesc referencing this SwImageDesc - shall not be smaller than the value of minDisk. - - -Vdu -~~~ - -The Virtualisation Deployment Unit (VDU) is a construct supporting the -description of the deployment and operational behavior of a VNFC. A VNFC -instance created based on the VDU maps to a single virtualisation -container (e.g. a VM). A VNFC will only be in one VNFDesc. If a vendor -wants to use the VNFC in mupliple VNFDesc (their product) they can do -so, but it will be 'repeated'. References: -tosca-nfv-YAML-v1.0-wd05-rev02 ETSI GS NFV-IFA 011 V2.1.3 - -Applied stereotypes: - -- Preliminary -- OpenModelClass -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - vduId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier of this Vdu in VNFD. - - * - name - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable name of the Vdu. - - * - description - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable description of the Vdu. - - * - bootOrder - - KeyValuePair - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Boot order of valid boot devices. - NOTE: If no boot order is defined the default boot order defined in the VIM or NFVI shall be used. - - * - nfviConstraint - - KeyValuePair - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes constraints on the NFVI for the VNFC instance(s) created from this Vdu. For example, aspects of a secure hosting environment - for the VNFC instance that involve additional entities or processes. - NOTE: These are constraints other than stipulating that a VNFC instance has access to a certain resource, as a prerequisite to instantiation. - The attributes virtualComputeDesc and virtualStorageDesc define the resources required for instantiation of the VNFC instance. - - * - monitoringParameter - - MonitoringParameter - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Defines the virtualised resources monitoring parameters on VDU level. - - * - injectFiles - - String - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the information (e.g. URL) about the scripts, config drive metadata, etc. which can be used during Vdu booting process. - - * - configurableProperties - - VnfcConfigurableProperties - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the configurable properties of all VNFC instances based on this VDU. - - * - \_vduCpd - - VduCpd - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes network connectivity between a VNFC instance (based on this Vdu) and an Virtual Link (VL). - - * - \_virtualComputeDesc - - VirtualComputeDesc - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes CPU, Memory and acceleration requirements of the Virtualisation Container realising this Vdu. - - * - \_virtualStorageDesc - - VirtualStorageDesc - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes storage requirements for a VirtualStorage instance attached to the virtualisation container created from - virtualComputeDesc defined for this Vdu. - - * - \_swImageDesc - - SwImageDesc - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the software image which is directly loaded on the virtualisation - container realising this Vdu. - NOTE: More software images can be attached to the virtualisation container using VirtualStorage resources. - - -VduCpd -~~~~~~ - -A VduCpd information element is a type of Cpd and describes network -connectivity between a VNFC instance (based on this VDU) and an internal -VL. - -**Parent class:** Cpd - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - bitrateRequirement - - Number - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Bitrate requirement on this CP. - - * - vnicName - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the name of the vNIC this CP attaches to, e.g. eth0. It will be configured during the Vdu booting process. - - * - vnicOrder - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the order to create the vNIC within the scope of this Vdu. - - * - vnicType - - VnicType - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the type of the vNIC this CP attaches to. - - * - \_virtualNetworkInterfaceRequirements - - VirtualNetworkInterfaceRequirements - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. - - * - cpdId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifier of this Cpd information element. - - * - cpRole - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies the role of the port in the context of the traffic flow - patterns in the VNF or parent NS. For example a VNF with a tree flow - pattern within the VNF will have legal cpRoles of ROOT and LEAF. - - * - description - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Provides human-readable information on the purpose of the CP (e.g. CP for control plane traffic). - - * - cpProtocol - - CpProtocolData - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies the protocol layering information the CP uses for connectivity - purposes and associated information. There shall be one cpProtocol for each layer - protocol as indicated by the attribute layerProtocol. - Editor's note: the attribute "layerProtocol" still needs further discussion and not included in this table. - - * - trunkMode - - Boolean - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Information about whether the CP instantiated from this CPD is in Trunk mode (802.1Q or other). - - * - allowedAddressData - - AddressData - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - For specifying floating IP(s) to be shared among Cpds, which are reserved for vnfReservedCpd described in the VNFD. - - -VduLevel -~~~~~~~~ - -The VduLevel information element indicates for a given VDU in a given -level the number of instances to deploy. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - vduId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Uniquely identifies a VDU. - - * - numberOfInstances - - Integer - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Number of instances of VNFC based on this VDU to deploy for an instantiation level or for a scaling delta. - - -VduProfile -~~~~~~~~~~ - -The VduProfile describes additional instantiation data for a given VDU -used in a DF. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - vdudId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Uniquely identifies a VDU. - - * - minNumberOfInstances - - Integer - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Minimum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. - - * - maxNumberOfInstances - - Integer - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Maximum number of instances of the VNFC based on this VDU that is permitted to exist for this flavour. - - * - localAffinityOrAntiAffinityRule - - LocalAffinityOrAntiAffinityRule - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies affinity or anti-affinity rules applicable between the virtualisation containers (e.g. virtual machines) - to be created based on this VDU. - - * - affinityOrAntiAffinityGroupId - - Identifier - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifier(s) of the affinity or anti-affinity group(s) the VDU belongs to. - NOTE: Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity - relationships between the virtualisation container(s) (e.g. virtual machine(s)) to be created using this VDU and the - virtualisation container(s) (e.g. virtual machine(s)) to be created using other VDU(s) in the same group. - - * - watchdog - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Watchdog action to be triggered by the VIM for the VNF in case the heart beat fails, e.g. reset or hard shutdown, etc. - - * - vmBootUpTimeOut - - Integer - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Timeout value for the VNFM to wait before the successful booting up of the VDU. - - -VirtualComputeDesc -~~~~~~~~~~~~~~~~~~ - -The VirtualComputeDesc information element supports the specification of -requirements related to virtual compute resources. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - virtualComputeDescId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier of this VirtualComputeDesc in the VNFD - - * - logicalNode - - LogicalNodeData - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The logical Node requirements. - - * - requestAdditionalCapabilities - - RequestedAdditionalCapabilityData - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - Specifies requirements for additional capabilities. These may be for a range of purposes. - One example is acceleration related capabilities. - - * - computeRequirements - - KeyValuePair - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies compute requirements. - - * - virtualMemory - - VirtualMemoryData - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The virtual memory of the virtualised compute. - - * - virtualCpu - - VirtualCpuData - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The virtual CPU(s) of the virtualised compute. - - -VirtualLinkDescFlavour -~~~~~~~~~~~~~~~~~~~~~~ - -The VirtualLinkDescFlavour describes additional instantiation data for a -given internal VL used in a DF. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - qos - - QoS - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - QoS of the VL. - - * - flavourId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies a flavour within a VnfVirtualLinkDesc. - - -VirtualLinkProfile -~~~~~~~~~~~~~~~~~~ - -The VirtualLinkProfile describes additional instantiation data for a -given VL used in a DF. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - localAffinityOrAntiAffinityRule - - LocalAffinityOrAntiAffinityRule - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies affinity or anti-affinity rules applicable between the VLs based on this - VnfVirtualLinkDesc. When the cardinality is greater than 1, both affinity rule(s) and anti-affinity - rule(s) with different scopes are applicable to the VLs based on this VnfVirtualLinkDesc. - - * - affinityOrAntiAffinityGroupId - - Identifier - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifier(s) of the affinity or anti-affinity group(s) the VnfVirtualLinkDesc belongs to. - NOTE: Each identifier references an affinity or anti-affinity group which expresses affinity or anti-affinity - relationship between the VL(s) using this VnfVirtualLinkDesc and the VL(s) using other VnfVirtualLinkDesc(s) - in the same group. - - * - maxBitRateRequirements - - LinkBitrateRequirements - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies the minimum bitrate requirements for a VL instantiated - according to this profile. - - * - minBitRateRequirements - - LinkBitrateRequirements - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies the minimum bitrate requirements for a VL instantiated according to this profile. - - * - initiationParameters - - KeyValuePair - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies initiation parameters for the virtual link. - - * - networkType - - NetworkType - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Type of the network - - * - dhcpEnabled - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Indicating whether DHCP is enabled. Default is "FALSE" if not specified otherwise. - - * - vlanTransparent - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Indicating whether "VLAN Transparent Mode" is supported. - Default is "FALSE" if not specified otherwise. - - * - \_virtualLinkDescFlavour - - VirtualLinkDescFlavour - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies a flavour within the VnfVirtualLinkDesc. - - * - \_virtualLinkDesc - - LinkDesc - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Uniquely identifies a Vnf VLD. - - -VirtualNetworkInterfaceRequirements -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This class specifies requirements on a virtual network interface. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - name - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Provides a human readable name for the requirement. - - * - description - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Provides a human readable description of the requirement. - - * - supportMandatory - - Boolean - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Indicates whether fulfilling the constraint is mandatory (TRUE) for successful operation or - desirable (FALSE). - - * - networkInterfaceRequirements - - KeyValuePair - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The network interface requirements. An element from an array of key-value pairs that - articulate the network interface deployment requirements - - * - nicIoRequirements - - LogicalNodeData - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - This references (couples) the CPD with any logical node I/O requirements (for network devices) that may have been created. - Linking these attributes is necessary so that so that I/O requirements - that need to be articulated at the logical node level can be associated with the network interface requirements - associated with the CPD. - - -VirtualStorageDesc -~~~~~~~~~~~~~~~~~~ - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - id - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier of this VirtualStorageDesc in the VNFD. - - * - typeOfStorage - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Type of virtualised storage resource (e.g. volume, object). - - * - sizeOfStorage - - Number - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Size of virtualised storage resource (e.g. size of volume, in GB). - - * - vduStorageRequirements - - KeyValuePair - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - An array of key-value pairs that articulate the storage deployment requirements. - - * - rdmaEnabled - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - Indicate if the storage support RDMA. - - * - swImageDesc - - Identifier - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Software image to be loaded on the VirtualStorage resource created - based on this VirtualStorageDesc. - -Vnf -~~~ - -An implementation of an NF that can be deployed on a Network Function -Virtualisation Infrastructure (NFVI). - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - vnfInstanceId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - identifier of the VNF instance - - * - vnfInstanceName - - String - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - name of the VNF instance. Multiple names are possible. - - * - vnfProductName - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - name to identify the VNF Product, invariant for the VNF Product lifetime - - * - description - - invalid - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - description of the VNF instance - - * - vnfProvider - - invalid - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - provider of the VNF model - - * - vnfdId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - identifier of the VNF model - - * - vnfdVersion - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - version of the VNF model - - * - vnfSoftwareVersion - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Software version of the VNF. This is changed when there is any change to the software that is included in the VNF package - - * - onboardedVnfPkgInfoId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - identifier of the specific VNF package on which the VNF instance is based - - * - availabilityZone - - invalid - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - availability zone information of the VNF instance - - * - operationalStatus - - OperationalStatus - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - indicator for whether the resource is considered operational. - Valid values are in-service-path and out-of-service-path. - - * - orchestrationStatus - - OrchestrationStatus - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - whether the VNF instance is instantiated - - * - oamlpv4Address - - invalid - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - oam ip address, ipv4 - - * - oamlpv6Address - - invalid - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - oam ip address, ipv6 - - * - instantiatedVnfInfo - - invalid - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - information specific to an instantiated VNF instance, e.g., vm information - - * - inMaint - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - whether the VNF instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc. - - * - isClosedLoopDisabled - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - whether closed loop function is enabled - - * - encryptedAccessFlag - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - whether this VNF is accessed using SSH - - * - vnfConfigurableProperty - - invalid - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - indicator for whether autoHeal and autoScale is enabled - - * - nfNamingCode - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - String assigned to this model used for naming purpose. - - * - vnfNamingPolicyId - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Identifier of the policy which has the naming logic for this VNF instance - - * - vnfHomingPolicyId - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Identifier of the policy which provides homing conditions. - - * - nfType - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Generic description of the type of network function - - * - nfFunction - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - English description of network function that the specific VNF deployment is providing. - - * - nfRole - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Role in the network this model will be providing - - * - closedLoopStatus - - ClosedLoopStatus - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Whether closed loop capabilities are enabled for this or not. - - * - \_nfc(vnfcinstance) - - Vnfc - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Relatonship to the NF components that are part of this VNF. - - * - \_vnfd - - Vnfd - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Relationship to the VNF descriptor - - * - \_vnfvirtuallink - - VnfVirtualL ink - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Relationship to VnfVirtualLink - - -VnfDf -~~~~~ - -The VnfDf describes a specific deployment version of a VNF. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - flavorId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifier of this DF within the VNFD. - - * - description - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable description of the DF. - - * - \_virtuaLlinkProfile - - VirtualLinkProfile - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Defines the internal VLD along with additional data which is used in this DF. - NOTE 1: This allows for different VNF internal topologies between DFs. - NOTE 2: virtualLink Profile needs to be provided for all VLs that the CPs of the VDUs in the VDU profiles connect to. - - * - \_instantiationLevel - - InstantiationLevel - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the various levels of resources that can be used to instantiate the VNF using this flavour. - Examples: Small, Medium, Large. If there is only one "instantiationLevel" entry, it shall be treated as - the default instantiation level for this DF. - - * - \_affinityOrAntiAffinityGroup - - AffinityOrAntiAffinityGroup - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies affinity or anti-affinity relationship applicable between the virtualisation containers - (e.g. virtual machines) to be created using different VDUs or internal VLs to be created using - different VnfVirtualLinkDesc(s) in the same affinity or anti-affinity group. - NOTE: In the present specification, including either VDU(s) or VnfVirtualLinkDesc(s) into the - same affinity or anti-affinity group is supported. Extension to support including both VDU(s) - and VnfVirtualLinkDesc(s) into the same affinity or anti-affinity group is left for future - specification. - - * - \_scalingAspect - - ScalingAspect - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The scaling aspects supported by this DF of the VNF. - scalingAspect shall be present if the VNF supports scaling. - - * - \_vduProfile - - VduProfile - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes additional instantiation data for the VDUs used in this flavor. - - * - \_placementGroup - - PlacementGroup - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Determine where VNFC's (VDU's) are placed with respect to the VNF - - * - \_baseConfigGroup - - BaseConfigGroup - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - BaseConfigGroup may set Access Control Lists (ACL's) and establish security - groups and server groups. - BaseConfigGroup creates/establishs storage for the VM's (OpenStack Cinder). - BaseConfigGroup may establish internal networks such as OAM (VNF Mgmt) or MNS - (Maintenance & Surveillance) established. - - * - \_deploymentGroup - - DeploymentGroup - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - DeploymentGroup provides the minimum viable VDU and associated VNFC configuration - for a useable VNF. - - * - \_scalinggroup - - ScalingGroup - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies the vaious scaling groups within the VNF which identify which vnfcs that need to be scaled together. - - -VnfExtCp -~~~~~~~~ - -Describes an external CP exposed by a VNF. - -**Parent class:** Cp - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -VnfExtCpd -~~~~~~~~~ - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - \_virtualNetworkInterfaceRequirements - - VirtualNetworkInterfaceRequirements - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD. - NOTE: In case of referencing an intCpd via its identifier, the virtualNetworkInterfaceRequirements attribute - of the referenced intCpd applies. - - * - \_vduCpd - - VduCpd - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Reference to the internal VDU CPD which is used to instantiate internal CPs. These internal CPs are, in turn, - exposed as external CPs defined by this external CPD. - - -VnfIndicator -~~~~~~~~~~~~ - -The VnfIndicator information element defines the indicator the VNF -supports. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - id - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier. - - * - name - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The human readable name of the VnfIndicator. - - * - indicatorValue - - String - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Defines the allowed values or value ranges of this indicator. - - * - source - - VnfSource - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describe the source of the indicator. This tells the consumer where to send the - subscription request. - - -VnfVirtualLink -~~~~~~~~~~~~~~ - -**Parent class:** VirtualLink - -Applied stereotypes: - -- OpenModelClass - -- support: MANDATORY - -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 -single instance of this component maps 1:1 against a single -Virtualisation Container. - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - vnfcInstanceId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - identifier of the NFC instance - - * - nfcNamingCode - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - short code of the NFC instance - - * - description - - invalid - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - description of the NFC instance - - * - vdudId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - identifier of the model of the NFC instance - - * - l3InterfaceIpv4AddressList - - invalid - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - layer-3 interface addresses, ipv4 - - * - l3InterfaceIpv6AddressList - - invalid - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - layer-3 interface addresses, ipv6 - - * - vnfcState - - invalid - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - operating status of the VM valid value example: - STARTED (POWER_ON), - STOPPED (POWER_OFF) - - * - inMaint - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - whether the NFC instance is in maintenance mode, if yes, DCAE will not observe alarms/traps, etc. - - * - isClosedLoopDisabled - - Boolean - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - whether closed loop function is enabled - - * - vnfcInstanceName - - String - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - An intelligent or human readable name of the vnfc instance. Multiple names are possible. - - * - \_vnfcCp - - VnfcCp - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Reference to the connection points of the vnfc - - * - vnfcNamingPolicyId - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Identifier of the policy which has the naming logic for this VNFC instance - - * - nfcFunction - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - English description of network function component that the specific VNFC deployment is providing. - - * - operationalStatus - - OperationalStatus - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - indicator for whether the resource is considered operational. - Valid values are in-service-path and out-of-service-path. - - * - orchestrationStatus - - OrchestrationStatus - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - whether the VNFC instance is instantiated - - * - closedLoopStatus - - ClosedLoopStatus - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Whether closed loop capabilities are enabled for this or not. - - * - \_vdu - - Vdu - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Reference to the VDU - - -VnfcCp -~~~~~~ - -**Parent class:** Cp - -Applied stereotypes: - -- Experimental - -- OpenModelClass - -- support: MANDATORY - -Vnfd -~~~~ - -A Vnfd, or VNF Descriptor, is template which describes a VNF in terms of -deployment and operational behaviour requirements. It also contains -connectivity, interface and virtualised resource requirements. -References: tosca-nfv-YAML-v1.0-wd05-rev02 (tosca.nodes.nfv.vnfd, but -node details are not defined) ETSI GS NFV-IFA 011 V2.1.3 (VNFD) - -**Parent class:** NetworkFunctionDesc - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - vnfProvider - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Provider of the VNF and of the VNFD. - - * - vnfProductName - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Name to identify the VNF Product. - Invariant for the VNF Product lifetime. - - * - vnfSoftwareVersion - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Software version of the VNF. - This is changed when there is any change to the - software that is included in the VNF Package. - - * - vnfdVersion - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies the version of the VNFD. - - * - vnfProductInfoName - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable name for the VNF Product. - Can change during the VNF Product lifetime. - - * - vnfProductInfoDescription - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable description of the VNF Product. - Can change during the VNF Product lifetime. - - * - vnfmInfo - - String - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifies VNFM(s) compatible with the VNF described in this version of the VNFD. - - * - localizationLanguage - - String - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Information about localization languages of the VNF (includes e.g. strings in the VNFD). - NOTE: This allows to provide one or more localization languages to support selecting a - specific localization language at VNF instantiation time. - - * - modifiableAttributes - - VnfInfoModifiableAttributes - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Defines the VNF-specific extension and metadata attributes of the VnfInfo that are writeable via the - ModifyVnfInfo operation. - - * - vnfdId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Identifier of this VNFD information element. This attribute shall be globally unique. - NOTE: The VNFD Identifier shall be used as the unique identifier of the VNF Package that - contains this VNFD. Any modification of the content of the VNFD or the VNF Package - shall result in a new VNFD Identifier. - - * - defaultLocalizationLanguage - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Information about localization languages of the VNF (includes e.g. strings in the VNFD). - NOTE: This allows to provide one or more localization languages to support selecting a - specific localization language at VNF instantiation time. - - * - configurableProperties - - VnfConfigurableProperties - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the configurable properties of the VNF (e.g. related to auto scaling and auto healing). - - * - lifecycleManagementScript - - LifecycleManagementScript - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Includes a list of events and corresponding management scripts performed for the VNF. - - * - logo - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - File path of the vendor specified logo. - - * - guide - - String - - 0..1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - UUID of the vendor guide/documentation which is attached to VNF and can be downloaded from the model. - - * - \_vdu - - Vdu - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Virtualisation Deployment Unit. - - * - \_vnfExtCpd - - VnfExtCpd - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes external interface(s) exposed by this VNF enabling connection with a VL. - - * - \_deploymentFlavour - - VnfDf - - 1..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes specific DF(s) of a VNF with specific requirements for capacity and performance. - - * - \_vnfIndicator - - VnfIndicator - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Declares the VNF indicators that are supported by this VNF. - - * - \_virtualComputeDesc - - VirtualComputeDesc - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Defines descriptors of virtual compute resources to be used by the VNF. - - * - \_virtualStorageDesc - - VirtualStorageDesc - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Defines descriptors of virtual storage resources to be used by the VNF. - - * - \_intVirtuallinkdesc - - LinkDesc - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Represents the type of network connectivity mandated by the VNF provider - between two or more CPs which includes at least one internal CP. - - * - \_vnfReservedCpd - - VduCpd - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Reserved IP Address for VNF which is not bounded to any - specific VNFC, but assigned manually from outside and potentially - shared as a floating IP among VNFCs. - - * - \_elementGroup - - VnfdElementGroup - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the associated elements of a VNFD for a certain purpose - during VNF lifecycle management. - - -VnfdElementGroup -~~~~~~~~~~~~~~~~ - -A VNFD Element Group is a mechanism for associating elements of a VNFD -(Vdus and VnfVirtualLinkDesc(s)) for a certain purpose, for example, -scaling aspects. A given element can belong to multiple groups. - -Applied stereotypes: - -- Preliminary - -- OpenModelClass - -- support: MANDATORY - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Stereotypes** - - **Description** - - * - vnfdElementGroupId - - Identifier - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier of this group in the VNFD. - - * - description - - String - - 1 - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable description of the group. - - * - \_vdu - - Vdu - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - References to Vdus that are part of this group. - - * - \_vnfVirtualLinkdesc - - LinkDesc - - 0..\* - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - References to VnfVirtualLinkDesc that are part of this group. - - -Data Type definition --------------------- - -LifecycleManagementScript -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - event - - LcmEvent - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes VNF lifecycle event(s) or an external stimulus detected on a VNFM reference point. - - * - icmTransitionEvent - - String - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Describes the transition VNF lifecycle event(s) that cannot be mapped to any of - the enumerated values defined for the event attribute. - NOTE: At least one of these two attributes shall be included. - - * - script - - String - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Information to locate a VNF LCM script (e.g. written in a DSL as specified in requirement VNF_PACK.LCM.001) - triggered to react to one of the events listed in the event attribute. - - * - scriptDsl - - String - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Defines the domain specific language (i.e. the type) of script that is provided. - Types of scripts could include bash, python, etc. - - * - scriptInput - - KeyValuePair - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Array of KVP requirements with the key as the parameter name and the value as the parameter that need to be passed as an input to the script. - NOTE: The scriptInput values are passed to the scripts in addition to the parameters received in the operation invocation request or - indicator value change. - - -LogicalNodeData -~~~~~~~~~~~~~~~ - -This information element describes compute, memory and I/O requirements -that are to be associated with the logical node of infrastructure. The -logical node requirements are a sub-component of the VDU level -requirements. As an example for illustration purposes, a logical node -correlates to the concept of a NUMA cell in libvirt terminology. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - logicalNodeRequirement - - KeyValuePair - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The logical node-level compute, memory and I/O requirements. An array of key-value pairs - that articulate the deployment requirements. This could include the number of CPU cores - on this logical node, a memory configuration specific to a logical node (e.g. such as - available in the Linux kernel via the libnuma library) or a requirement related to the - association of an I/O device with the logical node. - - -MonitoringParameter -~~~~~~~~~~~~~~~~~~~ - -Specifies the virtualised resource related performance metric to be -tracked by the VNFM, e.g. for auto-scaling purposes. The VNFM collects -the values of performance metrics identified by this information element -from the VIM(s) using one or more locally initiated PM Jobs. These -values can be used as inputs to auto-scaling rules. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - id - - Identifier - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Unique identifier of the monitoring parameter. - - * - name - - String - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Human readable name of the monitoring parameter. - - * - performanceMetric - - String - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - - - * - collectionPeriod - - invalid - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - An attribute that describes the recommended periodicity at which to collect the performance information. - VNFM determines if this parameter is considered. The vendor may provide this information as a guidance for - creating PmJobs if needed. - NOTE: The MANO or NFVI may not support the recommended collectionPeriod based on their functionalities, and can - reject the requests based on the recommended collectionPeriod in this case. - - -QoS -~~~ - -The QoS information element describes QoS data for a given VL used in a -DF. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - latency - - Number - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Maximum latency in ms. - - * - packetDelayVariation - - Number - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Maximum jitter in ms. - - * - packetLossRatio - - Number - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Maximum packet loss ratio. Cardinality is 0 if no packetLossRatio requirement exists. - - -RequestedAdditionalCapabilityData -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This information element describes requested additional capability for a -particular VDU. Such a capability may be for acceleration or specific -tasks. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - supportMandatory - - Boolean - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - Indicates whether the requested additional capability is mandatory for successful operation. - - * - requestedAdditionalCapabilityName - - String - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - Identifies a requested additional capability for the VDU. - - * - minRequestedAdditionalCapabilityVersion - - String - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - Identifies the minimum version of the requested additional capability. - - * - preferredRequestedAdditionalCapabilityVersion - - String - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - Identifies the preferred version of the requested additional capability. - - * - targetPerformanceParameters - - KeyValuePair - - 1..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - Identifies specific attributes, dependent on the requested additional capability type. - - -ScaleInfo -~~~~~~~~~ - -The ScaleInfo information element represents a scale level for a -particular scaling aspect. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - aspectId - - Identifier - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Reference to the scaling aspect. - - * - scaleLevel - - Integer - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - The scale level, greater than or equal to 0 - - -VirtualCpuData -~~~~~~~~~~~~~~ - -The VirtualCpuData information element supports the specification of -requirements related to virtual CPU(s) of a virtual compute resource. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - cpuArchitecture - - String - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - CPU architecture type. Examples are x86, ARM. The cardinality can be 0 during the allocation request, if no particular CPU architecture type is requested. - - * - numVirtualCpu - - Integer - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Number of virtual CPUs. - - * - virtualCpuClock - - Number - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Minimum virtual CPU clock rate (e.g. in MHz). The cardinality can be 0 during the allocation request, if no particular value is requested. - - * - virtualCpuOversubscriptionPolicy - - String - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - The CPU core oversubscription policy e.g. the relation of virtual CPU cores to physical CPU cores/threads. The cardinality can be 0 during the allocation request, if no particular value is requested. - - * - vduCpuRequirements - - KeyValuePair - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Array of key-value pair requirements on the Compute (CPU) for the VDU. - - * - virtualCpuPinning - - VirtualCpuPinningData - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - The virtual CPU pinning configuration for the virtualised compute resource. - - -VirtualCpuPinningData -~~~~~~~~~~~~~~~~~~~~~ - -The VirtualCpuPinningData information element supports the specification -of requirements related to the virtual CPU pinning configuration of a -virtual compute resource. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - virtualCpuPinningPolicy - - PinningPolicy - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - The policy can take values of "static" or "dynamic". In case of "static" the virtual CPU cores are requested to be allocated to logical CPU cores according to the rules defined in virtualCpuPinningRules. - In case of "dynamic" the allocation of virtual CPU cores to logical CPU cores is decided by the VIM. (e.g.: SMT (Simultaneous Multi-Threading) requirements). - - * - virtualCpuPinningRule - - invalid - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - A list of rules that should be considered during the allocation of the virtual CPUs to logical CPUs in case of "static" virtualCpuPinningPolicy. - - -VirtualLinkBitRateLevel -~~~~~~~~~~~~~~~~~~~~~~~ - -The VirtualLinkBitRateLevel information element specifies bitrate -requirements applicable to a virtual link instantiated from a particular -VnfVirtualLinkDesc. - -VirtualMemoryData -~~~~~~~~~~~~~~~~~ - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - virtualMemSize - - Number - - 1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Amount of virtual Memory (e.g. in MB). - - * - virtualMemOversubscriptionPolicy - - String - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Obsolete - - The memory core oversubscription policy in terms of virtual memory to physical memory on the platform. The cardinality can be 0 during the allocation request, if no particular value is requested. - - * - vduMemRequirements - - KeyValuePair - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - Array of key-value pair requirements on the memory for the VDU. - - * - numaEnabled - - Boolean - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Obsolete - - It specifies the memory allocation to be cognisant of the relevant process/core allocation. The cardinality can be 0 during the allocation request, if no particular value is requested. - - -VnfConfigurableProperties -~~~~~~~~~~~~~~~~~~~~~~~~~ - -This datatype defines the configurable properties of a VNF (e.g. related -to auto scaling and auto healing). For a VNF instance, the value of -these properties can be modified by the VNFM - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - isAutoscaleEnabled - - Boolean - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - It permits to enable (TRUE)/disable (FALSE) the auto-scaling functionality. - NOTE: A cardinality of "0" indicates that configuring this present VNF property is not supported. - - * - isAutohealEnabled - - Boolean - - 0..1 - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - It permits to enable (TRUE)/disable (FALSE) the auto-healing functionality. - NOTE: A cardinality of "0" indicates that configuring this present VNF property is not supported. - - * - additionalConfigurableProperty - - String - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - - - -VnfInfoModifiableAttributes -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This datatype defines the VNF-specific extension and metadata attributes -of the VnfInfo that are writeable via the ModifyVnfInfo operation. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - extension - - invalid - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - "Extension" attributes of VnfInfo that are writeable. - - * - metadata - - invalid - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Experimental - - Metadata" attributes of VnfInfo that are writeable - - -VnfcConfigurableProperties -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This datatype defines the configurable properties of a VNFC. For a VNFC -instance, the value of these properties can be modified through the -VNFM. - -.. list-table:: - :header-rows: 1 - - - * - **AttributeName** - - **Type** - - **Mult.** - - **Access** - - **Stereotypes** - - **Description** - - * - additionalVnfcConfigurableProperty - - String - - 0..\* - - RW - - OpenModelAttribute - - - isInvariant: false - - valueRange: no range constraint - - support: MANDATORY - - Preliminary - - It provides VNFC configurable properties that can be modified using the ModifyVnfInfo operation. - - -Enumeration definition ----------------------- - -AddressType -~~~~~~~~~~~ - -Type of address - -Contains Enumeration Literals: - -- MAC: - -- IP: - -ClosedLoopStatus -~~~~~~~~~~~~~~~~ - -Contains Enumeration Literals: - -- ENABLED: - -- DISABLED: - -CollectionPeriod -~~~~~~~~~~~~~~~~ - -Specifies the periodicity at which the producer will collect performance -information. - -Contains Enumeration Literals: - -HomingStrategy -~~~~~~~~~~~~~~ - -Contains Enumeration Literals: - -- Colocation: - -- isolation: - -LcmEvent -~~~~~~~~ - -Describes VNF lifecycle event(s) or an external stimulus detected on a -VNFM reference point. - -Contains Enumeration Literals: - -- EVENT_START_INSTANTIATION: - -- EVENT_END_INSTANTIATION: - -- EVENT_START_SCALING: - -- EVENT_END_SCALING: - -- EVENT_START_SCALING_TO_LEVEL: - -- EVENT_END_SCALING_TO_LEVEL: - -- EVENT_START_HEALING: - -- EVENT_END_HEALING: - -- EVENT_START_TERMINATION: - -- EVENT_END_TERMINATION: - -- EVENT_START_VNF_FLAVOR_CHANGE: - -- EVENT_END_VNF_FLAVOR_CHANGE: - -- EVENT_START_VNF_OPERATION_CHANGE: - -- EVENT_END_VNF_OPERATION_CHANGE: - -- EVENT_START_VNF_EXT_CONN_CHANGE: - -- EVENT_END_VNF_EXT_CONN_CHANGE: - -- EVENT_START_VNFINFO_MODIFICATION: - -- EVENT_END_VNFINFO_MODIFICATION: - -OperationalStatus -~~~~~~~~~~~~~~~~~ - -Indicator for whether the resource is considered operational. Valid -values are in-service-path and out-of-service-path. - -Contains Enumeration Literals: - -- IN-SERVICE-PATH: - -- OUT-OF-SERVICE-PATH: - -OrchestrationStatus -~~~~~~~~~~~~~~~~~~~ - -Contains Enumeration Literals: - -- INVENTORIED: - -- ASSIGNED: - -- CREATED: - -- ACTIVE: - -PinningPolicy -~~~~~~~~~~~~~ - -Defines the CPU pinning policy. - -Contains Enumeration Literals: - -- STATIC: - -- DYNAMIC: - -PlacementStrategy -~~~~~~~~~~~~~~~~~ - -Contains Enumeration Literals: - -- COLOCATION: - -- ISOLATION: - -- EXCLUSIVITY: - -ProvStatus -~~~~~~~~~~ - -Provisioning status, used as a trigger for operational monitoring of -this resource by service assurance systems. - -Contains Enumeration Literals: - -- PROVISIONED: - -- PREPROVISIONED: - -- CAPPED: - -VnfSource -~~~~~~~~~ - -Describes the source of the indicator. - -Contains Enumeration Literals: - -- VNF: - -- EM: - -- BOTH: - -VnicType -~~~~~~~~ - -Describes the type of VNIC to which a CP attaches. - -Contains Enumeration Literals: - -- NORMAL: - -- MACVTAP: - -- DIRECT: - -- BAREMETAL: - -- DIRECT_PHYSICAL: - -- 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 6645f46..ba25226 100644 --- a/docs/ONAP Model Spec/im/index.rst +++ b/docs/ONAP Model Spec/im/index.rst @@ -12,13 +12,14 @@ ONAP Information Model Specifications .. toctree:: :titlesonly: - Root - VnfdAndVnfInstance - NSD - BusinessInteraction - VES index - ServiceModel-Nested Service - ServiceModel-Service order - NSDR4 - Nested Service final for Rst - ServiceOrderR4 \ No newline at end of file + Root/Root + VNF/VnfdAndVnfInstance + PNF/PNFD + NSD/NSD + Common/BusinessInteraction + VES/VES index + Service/ServiceModel-Nested Service + Service/ServiceModel-Service order + Common/DynamicParameters + Common/SelectionCriteria + License/LicenseModel diff --git a/docs/ONAP Model Spec/index.rst b/docs/ONAP Model Spec/index.rst index 6536ee6..602f7ab 100644 --- a/docs/ONAP Model Spec/index.rst +++ b/docs/ONAP Model Spec/index.rst @@ -6,7 +6,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -ONAP R5 Modeling Specifications +ONAP Modeling Specifications ============================================== .. toctree:: diff --git a/docs/Release-notes/index.rst b/docs/Release-notes/index.rst deleted file mode 100644 index 4ff7ff4..0000000 --- a/docs/Release-notes/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. Copyright 2019 (China Mobile) -.. 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 -.. onap-documentation documentation master file, created by - sphinx-quickstart on Mon Sep 18 15:12:14 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Modeling Release Notes -============================================== - -.. toctree:: - :maxdepth: 1 - - release-notes diff --git a/docs/Release-notes/release-notes.rst b/docs/Release-notes/release-notes.rst index 9dc1889..95a18e9 100644 --- a/docs/Release-notes/release-notes.rst +++ b/docs/Release-notes/release-notes.rst @@ -6,6 +6,41 @@ Modeling Spec Release Notes =========================== +Version: 6.0.0 +-------------- + +:Release Date: 2020-05-24 + +**New Features** + +Introduce the following new information models: + +- dynamic parameters +- selection criteria +- license management + +Enhance service information model for nested and shared service. + +**Bug Fixes** + +**Security Notes** + +MODELLING code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. + +Quick Links: + - `MODELLING project page `_ + + - `Passing Badge information for MODELLING `_ + +**Known Issues** + None + +**Upgrade Notes** + Update root hierarchy information model. + +**Other** + None + Version: 5.0.0 -------------- @@ -35,7 +70,7 @@ Quick Links: None **Other** - + None Version: 4.0.0 -------------- @@ -66,14 +101,13 @@ Quick Links: Update VNFD information and data model to align with ETSI NFV IFA011/SOL001 v2.5.1 specifications. **Other** + None Version: 3.1.1 -------------- :Release Date: 2018-11-07 - - **New Features** Define design time VNFD model information model and onboarding data model specifications based on ETSI NFV specifications IFA011 and SOL001. @@ -96,7 +130,4 @@ Quick Links: None **Other** - -=========== - -End of Release Notes + None diff --git a/docs/index.rst b/docs/index.rst index 5bf7327..a821e4f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,4 +18,4 @@ The changes can be found in the Release Notes: .. toctree:: :maxdepth: 1 - Release-notes/index + Release-notes/release-notes -- cgit 1.2.3-korg