From f3d6901185c3dd256e180598a839c07dfe0db000 Mon Sep 17 00:00:00 2001 From: SRicci Date: Tue, 31 Mar 2020 18:14:41 -0400 Subject: "Multiple changes to License Model to address comments from review." Issue-ID: ONAPMODEL-4 (and subtasks) Change-Id: Ie4d6b8000d761ad8a7faabf78cfd1729fa181a8f Signed-off-by: SRicci --- ONAP Information Model/Common.notation | 21 +-- ONAP Information Model/Common.uml | 32 +++-- ONAP Information Model/License.notation | 222 +++++++++++++++++--------------- ONAP Information Model/License.uml | 211 +++++++++++++++--------------- ONAP Information Model/Party.notation | 134 ++++++++++++++++++- 5 files changed, 380 insertions(+), 240 deletions(-) diff --git a/ONAP Information Model/Common.notation b/ONAP Information Model/Common.notation index a7f4ac9..b7b99e1 100644 --- a/ONAP Information Model/Common.notation +++ b/ONAP Information Model/Common.notation @@ -4239,7 +4239,7 @@ - + @@ -4337,7 +4337,7 @@ - + @@ -4585,7 +4585,7 @@ - + @@ -4668,11 +4668,6 @@ - - - - - @@ -4735,7 +4730,10 @@ - + + +

