...
| Table of Contents | ||
|---|---|---|
|
NOTE: Details of ParameterGroup and related structure, you can find here: Dynamic Parameters
...
Attribute Name | Type | Mult. | Stereotypes | Description | ||
_serviceAtomicInstance | ServiceAtomicInstance | 0..* | OpenModelAttribute
| An implementation of atomic Service corresponding to a ServicecAtomicDescriptor. | ||
_resourceDesc (resourcespecification) | ResourceDesc (ResourceSpecification) | 0..* | OpenModelAttribute
| Resource components of constituting a serivce descriptor. | ||
serviceInvariantId | Identifier | 1 | OpenModelAttribute
Preliminary | Constant identifier of the service model. | ||
serviceId | Identifier | 1 | OpenModelAttribute
Preliminary | Versioned identifier of the service model (this id is changed for every major version of the service) | ||
name | String | 1 | OpenModelAttribute
Preliminary | The name of the service model designed. | ||
description | String | 1 | OpenModelAttribute
Preliminary | The description of the service model designed. | ||
category | String | 1..* | OpenModelAttribute
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...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 | 0..1 | OpenModelAttribute
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. | ||
_serviceInstance | ServiceInstance | 0..* | OpenModelAttribute
| An instance of Service deployment. | ||
isShared | Boolean | 1 | OpenModelAttribute
| 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
| Describes the configurable properties of the service.
| ||
lifecycleManagementScript | ServiceLifecycleManagementScript | 0..* | OpenModelAttribute
| Includes a list of events and corresponding management scripts performed for the Service.
| maxAvailableNumber | Integer | 0..
1
...
OpenModelAttribute
- isInvariant: false
- valueRange: no range constraint
...
1.1.2 ServiceCompositeDescriptor
...
Attribute Name | Type | Mult. | Stereotypes | Description | ||||
serviceInvariantId | Identifier | 1 | OpenModelAttribute
| Constant identifier of the Service Component model. | ||||
serviceId | Identifier | 1 | OpenModelAttribute
| Versioned identifier of the Service Component model (this id is changed for every major version of the service component). | ||||
name | String | 1 | OpenModelAttribute
| The name of the service component. | ||||
description | String | 1 | OpenModelAttribute
| The description of service component. | ||||
category | String | 1..* | OpenModelAttribute
Preliminary | A predefined list which identifies the construct's category. There is a predefined list of service categories. | ||||
version | String | 1 | OpenModelAttribute
| The version of service component. | ||||
_serviceDescriptor | ServiceDescriptor | 1..* | OpenModelAttribute
| Describe the nested relationship between multiple Serive Descriptors. | ||||
_serviceCompositeInstance | ServiceCompositeInstance | 0..* | OpenModelAttribute
| An implementation of composite Service corresponding to a ServiceCompositeDescriptor. | ||||
_resourceDesc (resourcespecification) | ResourceDesc (ResourceSpecification) | 0..* | OpenModelAttribute
| Resource components of constituting a serivce descriptor. | ||||
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 | 0..1 | OpenModelAttribute
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. | ||||
_serviceInstance | ServiceInstance | 0..* | OpenModelAttribute
| An instance of Service deployment. | ||||
isShared | Boolean | 1 | OpenModelAttribute
| 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
| Describes the configurable properties of the service. | ||||
lifecycleManagementScript | ServiceLifecycleManagementScript | 0..* | OpenModelAttribute
| Includes a list of events and corresponding management scripts performed for the Service. | maxAvailableNumber | Integer | 0..1 | Experimental OpenModelAttribute isInvariant: false |
1.1.3 ServiceDescriptor
...
Attribute Name | Type | Mult. | Stereotypes | Description |
serviceInvariantId | Identifier | 1 | OpenModelAttribute
Preliminary | Constant identifier of the service model. |
serviceId | Identifier | 1 | OpenModelAttribute
Preliminary | Versioned identifier of the service model (this id is changed for every major version of the service) |
name | String | 1 | OpenModelAttribute
Preliminary | The name of the service model designed. |
description | String | 1 | OpenModelAttribute
Preliminary | The description of the service model designed. |
category | String | 1..* | OpenModelAttribute
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...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 | 0..1 | OpenModelAttribute
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 | OpenModelAttribute
| 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
| Describes the configurable properties of the service. |
lifecycleManagementScript | ServiceLifecycleManagementScript | 0..* | OpenModelAttribute
| 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..* | maxAvailableNumber | Integer | 0..1 | ExperimentalOpenModelAttribute
| no
| Allowed max number of the shared times at the same time that the service can provide.
2. What if the nested scene, does the number of child service will affect the parent one? |
1.1.4 ServiceAtomicInstance
Parent class: ServiceInstance
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Resource instance components of constituting a serivce instance. | |||||||||||||
serviceInstanceId | Identifier | 1 | OpenModelAttribute
Preliminary | Uniquely identifies this instance of a service. | |||||||||
serviceInstanceName | String | 0...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 | serviceInstanceName | String | 0...1 | OpenModelAttribute
Preliminary | The name assigned to the service-instance. |
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 | 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 | 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). | |||||||||
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. | |||||||||
| _instanceProperties | ServiceInstancePropertiesInstanceProperties | 0.. | .1* | OpenModelAttribute
| no
| MANDATORY | A set of attributes that hold the service specific information. For example, network slice profile will hold network slice specific parameters, which are not relevant for other servicesOne service instance will include one or more InstanceProperties classes. |
1.1.5 ServiceCompositeInstance
...
Attribute Name | Type | Mult. | Stereotypes | Description | ||||||
_resourceInstance | ResourceInstance | 0..* | OpenModelAttribute
| Resource instance components of constituting a serivce instance. | ||||||
availableInstanceNumberserviceInstanceId | KeyValuePairIdentifier | 1 | OpenModelAttribute
| This attribute is to show the numbers its service components can be shared. {ServiceComponetId, number}={xxx,xxx}. | serviceInstanceId | Identifier | 1 | OpenModelAttribute
Preliminary |
Preliminary | Uniquely identifies this instance of a service. |
serviceInstanceName | String | 0... | serviceInstanceName | String | 0...1 | OpenModelAttribute
Preliminary | The name assigned to the service-instance. | |||
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 | 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 | 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). | ||||||
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 | ServiceInstancePropertiesInstanceProperties | 0.. | .1* | OpenModelAttribute
| no
| MANDATORY | MANDATORYA set of attributes that hold the service specific information. For example, network slice profile will hold network slice specific parameters, which are not relevant for other services.One service instance will include one or more InstanceProperties classes. |
1.1.6 ServiceInstance
...
Attribute Name | Type | Mult. | Stereotypes | Description |
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.availableInstanceNumber |
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 | 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 | 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). |
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 | ServiceInstancePropertiesInstanceProperties | 0...1* OpenModelAttribute | OpenModelAttribute
| MANDATORY A set of attributes that hold the service specific information. For example, network slice profile will hold network slice specific parameters, which are not relevant for other servicesOne service instance will include one or more InstanceProperties classes. |
1.1.7 SelectionCriteria
...
- Experimental
- OpenModelClass
- support: MANDATORY
Attribute Name
Type
Mult.
Stereotypes
Description
_serviceDescriptor
ServiceDescriptor
1..*
Attribute Name | Type | Mult. | Stereotypes | Description |
compositeOperator | CompositeOperator | 1 | OpenModelAttribute
|
Logical operation for SelectionCriterias composition, e.g. logical AND or OR. |
| selectionCriteriaId | Identifier | 1 | OpenModelAttribute
| Unique indentifier of this SelectionCriteria. |
1.1.10 ServiceProperties
A set of properties that hold the service specific information. For example, network slice profile will hold network slice specific parameters, which are not relevant for other services.
A set of properties that hold the service specific information, which are strongly related to this service with the function realization. Those attributes usually work together and present as a group during service instantiation, and can come from a SDO or a specific use case requirements. For example, when instanciating a network slice service, serviceProperties will hold network slice specific parameters, which are not relevant for other services.
Applied stereotypes:
- OpenModelClass
- support: MANDATOR
. logical AND or OR. | |||
| selectionCriteriaId | Identifier | 1 |
OpenModelAttribute
|
Uniquely references a SD.
Describe the relationship between a service and serviceProfile. One service can support multiple specific service properties; one serviceProperties can be used for multiple ServiceDescriptor.
| 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
...
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.
|
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. |
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. |
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. |
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. |
2.1.2 2 ServiceInstanceProperties
Record a set of property information this service instance holds.
Attribute Name | Type | Mult. | Access | Stereotypes | Description |
|
|
|
|
|
|
3.1 Enumerations
3.1.1 CompositeOperator
...