Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Discussion Contributions:

View file
nameONAP network slice modeling - for modeling subcommittee v3.10.pptx
height250

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
printablefalse

Image Removed

Image Removed                           Image Removed 

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

CSARs: 

View file
nameNetworkSlicingCSARS.zip
height150


Table of Contents
printablefalse

NOTE: Details of ParameterGroup and related structure, you can find here: Dynamic Parameters

Image Added


1.1       Classes

1.1.1            ServiceAtomicDescriptor

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.

 

 

...

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint

...

1.1.2            ServiceCompositeDescriptor

...

Parent class: ServiceDescriptor

Applied stereotypes:

  • OpenModelClass
    • support: MANDATORY


Versioned identifier of the Service Component   model (this id is changed for every major version of the service   component).

MANDATORY.

Attribute   Name

Type

Mult.

Stereotypes

DescriptionserviceInvariantId

_serviceAtomicInstance

Identifier

ServiceAtomicInstance

0..*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

 An implementation of atomic Service corresponding to a ServicecAtomicDescriptor.


_resourceDesc   (resourcespecification)

ResourceDesc   (ResourceSpecification)

0..*

name

String

1

OpenModelAttribute

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

The name of the service component.

Resource components of constituting a serivce descriptor. 

serviceInvariantId

Identifier

description

String

1

OpenModelAttribute

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

Preliminary

Constant identifier of the service modelThe description of service component.



categoryserviceId

StringIdentifier

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

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 version name of the service componentmodel designed.



_serviceDescriptordescription

ServiceDescriptorString

1..*

OpenModelAttribute

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

 Describe the nested relationship between multiple Serive Descriptors.

Preliminary

The description of the service model designed.



category

String

1

_serviceCompositeInstance

ServiceCompositeInstance

0..*

OpenModelAttribute

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

An implementation of composite Service corresponding to a ServiceCompositeDescriptor.

Preliminary

A predefined list which identifies the construct's category. There is a predefined list of service categories.



version

String

1

_resourceDesc   (resourcespecification)

ResourceDesc   (ResourceSpecification)

0..*

OpenModelAttribute

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

Preliminary

The service descriptor version.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 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 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  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
0..* OPTIONAL  Experimental no MANDATORY

Attribute   Name

Type

Mult.

Stereotypes

Description

serviceInvariantId

Identifier

1

configurableProperties

KeyValuePair

0..1

OpenModelAttribute

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

Describes the configurable properties of the service.

lifecycleManagementScript

ServiceLifecycleManagementScript

OpenModelAttribute

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

Constant identifier of the Service   Component model.



serviceId

Identifier

1

Includes a list of events and corresponding management scripts performed for the Service.

 maxAvailableNumber Integer 0..1

OpenModelAttribute

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

1.1.3            ServiceDescriptor

ServiceDescriptor is used to model the design time representation of a service.

Parent class: DesignEntity

Applied stereotypes:

  • OpenModelClass
    • support: MANDATORY
  •     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

Attribute   Name

Type

Mult.

Stereotypes

Description

serviceInvariantId

Identifier

1

OpenModelAttribute

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

Preliminary

Constant identifier of the service modelThe description of service component.



serviceIdcategory

IdentifierString

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

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 version of the service model designedcomponent.



description_serviceDescriptor

StringServiceDescriptor

1..*

OpenModelAttribute

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

Preliminary

The description of the service model designed.

category

 Describe the nested relationship between multiple Serive Descriptors.


_serviceCompositeInstance

ServiceCompositeInstance

0

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

An implementation of composite Service corresponding to a ServiceCompositeDescriptor.


_resourceDesc   (resourcespecification)

ResourceDesc   (ResourceSpecification)

0..*

OpenModelAttribute

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

Preliminary

The service descriptor version.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 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 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 serviceservice.



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

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

preliminary

  Experimental

OpenModelAttribute

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

Includes a list of events and corresponding management scripts performed for the Service.

 maxAvailableNumber  Integer0..1 

.

1.1

...

.3            ServiceDescriptor

ServiceDescriptor is used to model the design time representation of a service.

Parent class: ServiceInstance DesignEntity

Applied stereotypes:

  • OpenModelClass
    • support: MANDATORY
0...

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.

0...1 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

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

_resourceInstance

ResourceInstance

0..*

OpenModelAttribute

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

Resource instance components of constituting a serivce instance. 

Preliminary

Versioned identifier of the service model   (this id is changed for every major version of the service)



name

String

serviceInstanceId

Identifier

1

OpenModelAttribute

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

Preliminary

Uniquely identifies this instance of a serviceThe name of the service model designed.



serviceInstanceNamedescription

String

0...1

OpenModelAttribute

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

Preliminary

The name assigned to description of the service -instancemodel designed.



serviceTypecategory

String

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

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

The service descriptor version.



serviceType

String

0...

selfLink

Uri

1

OpenModelAttribute

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

Preliminary

URL to endpoint where more details can be gotten.

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

orchestrationStatus

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



icon

Orchestration status of the service instance.

nsStatus

String

1

Experimental

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

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

instanceProperties

ServiceInstanceProperties

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
    a generic

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.

availableInstanceNumber

KeyValuePair

1

OpenModelAttribute

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

This attribute is to show the numbers its service components can be shared.

{ServiceComponetId, number}={xxx,xxx}.

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

".



selfLink

Uri

orchestrationStatus

String

1

OpenModelAttribute

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

Preliminary

URL to endpoint where more details can be gotten.



orchestrationStatus

