Discussion Contributions:
View file name ONAP network slice modeling - for modeling subcommittee v3.10.pptx height 250
Color Explanation: This proposal is based on the nested service and the information model Composite / Atomic Service, all the colored parts excluding black ones are new added changes to the basic model. Blue parts excepts class "ServiceProfile" and "SliceProfile" are for the filter fuctionality, pink parts are for service configuration functionality, purple and green are needed for filter function in instance model, but for two different functions respectively. Detailed information please go through the tables below.
| Table of Contents | ||
|---|---|---|
|
NOTE: Details of ParameterGroup and related structure, you can find here: Dynamic Parameters
1.1 Classes
1.1.1 ServiceAtomicDescriptor
Parent class: ServiceDescriptor
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
...
Attribute Name
...
Type
...
Mult.
...
Stereotypes
...
Description
...
_serviceAtomicInstance
...
ServiceAtomicInstance
...
0..*
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
An implementation of atomic Service corresponding to a ServicecAtomicDescriptor.
...
_resourceDesc (resourcespecification)
...
ResourceDesc (ResourceSpecification)
...
0..*
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
Resource components of constituting a serivce descriptor.
...
serviceInvariantId
...
Identifier
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
Constant identifier of the service model.
...
serviceId
...
Identifier
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
Versioned identifier of the service model (this id is changed for every major version of the service)
...
name
...
String
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
The name of the service model designed.
...
description
...
String
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
The description of the service model designed.
...
category
...
String
...
1..*
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
A predefined list which identifies the construct's category. There is a predefined list of service categories.
...
version
...
String
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
The service descriptor version.
...
serviceType
...
String
...
0...1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
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".
...
serviceRole
...
String
...
0..1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM".
...
icon
...
String
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
The icon path of the service.
...
_serviceInstance
...
ServiceInstance
...
0..*
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
An instance of Service deployment.
...
isShared
...
Boolean
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
Describe whether this service descriptor is shared or not in the service design.
"True" means this service can be shared by other services, orchestrator in runtime will first search an existed instance to see if it can satisfy the demands; "False" means can't be shared by other services, orchestrator will directly instantiate a new instance.
...
configurableProperties
...
KeyValuePair
...
0..1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: OPTIONAL
...
Describes the configurable properties of the service.
...
lifecycleManagementScript
...
ServiceLifecycleManagementScript
...
0..*
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: OPTIONAL
...
Includes a list of events and corresponding management scripts performed for the Service.
1.1.2 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
...
Attribute Name
...
Type
...
Mult.
...
Stereotypes
...
Description
...
serviceInvariantId
...
Identifier
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Constant identifier of the Service Component model.
...
serviceId
...
Identifier
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Versioned identifier of the Service Component model (this id is changed for every major version of the service component).
CSARs:
| View file | ||||
|---|---|---|---|---|
|
Table of Contents printable false
NOTE: Details of ParameterGroup and related structure, you can find here: Dynamic Parameters
1.1 Classes
1.1.1 ServiceAtomicDescriptor
Parent class: ServiceDescriptor
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
_serviceAtomicInstance | ServiceAtomicInstance | 0..* | OpenModelAttribute
| An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. |
_resourceDesc (resourcespecification) | ResourceDesc (ResourceSpecification) |
...
name
...
String
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
The name of the service component.
...
description
...
String
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
The description of service component.
...
category
...
String
...
1..*
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
A predefined list which identifies the construct's category. There is a predefined list of service categories.
...
version
...
String
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
The version of service component.
...
_serviceDescriptor
...
ServiceDescriptor
...
1..*
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Describe the nested relationship between multiple Serive Descriptors.
...
_serviceCompositeInstance
...
ServiceCompositeInstance
...
0..*
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
An implementation of composite Service corresponding to a ServiceCompositeDescriptor.
...
_resourceDesc (resourcespecification)
...
ResourceDesc (ResourceSpecification)
...
0..*
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
Resource components of constituting a serivce descriptor.
...
serviceType
...
String
...
0...1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
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".
...
serviceRole
...
String
...
0..1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM".
...
icon
...
String
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
The icon path of the service.
...
_serviceInstance
...
ServiceInstance
...
0..*
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
An instance of Service deployment.
...
isShared
...
Boolean
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
Describe whether this service descriptor is shared or not in the service design.
"True" means this service can be shared by other services, orchestrator in runtime will first search an existed instance to see if it can satisfy the demands; "False" means can't be shared by other services, orchestrator will directly instantiate a new instance.
...
configurableProperties
...
KeyValuePair
...
0..1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: OPTIONAL
...
Describes the configurable properties of the service.
...
lifecycleManagementScript
...
ServiceLifecycleManagementScript
...
0..*
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: OPTIONAL
...
Includes a list of events and corresponding management scripts performed for the Service.
1.1.3 ServiceDescriptor
ServiceDescriptor is used to model the design time representation of a service.
Parent class: DesignEntity
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
...
Attribute Name
...
Type
...
Mult.
...
Stereotypes
...
Description
...
serviceInvariantId
...
Identifier
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
Constant identifier of the service model.
...
serviceId
...
Identifier
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
Versioned identifier of the service model (this id is changed for every major version of the service)
...
name
...
String
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
The name of the service model designed.
...
description
...
String
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
The description of the service model designed.
...
category
...
String
...
1..*
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
A predefined list which identifies the construct's category. There is a predefined list of service categories.
...
version
...
String
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
The service descriptor version.
...
serviceType
...
String
...
0...1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
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".
...
serviceRole
...
String
...
0..1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM".
...
icon
...
String
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Preliminary
The icon path of the service.
...
isShared
...
Boolean
...
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
...
Describe whether this service descriptor is shared or not in the service design.
"True" means this service can be shared by other services, orchestrator in runtime will first search an existed instance to see if it can satisfy the demands; "False" means can't be shared by other services, orchestrator will directly instantiate a new instance.
...
configurableProperties
...
KeyValuePair
...
0..1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: OPTIONAL
...
Describes the configurable properties of the service.
...
lifecycleManagementScript
...
ServiceLifecycleManagementScript
...
0..*
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: OPTIONAL
...
Includes a list of events and corresponding management scripts performed for the Service.
1.1.4 ServiceAtomicInstance
Parent class: ServiceInstance
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description | ||||
_resourceInstance | ResourceInstance | 0..* | OpenModelAttribute
| Resource instance components of constituting a serivce instancedescriptor. | ||||
serviceInstanceIdserviceInvariantId | Identifier | 1 | OpenModelAttribute
Preliminary | Uniquely identifies this instance of a serviceConstant identifier of the service model. | ||||
serviceInstanceNameserviceId | StringIdentifier | 0...1 | OpenModelAttribute
Preliminary The name assigned to the service-instance.
Preliminary | Versioned identifier of the service model (this id is changed for every major version of the service) | ||||
name | String | serviceType | String | 0..1 | OpenModelAttribute
Preliminary | The name of the service model designed. | ||
description 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". serviceRole | String | 1 | OpenModelAttribute
Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". | The description of the service model designed. | ||||
category | String | 1..* | selfLink | Uri | 1 | OpenModelAttribute
Preliminary | A predefined list which identifies the construct's category. There is a predefined list of service categories. | |
version URL to endpoint where more details can be gotten. orchestrationStatus | String | 1 | OpenModelAttribute
Preliminary | Orchestration status of the service instanceThe service descriptor version. | ||||
nsStatusserviceType | String | 0...1 | Experimental 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). | 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". | ||
serviceRole | String | 0.. | instanceSharingNumber | Integer | 0...1 | OpenModelAttribute
Record the number of other service instances that are using this shared service. 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 service is used by other service(s), otherwise it can be deleted. Preliminary | An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". | |
icon | String | 1 | _instanceProperties | InstanceProperties | 0..* | OpenModelAttribute
| no
| One service instance will include one or more InstanceProperties classes. |
1.1.5 ServiceCompositeInstance
Parent class: ServiceInstance
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Preliminary | The icon path of the service. | |||||||||
_serviceInstance | ServiceInstance | 0..* | OpenModelAttribute
| An instance of Service deployment. | ||||||
isShared | Boolean | 1 | ||||||||
Attribute Name | Type | Mult. | Stereotypes | Description | ||||||
_resourceInstance | ResourceInstance | 0..* | OpenModelAttribute
| Resource instance components of constituting a serivce instance. | serviceInstanceId | Identifier | 1 | OpenModelAttribute
Preliminary |
preliminary | Describe whether this service descriptor is shared or not in the service design. "True" means this service can be shared by other services, orchestrator in runtime will first search an existed instance to see if it can satisfy the demands; "False" means can't be shared by other services, orchestrator will directly instantiate a new instance.
|
lifecycleManagementScript | ServiceLifecycleManagementScript | 0..* | serviceInstanceName | String | 0...1OpenModelAttribute
|
| The name assigned to the service-instance. | preliminary | Includes a list of events and corresponding management scripts performed for the Service.
|
1.1.2 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
Attribute Name | Type | Mult. | Stereotypes | Description | ||||||
serviceInvariantId | Identifier | |||||||||
serviceType | String | 0..1 | OpenModelAttribute
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". | ||||||
serviceRole | String | 1 | OpenModelAttribute
Preliminary An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". | selfLink | Constant identifier of the Service Component model. | |||||
serviceId | Identifier | Uri1 | OpenModelAttribute
| Versioned identifier of the Service Component model (this id is changed for every major version of the service component). | ||||||
name | MANDATORYURL to endpoint where more details can be gotten. | orchestrationStatus | String | 1 | OpenModelAttribute
Preliminary | Orchestration status The name of the service instancecomponent. | ||||
nsStatusdescription | String | 1 | Experimental 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). | The description of service component. | |||||
category | String | 1..* | InstanceSharingNumber | Integer | 0...1 | OpenModelAttribute
Record the number of instances of the service used by other services. 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 service is used by other service(s), otherwise it can be deleted. | _instanceProperties | InstanceProperties | 0..*Preliminary | A predefined list which identifies the construct's category. There is a predefined list of service categories. |
version | String | 1 | OpenModelAttribute
| no
| The version of service component. | |||||
_serviceDescriptor | ServiceDescriptor | 1. |
...
. |
...
* | OpenModelAttribute
|
ServiceInstance is used to model the run time representation of a service.
Applied stereotypes:
...
|
...
| Describe the nested relationship between multiple Serive Descriptors. | ||||||||
_serviceCompositeInstance | ServiceCompositeInstance | 0..* | |||||||
Attribute Name | Type | Mult. | Stereotypes | Description | |||||
serviceInstanceId | Identifier | 1 | OpenModelAttribute
Preliminary Uniquely identifies this instance of a service. | serviceInstanceName | An implementation of composite Service corresponding to a ServiceCompositeDescriptor. | ||||
_resourceDesc (resourcespecification) | ResourceDesc (ResourceSpecification)String | 0...1* | OpenModelAttribute
Preliminary
| Resource components of constituting a serivce descriptor. The name assigned to the service-instance.availableInstanceNumber | |||||
serviceType | String | 0...1 | OpenModelAttribute
Preliminary | An optional string field defining a generic a generic type (like category) of the service. E.g. this field can be used for defining for defining the service as "TRANSPORT". | |||||
serviceRole | String | 0..1 | OpenModelAttribute
Preliminary | An optional string field for shortcode that shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". | selfLink | Uri | 1 | OpenModelAttribute
Preliminary | |
icon | orchestrationStatus | String | 1 | OpenModelAttribute
Preliminary | Orchestration status The icon path of the service instance. nsStatus | ||||
_serviceInstance | ServiceInstance | 0..* | String | 1 | Experimental | 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). | An instance of Service deployment. | |
isShared | Boolean | instanceSharingNumber | Integer | 0...1 | OpenModelAttribute
preliminary | Describe whether this service descriptor is shared or not in the service design. "True" means this service can be shared by other services, orchestrator in runtime will first search an existed instance to see if it can satisfy the demands; "False" means can't be shared by other services, orchestrator will directly instantiate a new instance. | |||
lifecycleManagementScript | ServiceLifecycleManagementScript | Record the number of instances of the service used by other services. 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 service is used by other service(s), otherwise it can be deleted. | _instanceProperties | InstanceProperties | 0..* | OpenModelAttribute OpenModelAttribute
preliminary | Includes a list of events and corresponding management scripts performed for the Service One service instance will include one or more InstanceProperties classes. |
1.1.
...
3 ServiceDescriptor
ServiceDescriptor is used to model the design time representation of a service.
Parent class: DesignEntity
SelectionCriteria finds descriptors and instances according to specific properties of those entities.
Applied stereotypes:
- Experimental
- OpenModelClass
- support:
OPTIONAL - MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
serviceInvariantId | Identifier | 1 | OpenModelAttribute
Preliminary |
Unique indentifier of this SelectionCriteria.
1.1.8 SelectionCriteriaAtomic
A simple (atomic) selection criteria that holds a specific attribute comparision expression.
Parent class: SelectionCriteria
Applied stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Constant identifier of the service model. | ||||||||
serviceId | Identifier | |||||||
Attribute Name | Type | Mult. | Stereotypes | Description | ||||
metricName | String | 1 | OpenModelAttribute
| Name of compared parameter or attribute. | Preliminary | Versioned identifier of the service model (this id is changed for every major version of the service) | ||
name | String | operator | Operator | 1 | OpenModelAttribute
| Comparison operator, e.g. equal, less than, greater or etc. | Preliminary | The name of the service model designed. |
description | String | value | KeyValuePair | 1 | OpenModelAttribute
| Compared value (can be a name of a parameter in referenced class).
| Preliminary | The description of the service model designed. |
category | String | 1..* | selectionCriteriaId | Identifier | 1 | OpenModelAttribute
| Unique indentifier of this SelectionCriteria. |
1.1.9 SelectionCriteriaComposite
A SelectionCriteriaComposite is an aggregation of multiple SelectionCriterias. Aggregation can be for example AND or OR logical operations.
Parent class: SelectionCriteriaComposite
Applied stereotypes:
- Experimental
- OpenModelClass
- support: MANDATORY
Preliminary | A predefined list which identifies the construct's category. There is a predefined list of service categories. | ||||||
version | String | 1 | OpenModelAttribute
Preliminary | The service descriptor version. | |||
serviceType | String | 0... | |||||
Attribute Name | Type | Mult. | Stereotypes | Description | |||
compositeOperator | CompositeOperator | 1 | OpenModelAttribute
|
Logical operation for SelectionCriterias composition, e.g. logical AND or OR. | 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". | |
serviceRole | String | 0..1 | selectionCriteriaId | Identifier | 1 | OpenModelAttribute
| Unique indentifier of this SelectionCriteria. |
1.1.10 InstanceProperties
Hold a set of instance specific property information.
Applied stereotypes:
- OpenModelClass
- support: MANDATOR
- Experimental
2.1 Data Types
2.1.1 ServiceLifecycleManagementScript
The LifeCycleManagementScript information element specifies a script for the service.
Preliminary | An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". | |||
icon | String | 1 | OpenModelAttribute
Preliminary | The icon path of the service. |
isShared | Boolean | 1 |
Attribute Name
Type
Mult.
Access
Description
event
ServiceLcmEvent
0..*
OpenModelAttribute
|
Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator reference point.
lcmTransitionEvent
String
0..*
preliminary | Describe whether this service descriptor is shared or not in the service design. "True" means this service can be shared by other services, orchestrator in runtime will first search an existed instance to see if it can satisfy the demands; "False" means can't be shared by other services, orchestrator will directly instantiate a new instance. | |
lifecycleManagementScript | ServiceLifecycleManagementScript | 0..* |
OpenModelAttribute
|
Describes the transition Service lifecycle event(s) that cannot be mapped to any of the enumerated values defined for the event attribute.
script
String
1
RW
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
- support: MANDATORY
Includes a Service LCM script (e.g. written in a DSL) triggered to react to one of the events listed in the event attribute.
scriptDsl
String
1
preliminary | Includes a list of events and corresponding management scripts performed for the Service. |
1.1.4 ServiceAtomicInstance
Parent class: ServiceInstance
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
_resourceInstance | ResourceInstance | 0..* | OpenModelAttribute
|
Defines the domain specific language (i.e. the type) of script that is provided. Types of scripts could include bash, python, etc.
scriptInput
KeyValuePair
0..*
Resource instance components of constituting a serivce instance. | ||
serviceInstanceId | Identifier | 1 |
Attribute Name
Type
Mult.
Access
Description
instanceProperties
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.
2.1.2 ServiceInstanceProperties
Record a set of property information this service instance holds.
Preliminary | Uniquely identifies this instance of a service. | |||
serviceInstanceName | String | 0...1 | OpenModelAttribute
Preliminary | The name assigned to the service-instance. |
serviceType | String | 0..1 |
OpenModelAttribute
|
The properties of the service instance, e.g. frequencies or latency for this RAN slice instance.
3.1 Enumerations
3.1.1 CompositeOperator
Contains Enumeration Literals:
- AND
- OR
- XOR
3.1.2 Operator
Contains Enumeration Literals:
- MORETHAN
- LESSTHAN
- EQUAL
3.1.3 ServiceLcmEvent
Contains Enumeration Literals:
- EVENT_START_DEPLOYMENT
- EVENT_END_DEPLOYMENT
- EVENT_START_CONFIGURATION
- EVENT_END_CONFIGURATION
- EVENT_START_TERMINATION
- EVENT_END_TERMINATION
Option 1:
CcvpnProperties
A set of CCVPN case specific properties information, which are needed for CCVPN service with the function realization.
Parent class: ServiceProperties
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Experimental
3GPPServiceProfile
The set of 3GPP defined ServiceProfile for network slicing service function realization.
Parent class: ServiceProperties
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Experimental
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". | |||
serviceRole | String | 1 | OpenModelAttribute
Preliminary | An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". |
selfLink | Uri | 1 | OpenModelAttribute
Preliminary | URL to endpoint where more details can be gotten. |
orchestrationStatus | String | 1 | OpenModelAttribute
Preliminary | Orchestration status of the service instance. |
nsStatus | String | 1 | preliminary 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). |
instanceSharingNumber | Integer | 0...1 | OpenModelAttribute
preliminary | 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. |
1.1.5 ServiceCompositeInstance
Parent class: ServiceInstance
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
_resourceInstance | ResourceInstance |
Attribute Name
Type
Mult.
Stereotypes
Description
serviceProfileId
Identifier
1
OpenModelAttribute
· isInvariant: true
· valueRange: no range constraint
· support: MANDATORY
A unique identifier of property of network slice related requirement should be supported by the network slice instance.
nSSNSSAIList
invalid
1
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
This parameter specifies the S-NSSAI list to be supported by the new NSI to be created or the existing NSI to be re-used.
nSPLMNIdList
invalid
0..*
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
List of unique identities for PLMN.
nSPerfReq
0..* | OpenModelAttribute |
|
|
nSMaxNumberofUEs
Integer
1
OpenModelAttribute
· isInvariant: false
·
|
This parameter specifies the requirements to the NSI in terms of the scenarios defined in the TS 22.261 [28], such as Experienced data rate, Area traffic capacity (density) information of UE density.
It is a structure containing the following elements: - list of perfRequirements Depending on the sST value, the list of perfRequirements will be - list of eMBBPerfReq or - list of uRLLCPerfReq or - list of mIoTPerfReq NOTE: the list of mIoTPerfReq is not addressed in the present document.
Resource instance components of constituting a serivce instance. | ||||
serviceInstanceId | Identifier | 1 | OpenModelAttribute
Preliminary | Uniquely identifies this instance of a service. |
serviceInstanceName | String | 0...1 | OpenModelAttribute
|
|
|
|
Preliminary | The name assigned to the service-instance. |
serviceType |
String |
0.. |
1 | OpenModelAttribute |
|
|
|
An attribute specifies a list of TrackingAreas where the NSI can be selected.
nSLatency
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". |
serviceRole | String |
1 | OpenModelAttribute |
|
|
|
Preliminary | An |
optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". | |
selfLink | Uri |
nSUEMobilityLevel
1 | OpenModelAttribute |
|
|
|
An attribute specifies the mobility level of UE accessing the network slice instance. See 6.2.1 of TS 22.261. AllowedValues: stationary, nomadic, restricted mobility, fully mobility.
Preliminary | URL to endpoint where more details can be gotten. |
orchestrationStatus | String |
nSResourceSharingLevel
1 | OpenModelAttribute |
|
|
|
An attribute specifies whether the resources to be allocated to the network slice instance may be shared with another network slice instance(s). AllowedValues: shared, non-shared.
sST
Integer
1
OpenModelAttribute
·
Preliminary | Orchestration status of the service instance. | ||
nsStatus | String | 1 | preliminary OpenModelAttribute |
|
|
|
This parameter specifies the slice/service type for a ServiceProfile.
availability
EFloat
| 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). | |
InstanceSharingNumber | Integer | 0. |
..1 | OpenModelAttribute |
|
|
|
This parameter specifies the availability requirement for an network slice instance, expressed as a percentage.
servicedescriptor
ServiceDescriptor
1..*
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
Describe the relationship between a servvice and serviceProfile. One service can corresponding multiple specific service properties; one serviceProperties can be used for multiple ServiceDescriptor
3GPPSliceProfile
The set of 3GPP defined SliceProfile for network slicing subnet service fuction realization.
Parent class: ServiceProperties
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Experimental
preliminary | 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. |
1.1.6 ServiceInstance
ServiceInstance is used to model the run time representation of a service.
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name
Type
Mult.
Stereotypes
Description
sliceProfileId
Identifier
1
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
A unique identifier of the property of network slice subnet related requirement should be supported by the network slice subnet instance.
nSSSNSSAIList
invalid
1
OpenModelAttribute
· isInvariant: false
·Attribute Name | Type | Mult. | Stereotypes | Description |
serviceInstanceId | Identifier | 1 | OpenModelAttribute
|
|
|
This parameter specifies the S-NSSAI list to be supported by the new NSI to be created or the existing NSI to be re-used.
Preliminary | Uniquely identifies this instance of a service. |
serviceInstanceName | String |
nSSPLMNIdList
0.. |
.1 | OpenModelAttribute |
|
|
|
List of unique identities for PLMN.
nSSPerfReq
Preliminary | The name assigned to the service-instance. |
serviceType | String |
0.. |
1 | OpenModelAttribute |
|
|
|
This parameter specifies the requirements to the NSI in terms of the scenarios defined in the TS 22.261 [28], such as Experienced data rate, Area traffic capacity (density) information of UE density.
It is a structure containing the following elements: - list of perfRequirements Depending on the sST value, the list of perfRequirements will be - list of eMBBPerfReq or - list of uRLLCPerfReq or - list of mIoTPerfReq NOTE: the list of mIoTPerfReq is not addressed in the present document.
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". |
serviceRole | String |
nSSMaxNumberofUEs
1 | OpenModelAttribute |
|
|
nSSCoverageAreaTALis
Integer
1..*
OpenModelAttribute
·
Preliminary | An |
optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM". | |||
selfLink | Uri | 1 | OpenModelAttribute |
|
|
|
An attribute specifies a list of TrackingAreas where the NSI can be selected
nSSLatency
Preliminary | URL to endpoint where more details can be gotten. |
orchestrationStatus | String |
1 | OpenModelAttribute |
|
|
|
An attribute specifies the packet transmission latency (millisecond) through the RAN, CN, and TN part of 5G network and is used to evaluate utilization performance of the end-to-end network slice instance. See clause 6.3.1 of 28.554.
nSSUEMobilityLevel
UEMobilityLevel
1
OpenModelAttribute
·Preliminary | Orchestration status of the service instance. | ||
nsStatus | String | 1 | preliminary OpenModelAttribute |
|
|
nSSResourceSharingLevel
ResourceSharingLevel
1
OpenModelAttribute
· isInvariant: false
·
|
An attribute specifies the mobility level of UE accessing the network slice instance. See 6.2.1 of TS 22.261. AllowedValues: stationary, nomadic, restricted mobility, fully mobility.
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). | |||
instanceSharingNumber | Integer | 0...1 | OpenModelAttribute
|
|
|
An attribute specifies whether the resources to be allocated to the network slice subnet instance may be shared with another network slice subnet instance(s). AllowedValues: shared, non-shared.
servicedescriptor
ServiceDescriptor
1..*
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
Describe the relationship between a servvice and serviceProfile. One service can corresponding multiple specific service properties; one serviceProperties can be used for multiple ServiceDescriptor
GST
The set of GSMA defined GST properties for network slicing service fuction realization.
Parent class: ServiceProperties
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Experimental
Option 2:
CcvpnProperties
A set of CCVPN case specific properties information, which are needed for CCVPN service with the function realization.
Parent class: ServiceProperties
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Experimental
NetworkSlicingProperties
A set of Slicing case specific properties information, which are needed for network slicing service with the function realization.
Parent class: ServiceProperties
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
- Experimental
preliminary | 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. |
1.1.7 SelectionCriteria
SelectionCriteria finds descriptors and instances according to specific properties of those entities.
Applied stereotypes:
- preliminary
- OpenModelClass
- support: OPTIONAL
Attribute Name | Type | Mult. | Stereotypes | Description |
selectionCriteriaId | Identifier | 1 | OpenModelAttribute
preliminary | Unique indentifier of this SelectionCriteria. |
1.1.8 SelectionCriteriaAtomic
A simple (atomic) selection criteria that holds a specific attribute comparision expression.
Parent class: SelectionCriteria
Applied stereotypes:
- preliminary
- OpenModelClass
- support: MANDATORY
Attribute |
Name | Type | Mult. | Stereotypes | Description |
metricName |
String | 1 | OpenModelAttribute |
|
|
|
perfReq
PerfReq
0..*
OpenModelAttribute
· isInvariant: false
·
|
A unique identifier of property of network slice related requirement should be supported by the network slice instance.
preliminary | Name of compared parameter or attribute. | |||
operator | Operator | 1 | OpenModelAttribute
preliminary | Comparison operator, e.g. equal, less than, greater or etc. |
value | String | 1 | OpenModelAttribute
|
|
sNSSAIList
invalid
1
OpenModelAttribute
· isInvariant: false
·
|
It is a structure containing the following elements: - list of perfRequirements Depending on the sST value, the list of perfRequirements will be - list of eMBBPerfReq or - list of uRLLCPerfReq or - list of mIoTPerfReq NOTE: the list of mIoTPerfReq is not addressed in the present document.
This parameter specifies the requirements to the NSI in terms of the scenarios defined in the TS 22.261 [28], such as Experienced data rate, Area traffic capacity (density) information of UE density.
preliminary | Compared value (can be a name of a parameter in referenced class).
| ||
valueType | String | 1 | OpenModelAttribute
|
|
|
This parameter specifies the S-NSSAI list to be supported by the new NSI to be created or the existing NSI to be re-used.
resourceSharingLevel
ResourceSharingLevel
1
OpenModelAttribute
·preliminary | The type of the value property (String, Integer, Real, ...). | ||
| selectionCriteriaId | Identifier | 1 | OpenModelAttribute |
|
|
|
An attribute specifies whether the resources to be allocated to the network slice instance may be shared with another network slice instance(s). AllowedValues: shared, non-shared.
maxNumberofUEs
Integer
1
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: OPTIONAL
An attribute specifies the maximum number of UEs may simultaneously access the network slice instance.
preliminary | Unique indentifier of this SelectionCriteria. |
1.1.9 SelectionCriteriaComposite
A SelectionCriteriaComposite is an aggregation of multiple SelectionCriterias. Aggregation can be for example AND, OR or XOR logical operations.
Parent class: SelectionCriteriaComposite
Applied stereotypes:
- preliminary
- OpenModelClass
- support: MANDATORY
sST
Integer
0..1
OpenModelAttribute
· isInvariant: false
·Attribute Name | Type | Mult. | Stereotypes | Description |
compositeOperator | CompositeOperator | 1 | OpenModelAttribute
|
|
|
This parameter specifies the slice/service type for a ServiceProfile.
latency
Integer
1
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: OPTIONAL
preliminary |
Logical operation for SelectionCriterias composition, e.g. logical AND, OR or XOR. | |||
| selectionCriteriaId | Identifier | 1 | OpenModelAttribute
preliminary | Unique indentifier of this SelectionCriteria. |
2.1 Data Types
2.1.1 ServiceLifecycleManagementScript
The LifeCycleManagementScript information element specifies a script for the service.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
event | ServiceLcmEvent | 0..* | RW | OpenModelAttribute
preliminary | Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator reference point.
|
lcmTransitionEvent | String |
An attribute specifies the packet transmission latency (millisecond) through the RAN, CN, and TN part of 5G network and is used to evaluate utilization performance of the end-to-end network slice instance. See clause 6.3.1 of 28.554.
pLMNIdList
0..* | RW | OpenModelAttribute |
|
|
OpenModelAttribute
·
|
List of unique identities for PLMN.
uEMobilityLevel
UEMobilityLevel
1
preliminary | Describes the transition Service lifecycle event(s) that cannot be mapped to any of the enumerated values defined for the event attribute. | |||
script | String | 1 | RW | OpenModelAttribute |
|
|
coverageAreaTAList
Integer
1..*
OpenModelAttribute
· isInvariant: false
·
|
An attribute specifies the mobility level of UE accessing the network slice instance. See 6.2.1 of TS 22.261. AllowedValues: stationary, nomadic, restricted mobility, fully mobility.
preliminary | Includes a Service LCM script (e.g. written in a DSL) triggered to react to one of the events listed in the event attribute. | |||
scriptDsl | String | 1 | RW | OpenModelAttribute
|
|
|
An attribute specifies a list of TrackingAreas where the NSI can be selected.
availability
preliminary | Defines the domain specific language (i.e. the type) of script that is provided. Types of scripts could include bash, python, etc. |
scriptInput | KeyValuePair |
0.. |
* | RW | OpenModelAttribute |
|
|
|
This parameter specifies the availability requirement for an network slice instance, expressed as a percentage.
servicedescriptor
ServiceDescriptor
1..*
OpenModelAttribute
· isInvariant: false
· valueRange: no range constraint
· support: MANDATORY
Describe the relationship between a servvice and serviceProfile. One service can corresponding multiple specific service properties; one serviceProperties can be used for multiple ServiceDescriptor
BBSProperties
A set of BBS case specific properties information, which are needed for BBS service with the function realization.
Parent class: ServiceProperties
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
preliminary | Array of KVP requirements with the key as the parameter name and the value as the parameter that need to be passed as an input to the script. Note: The scriptInput values are passed to the scripts in addition to the parameters received in the operation invocation request or indicator value change. |
3.1 Enumerations
3.1.1 CompositeOperator
Contains Enumeration Literals:
- AND
- OR
- XOR
3.1.2 Operator
Contains Enumeration Literals:
- MORETHAN
- LESSTHAN
- EQUAL
3.1.3 ServiceLcmEvent
Contains Enumeration Literals:
- EVENT_START_DEPLOYMENT
- EVENT_END_DEPLOYMENT
- EVENT_START_CONFIGURATION
- EVENT_END_CONFIGURATION
- EVENT_START_TERMINATION
- EVENT_END_TERMINATIONExperimental