diff options
| author |   yxpoke <yangxu5@huawei.com> | 2020-05-24 22:56:59 +0800 |
|---|---|---|
| committer | yxpoke <yangxu5@huawei.com> | 2020-05-24 22:56:59 +0800 |
| commit | e9d4fc1e6ea5f43811d068db48c3f6847cf0dd66 (patch) | |
| tree | 40a207daa0023b72eac2bd49cf4720bee3e16768 /docs | |
| parent | 22c62c7e71dfe90b18c27d37b3a7943e9b9186f6 (diff) | |
R6 Model Spec Update
Change-Id: I569b33a64bbae425eaec5fa939c57f69ea7e1ed8
Issue-ID: MODELING-363
Signed-off-by: yxpoke <yangxu5@huawei.com>
Diffstat (limited to 'docs')
33 files changed, 3247 insertions, 652 deletions
diff --git a/docs/ONAP Model Spec/im/Common/BusinessInteraction.png b/docs/ONAP Model Spec/im/Common/BusinessInteraction.png Binary files differnew file mode 100644 index 0000000..08977ed --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/BusinessInteraction.png diff --git a/docs/ONAP Model Spec/im/BusinessInteraction.rst b/docs/ONAP Model Spec/im/Common/BusinessInteraction.rst index 820c82e..3f287a8 100644 --- a/docs/ONAP Model Spec/im/BusinessInteraction.rst +++ b/docs/ONAP Model Spec/im/Common/BusinessInteraction.rst @@ -9,6 +9,14 @@ Business Interaction Model :depth: 3 .. +Diagram +------- + +Business Interaction +^^^^^^^^^^^^^^^^^^^^ + +.. image:: BusinessInteraction.png + Class Definition ---------------- diff --git a/docs/ONAP Model Spec/im/Common/DynamicParameters.png b/docs/ONAP Model Spec/im/Common/DynamicParameters.png Binary files differnew file mode 100644 index 0000000..b7d41f8 --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/DynamicParameters.png 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 Binary files differnew file mode 100644 index 0000000..70d709a --- /dev/null +++ b/docs/ONAP Model Spec/im/Common/SelectionCriteria.png 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 Binary files differnew file mode 100644 index 0000000..a5289f6 --- /dev/null +++ b/docs/ONAP Model Spec/im/License/Entitlements.png diff --git a/docs/ONAP Model Spec/im/License/License.png b/docs/ONAP Model Spec/im/License/License.png Binary files differnew file mode 100644 index 0000000..6832518 --- /dev/null +++ b/docs/ONAP Model Spec/im/License/License.png diff --git a/docs/ONAP Model Spec/im/License/LicenseKey.png b/docs/ONAP Model Spec/im/License/LicenseKey.png Binary files differnew file mode 100644 index 0000000..157abae --- /dev/null +++ b/docs/ONAP Model Spec/im/License/LicenseKey.png 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 Binary files differnew file mode 100644 index 0000000..b5accd3 --- /dev/null +++ b/docs/ONAP Model Spec/im/License/RootHierarchy.png diff --git a/docs/ONAP Model Spec/im/License/RootingLicense.png b/docs/ONAP Model Spec/im/License/RootingLicense.png Binary files differnew file mode 100644 index 0000000..e01ff53 --- /dev/null +++ b/docs/ONAP Model Spec/im/License/RootingLicense.png diff --git a/docs/ONAP Model Spec/im/NSDR4.PNG b/docs/ONAP Model Spec/im/NSD/NSD.png Binary files differindex acd2c5d..acd2c5d 100644 --- a/docs/ONAP Model Spec/im/NSDR4.PNG +++ b/docs/ONAP Model Spec/im/NSD/NSD.png diff --git a/docs/ONAP Model Spec/im/NSD.rst b/docs/ONAP Model Spec/im/NSD/NSD.rst index 2d4469a..f8ce8df 100644 --- a/docs/ONAP Model Spec/im/NSD.rst +++ b/docs/ONAP Model Spec/im/NSD/NSD.rst @@ -2,15 +2,17 @@ .. 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 .. -|image0| - -NetworkServiceDescriptorModel -=============================== +Diagram +------- +.. image:: NSD.png NetworkServiceDescriptor ------------------------ 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 Binary files differdeleted file mode 100644 index 1c58c42..0000000 --- a/docs/ONAP Model Spec/im/Nested Service final for Rst.PNG +++ /dev/null diff --git a/docs/ONAP Model Spec/im/PNFD.rst b/docs/ONAP Model Spec/im/PNF/PNFD.rst index 1da1ce9..76eb837 100644 --- a/docs/ONAP Model Spec/im/PNFD.rst +++ b/docs/ONAP Model Spec/im/PNF/PNFD.rst @@ -1,3 +1,7 @@ +.. 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 ~~~~~~~~~ diff --git a/docs/ONAP Model Spec/im/Root/Root.png b/docs/ONAP Model Spec/im/Root/Root.png Binary files differnew file mode 100644 index 0000000..171c715 --- /dev/null +++ b/docs/ONAP Model Spec/im/Root/Root.png diff --git a/docs/ONAP Model Spec/im/Root.rst b/docs/ONAP Model Spec/im/Root/Root.rst index ddda941..ddda941 100644 --- a/docs/ONAP Model Spec/im/Root.rst +++ b/docs/ONAP Model Spec/im/Root/Root.rst diff --git a/docs/ONAP Model Spec/im/Service/NestedService.png b/docs/ONAP Model Spec/im/Service/NestedService.png Binary files differnew file mode 100644 index 0000000..0e6f992 --- /dev/null +++ b/docs/ONAP Model Spec/im/Service/NestedService.png 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/ServiceModel-Service order.rst b/docs/ONAP Model Spec/im/Service/ServiceModel-Service order.rst index ead6beb..c817884 100644 --- a/docs/ONAP Model Spec/im/ServiceModel-Service order.rst +++ b/docs/ONAP Model Spec/im/Service/ServiceModel-Service order.rst @@ -9,8 +9,10 @@ Service Order :depth: 3 .. +Diagrams +======== -|image0| +.. image:: ServiceOrder.png Classes ======= diff --git a/docs/ONAP Model Spec/im/ServiceOrderR4.PNG b/docs/ONAP Model Spec/im/Service/ServiceOrder.png Binary files differindex 5283fa0..5283fa0 100644 --- a/docs/ONAP Model Spec/im/ServiceOrderR4.PNG +++ b/docs/ONAP Model Spec/im/Service/ServiceOrder.png 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/VES index.rst b/docs/ONAP Model Spec/im/VES/VES index.rst index 2440f38..2440f38 100644 --- a/docs/ONAP Model Spec/im/VES index.rst +++ b/docs/ONAP Model Spec/im/VES/VES index.rst diff --git a/docs/ONAP Model Spec/im/VNF/VNF-DF.png b/docs/ONAP Model Spec/im/VNF/VNF-DF.png Binary files differnew file mode 100644 index 0000000..e5e9d0a --- /dev/null +++ b/docs/ONAP Model Spec/im/VNF/VNF-DF.png diff --git a/docs/ONAP Model Spec/im/VNF/VNFD-topo.png b/docs/ONAP Model Spec/im/VNF/VNFD-topo.png Binary files differnew file mode 100644 index 0000000..c03aa05 --- /dev/null +++ b/docs/ONAP Model Spec/im/VNF/VNFD-topo.png diff --git a/docs/ONAP Model Spec/im/VNF/VNFD.png b/docs/ONAP Model Spec/im/VNF/VNFD.png Binary files differnew file mode 100644 index 0000000..9832d0a --- /dev/null +++ b/docs/ONAP Model Spec/im/VNF/VNFD.png diff --git a/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst b/docs/ONAP Model Spec/im/VNF/VnfdAndVnfInstance.rst index 7d0ba0c..6bb88e4 100644 --- a/docs/ONAP Model Spec/im/VnfdAndVnfInstance.rst +++ b/docs/ONAP Model Spec/im/VNF/VnfdAndVnfInstance.rst @@ -9,6 +9,24 @@ ONAP Vnfd and VnfInstance Model :depth: 3 .. +Diagrams +-------- + +Vnfd View +~~~~~~~~~ + +.. image:: VNFD.png + +Vnfd Topology View +~~~~~~~~~~~~~~~~~~ + +.. image:: VNFD-topo.png + +Vnfd Deployment Flavor +~~~~~~~~~~~~~~~~~~~~~~ + +.. image:: VNFD-DF.png + Class Definition ---------------- 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 <https://wiki.onap.org/display/DW/Modeling+Project>`_ + + - `Passing Badge information for MODELLING <https://bestpractices.coreinfrastructure.org/en/projects/1774>`_ + +**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 |
