/
Enhanced Service Information Model for Nested and Shared Services

Enhanced Service Information Model for Nested and Shared Services

Owned by guochuyi
Last updated: Dec 15, 2019 by Borislav Glozman

Discussion Contributions:

CSARs: 


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

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

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    OPTIONAL

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

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).



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

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

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    OPTIONAL

preliminary

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

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

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    OPTIONAL

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

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Resource instance components of constituting a serivce instance. 


serviceInstanceId

Identifier

1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

Uniquely identifies this instance of a service.



serviceInstanceName

String

0...1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    OPTIONAL

Preliminary

The name assigned to the service-instance.



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

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".



selfLink

Uri

1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

URL to endpoint where more details can be gotten.



orchestrationStatus

String

1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

Orchestration status of the service instance.



nsStatus

String

1

preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

 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

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

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

0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Resource instance components of constituting a serivce instance.

serviceInstanceId

Identifier

1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

Uniquely identifies this instance of a service.



serviceInstanceName

String

0...1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    OPTIONAL

Preliminary

The name assigned to the service-instance.

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

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".



selfLink

Uri

1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

URL to endpoint where more details can be gotten.

orchestrationStatus

String

1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

Orchestration status of the service instance.

nsStatus

String

1

preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

 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

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

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

serviceInstanceId

Identifier

1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

Uniquely identifies this instance of a service.



serviceInstanceName

String

0...1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    OPTIONAL

Preliminary

The name assigned to the service-instance.



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

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".



selfLink

Uri

1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

URL to endpoint where more details can be gotten.



orchestrationStatus

String

1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

Preliminary

Orchestration status of the service instance.



nsStatus


String

1

preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

 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

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY

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.