Orchestration status of the service instance.

nsStatus

String

1

Experimental

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

Preliminary

Orchestration status of the service instance.



nsStatus

String

1

InstanceSharingNumber

Integer

0...1

preliminary

OpenModelAttribute

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

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.

 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

instanceProperties

ServiceInstanceProperties

0...1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    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 services.

1.1.6            ServiceInstance

ServiceInstance is used to model the run time representation of a service.

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
availableInstanceNumber for defining instanceSharingNumber instances of the service used by other services shows this service .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 services.

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

Experimentalpreliminary

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

instanceProperties

ServiceInstanceProperties

0...1

OpenModelAttribute

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

.

1.1.

...

6            ServiceInstance

ServiceInstance is used to model the run time representation of a serviceSelectionCriteria finds descriptors and instances according to specific properties of those entities.

Applied stereotypes:

  • Experimental
  • OpenModelClass
    • support:   OPTIONALMANDATORY

Attribute   Name

Type

Mult.

Stereotypes

Description

selectionCriteriaId

serviceInstanceId

Identifier

1

OpenModelAttribute

  • isInvariant: false
  • valueRange:  no range constraint
  • support:    MANDATORY
  • 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:

    ...

     
    • support:    MANDATORY

    Attribute   Name

    Type

    Mult.

    Stereotypes

    Description

    Preliminary

    Uniquely identifies this instance of a service.



    serviceInstanceName

    String

    0...

    metricName

    String

    1

    OpenModelAttribute

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

    Name of compared parameter or attribute.

    •     OPTIONAL

    Preliminary

    The name assigned to the service-instance.



    serviceType

    String

    0..

    operator

    Operator

    1

    OpenModelAttribute

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

    Comparison operator, e.g. equal, less than, greater or etc.

    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

    value

    KeyValuePair

    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

    Compared value (can be a name of a parameter in referenced class).

     

    selectionCriteriaId Identifier 1

    OpenModelAttribute

    • isInvariant: false
    • valueRange:  no range constraint
    • support:    MANDATORY
    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

    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

    Attribute   Name

    Type

    Mult.

    Stereotypes

    Description

    compositeOperator

    CompositeOperator

    1

    OpenModelAttribute

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

     

     Logical operation for SelectionCriterias composition,  e.g. logical AND or OR.

    selectionCriteriaId Identifier 1 

    OpenModelAttribute

    • isInvariant: false
    • valueRange:  no range constraint
    • support:    MANDATORY
    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. For example, when instanciating a network slice service, serviceProperties will hold network slice specific parameters, which are not relevant for other services.

    Applied stereotypes:

    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
    • OpenModelClass
      • support: MANDATOR

    Attribute   Name

    Type

    Mult.

    Stereotypes

    Description

    _serviceDescriptor

    selectionCriteriaId

    ServiceDescriptor

    Identifier

    1

    ..*

    OpenModelAttribute

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

    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.

        

    2.1       Data Types

    2.1.1           ServiceLifecycleManagementScript

    The LifeCycleManagementScript information element specifies a script for the service.

    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

    Attribute  Name

    Type

    Mult.

    Access

     

    Stereotypes

    Description

    event

    ServiceLcmEvent

    0..*

    RW

    metricName

    String

    1

    OpenModelAttribute

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

    preliminary

    Name of compared parameter or attribute.

    operator

    Operator

    1

    OpenModelAttribute

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

     Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator  reference point.

     

     

    lcmTransitionEvent

    String

    0..*

    RW

    script

    String

    1

    RW

    OpenModelAttribute

    preliminary

    Comparison operator, e.g. equal, less than, greater or etc.

    value

    String

    1

    OpenModelAttribute

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

     Describes the transition Service lifecycle event(s) that cannot be mapped to any of the enumerated values defined for the event attribute.

    preliminary

    Compared value (can be a name of a parameter in referenced class).

     

    valueType

    String 1 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

      RW

      OpenModelAttribute

      preliminary

      The type of the value property (String, Integer, Real, ...).

       
      selectionCriteriaId Identifier 1 OpenModelAttribute
      • isInvariant: false
      • valueRange:  no range constraint
      • support:    MANDATORY

       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

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

       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

      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

      Attribute  Name

      Type

      Mult.

      Access

       Stereotypes

      Description

      instanceProperties

      KeyValuePair

      0..*

      RW

      OpenModelAttribute

      Attribute   Name

      Type

      Mult.

      Stereotypes

      Description

      compositeOperator

      CompositeOperator

      1

      OpenModelAttribute

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

      preliminary

       

       Logical operation for SelectionCriterias composition,  e.g. logical AND, OR or XOR.

      selectionCriteriaId Identifier 1 OpenModelAttribute
      • isInvariant: false
      • valueRange:  no range constraint
      • support:    MANDATORY
      The properties of the service instance, e.g. frequencies or latency for this RAN slice instance

      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

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

      preliminary

       Describes Service lifecycle event(s) or an external stimulus detected on an orchestrator  reference point.

       

       

      lcmTransitionEvent

      String

      0..*

      RW

      OpenModelAttribute

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

      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

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

      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

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

      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

      • isInvariant: false
      • valueRange:  no range constraint
      • 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_TERMINATION

      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

      3GPPSliceProfile

      The set of 3GPP defined SliceProfile for network slicing subnet service fuction realization.

      Parent class: ServiceProperties

      Applied stereotypes:

      • OpenModelClass
      • support: MANDATORY
      • Experimental

      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

      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
      • Experimental