+ @@ -7677,11 +7675,6 @@ - - - - - diff --git a/ONAP Information Model/Common.uml b/ONAP Information Model/Common.uml index 210957e..d3720eb 100644 --- a/ONAP Information Model/Common.uml +++ b/ONAP Information Model/Common.uml @@ -610,6 +610,10 @@ For VNFs, those rules are applicable between the virtualization containers to be Provider of the NF and of the NFD being onboarded. + + + + Provider of the NF and of the NFD being onboarded. @@ -630,7 +634,7 @@ For VNFs, those rules are applicable between the virtualization containers to be - + Information about localization languages of the NF (includes e.g. strings in the NFD). @@ -1652,10 +1656,12 @@ Permitted Values: Note: The only fields being used in this class are Name and MRN (manufactureReferenceNumber. The rest are optional. - + The period during which the design entity is valid. + + @@ -2016,9 +2022,6 @@ Permitted Values: PolicyEvent is part of another effort, and is NOT agreed to at this time. - - LicenseAgreement is part of another contribution and is NOT agreed to at this time. - ServiceOrder and VesEvent are part of other contributions, and have already been accepted. @@ -4682,15 +4685,6 @@ Permitted Values: - - - - - - - - - @@ -5008,4 +5002,14 @@ Permitted Values: + + + + + + + + + + diff --git a/ONAP Information Model/License.notation b/ONAP Information Model/License.notation index 9bac050..6ffcb20 100644 --- a/ONAP Information Model/License.notation +++ b/ONAP Information Model/License.notation @@ -160,6 +160,36 @@ + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -183,7 +213,7 @@ - + @@ -198,7 +228,10 @@ - + + +

+ @@ -418,7 +451,7 @@ - + @@ -449,8 +482,8 @@ - - + + @@ -480,8 +513,8 @@ - - + + @@ -578,13 +611,13 @@ - + - + - + @@ -752,15 +785,6 @@ - - - - - - - - - @@ -770,15 +794,6 @@ - - - - - - - - - @@ -1112,24 +1127,6 @@ - - - - - - - - - - - - - - - - - - @@ -2725,15 +2722,6 @@ - - - - - - - - - @@ -2761,23 +2749,6 @@ - - - -

- - - - - - - - - - - - - @@ -3048,17 +3019,17 @@ - + - + - + - + @@ -3344,24 +3315,6 @@ - - - - - - - - - - - - - - - - - - @@ -3433,7 +3386,7 @@ - + @@ -3446,7 +3399,7 @@ - + @@ -3456,7 +3409,7 @@ - + @@ -3604,28 +3557,89 @@ - + + - + + - + + - + + - + + - + + - + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ONAP Information Model/License.uml b/ONAP Information Model/License.uml index c0c105d..7a2cae7 100644 --- a/ONAP Information Model/License.uml +++ b/ONAP Information Model/License.uml @@ -1,7 +1,7 @@ - + VLM is really just a Party @@ -23,6 +23,38 @@ MRN should also be provided, but is not required. A&AI stores the entitlement asset tag as an attribute of the Vnf Instance + + + 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. + + + + + + + + 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. + + + + 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. + + + + + + + + + Term of the license: +-fixed term +-perpetual +-unlimited +-subscription + + + + @@ -225,26 +257,22 @@ MRN should also be provided, but is not required. - +

- - - - - - + - A License Key Group is created for each type of License Key that is required for the software. Each License Key Group 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 Group are defined. -The license key group model provides a description to systems such as Asset Inventory for the license keys that are provided by a vendor. The Asset Inventory system will create a “group” and purchasing systems will send the inventory of license keys/files to be held by Asset Inventory in the appropriate group. -Controllers will request license keys from Asset Inventory using the UUID of the group, as directed by the ASDC models for the software (i.e. VFs). -A license key group is not specific to a feature group. A license key group may be related to multiple feature groups of a software item or even to multiple software items. + 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. @@ -267,11 +295,11 @@ A license key group is not specific to a feature group. A license key group may 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 software. +- A ‘universal’ value indicates that the same exact license key (string) may be associated with all instances of the VNF. -- A ‘unique’ value indicates that each instance of the software 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 ‘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 software must be related to a unique license key (string). When no longer needed, the key may not be reused. +- 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. @@ -312,40 +340,31 @@ A license key group is not specific to a feature group. A license key group may - + Identifier for the entitlement as described by the vendor in their price list / catalog /contract. + + - Represents an instance of a license key + Represents an instance of a license key. +NOTE: This is an experimental class and is NOT currently used by the ONAP Platform - - - A Service Provider internally generated asset tag (id). - - - - Vendor provided license key value that is entered into the vendor software to activiate / unlock it. + Vendor provided license key value that is entered into the vendor VNF to activiate / unlock it. - - - The requestor of the license key. - - - The assignment status of the license (assigned, available, ...). @@ -358,15 +377,12 @@ A license key group is not specific to a feature group. A license key group may - + - Vendor provided license key file that is entered into the vendor software to activiate / unlock it. - - - Vendor provided license key file that is entered into the vendor software to activiate / unlock it. + Vendor provided license key file that is entered into the vendor VNF to activiate / unlock it. - + @@ -378,7 +394,7 @@ Limits can be applied by the vendor or the service provider. - Specifies if this pool holds entitlements based on usage of the software (number of users), number of sessions, country, line of business, etc. + Specifies if this pool holds entitlements based on usage of the VNF instance (number of users), number of sessions, country, line of business, etc. @@ -418,29 +434,17 @@ Limits can be applied by the vendor or the service provider. - + Represents an instance of a Entitlement +Specifies the use rights for the VNFs as described by the license. -Specifies the use rights for the software as described by the license. +NOTE: This is an experimental class and is NOT currently used by the ONAP Platform + - - - A Service Provider internally generated asset tag (id). - - - - - - - - The requestor of the entitlement. - - - The assignment status of the entitlement (assigned, available, ...). @@ -449,24 +453,29 @@ Specifies the use rights for the software as described by the license. - The date the entitlement was assigned. + The date the entitlement was assigned. +NOTE; This is experimental and not currently used by ONAP + + + + + - + - An EntitlementPool is created for each type of Entitlement that is required for the software products. - -An EntitlementPool is not specific to a Feature Group. An Entitlement Pool may be related to multiple Feature Groups of a software product or even to multiple software products. + 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. -An Entitlement Pool is created for each type of Entitlement that is required for the software products. 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. -Controllers may request entitlements. + + @@ -474,15 +483,6 @@ Controllers may request entitlements. - - Note: The only fields being used in this class are Name and MRN (manufactureReferenceNumber. The rest are optional. - - - Note: StateDate and ExpiryDate are covered by the inherited validFor attribute. - - - Note: description is required according to the inherited attribute, but it presently is optional. - Note: description is required according to the inherited attribute, but it presently is optional. @@ -508,7 +508,7 @@ Controllers may request entitlements. Reference number for the entitlement as described by the vendor in their price list / catalog /contract. - + @@ -560,22 +560,22 @@ when 90% of the pool is in-use, trigger an additional purchase of inventory. 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 software. +- A ‘universal’ value indicates that the same exact license key (string) may be associated with all instances of the VNF. -- A ‘unique’ value indicates that each instance of the software 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 ‘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 software must be related to a unique license key (string). When no longer needed, the key may not be reused. +- 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. - + - Feature groups represent a set of the features of the software. Feature groups may be defined by the vendor and/or by the service provider. Software may be related to multiple feature groups. At least one feature group will be related to software. If no sub-sets are needed, a single feature group will be defined that represents the base or core capabilities of the software. + 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. - + Name of the feature group @@ -599,7 +599,7 @@ If an Entitlement Pool or License Key Group is associated with a particular Feat - + 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. @@ -609,7 +609,11 @@ If an Entitlement Pool or License Key Group is associated with a particular Feat - Free form text. Includes information such as operating system or hypervisor required for the software. This may also contain factors to be considered in deployment/placement of the software instances. These requirements and constraints may need to be abstracted as policies or other business rules. + Free form text. Includes information such as operating system or hypervisor required for the VNF instance. 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. + + + + 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. @@ -776,9 +780,7 @@ Not applicable when license type is Perpetual. - - @@ -795,9 +797,7 @@ Not applicable when license type is Perpetual. - - @@ -816,40 +816,47 @@ Not applicable when license type is Perpetual. - - - - - - - - - - - - + + + + + + + - + - + - + - + - + - + - - + + + + + + + + + + + + + + diff --git a/ONAP Information Model/Party.notation b/ONAP Information Model/Party.notation index 49cc5e1..5738a00 100644 --- a/ONAP Information Model/Party.notation +++ b/ONAP Information Model/Party.notation @@ -1,5 +1,5 @@ - + @@ -922,7 +922,7 @@ - + @@ -966,7 +966,7 @@ - + @@ -1099,7 +1099,7 @@ - + @@ -1221,7 +1221,7 @@ - + @@ -1270,6 +1270,128 @@ + + +

+ + +

+ + + + + + + + + + + + + + + +

+ + +

+ + + + + + + + + + + + + + +

+ + +

+ + + + + + + + + + + + + + +

+ + +

+ + + + + + + + + + + + + + + +

+ + +

+ + + + + + + + + + + + @@ -1374,7 +1496,7 @@ - + -- cgit 1.2.3-korg