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

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

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.

 

configurablePropertieslifecycleManagementScript

ServiceConfigurablePropertiesServiceLifecycleManagementScript

0..1*

OpenModelAttribute

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

Describes the configurable properties of the service.

 

 

preliminary

Includes

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

Preliminary

An optional string field for shortcode   that defines the function that the service is providing. E.g.   "MISVPN" or "AIM".

The icon path of the service.

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

_filterserviceType

FilterString

0..*.1

OpenModelAttribute

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

Filter upon which a correct Shared ServiceDescriptor is chosen. It can hold both service properties (e.g. some parameter that makes one service descriptor different from another, like mobility assuming there are different service property values for mobility types) and runtime attributes upon which correct service instance is chosen.

  • 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

filterRules

KeyValuePair

0..*

OpenModelAttribute

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

Preliminary

An optional string field for shortcode   that defines the function that the service is providing. E.g.   "MISVPN" or "AIM".



icon

String

Describe the correspondence for which filter rules are for each composited service descriptor.

The value pair for this attribute can has the format :

 {ServiceComponetId, filterId}={xxx,xxx}.

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

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

icon

String

1

OpenModelAttribute

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

Preliminary

_serviceInstance

0..*

OpenModelAttribute

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

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.

  • 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
0.. OPTIONAL0..* OPTIONAL

Attribute   Name

Type

Mult.

Stereotypes

Description

serviceInvariantId

Identifier

configurableProperties

ServiceConfigurableProperties

1

OpenModelAttribute

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

Describes the configurable properties of the service.

lifecycleManagementScript

ServiceLifecycleManagementScript

  • MANDATORY

Preliminary

Constant identifier of the service model.



serviceId

Identifier

1

OpenModelAttribute

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

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.

Applied stereotypes:

  • OpenModelClass
    • support: MANDATORY
0..

Preliminary

An optional string field for shortcode that defines the function that the service is providing. E.g.   "MISVPN" or "AIM".

1 MANDATORY

Preliminary

The icon path of the service.

  • MANDATORY

Preliminary

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



name

String

Attribute   Name

Type

Mult.

Stereotypes

Description

serviceInvariantId

Identifier

1

OpenModelAttribute

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

Preliminary

Constant identifier The name of the service model designed.



serviceIddescription

IdentifierString

1

OpenModelAttribute

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

Preliminary

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



categoryname

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

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 designedservice descriptor version.



categoryserviceType

String

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

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

version

String

1

OpenModelAttribute

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

Preliminary

The service descriptor version.

An optional string field for shortcode that defines the function that the service is providing. E.g.   "MISVPN" or "AIM".



icon

String

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

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

icon

String

OpenModelAttribute

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

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.

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
0..1 OPTIONAL0..* OPTIONAL

Attribute   Name

Type

Mult.

Stereotypes

Description

_resourceInstance

ResourceInstance

0..*

configurableProperties

ServiceConfigurableProperties

OpenModelAttribute

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

Describes the configurable properties of the service.

lifecycleManagementScript

ServiceLifecycleManagementScript

  • MANDATORY

Resource instance components of constituting a serivce instance. 


serviceInstanceId

Identifier

1

OpenModelAttribute

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

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

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. 

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

serviceInstanceId

Identifier

1

OpenModelAttribute

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

Preliminary

Uniquely identifies this instance of a service.

An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM".



selfLink

Uri

serviceInstanceName

String

0...1

OpenModelAttribute

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

Preliminary

URL to endpoint where more details can be gotten.



orchestrationStatus

The name assigned to the service-instance.

serviceType

String

0..1

OpenModelAttribute

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

Preliminary

Orchestration status of the service instance.



nsStatus

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

preliminary

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

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

selfLink

Uri

1

OpenModelAttribute

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

Preliminary

URL to endpoint where more details can be gotten.

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
Integer    MANDATORY

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.

ServiceInstanceProfile.

Attribute   Name

Type

Mult.

Stereotypes

Description

_resourceInstance

ResourceInstance

0..*

OpenModelAttribute

  • isInvariant: false

orchestrationStatus

String

1

OpenModelAttribute

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

Preliminary

Orchestration status of the service Resource instance components of constituting a serivce instance.

nsStatusserviceInstanceId

StringIdentifier

1Experimental

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

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

instanceProfile

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

Parent class: ServiceInstance

Applied stereotypes:

  • OpenModelClass
    • support: MANDATORY
0..*String    OPTIONAL

Preliminary

An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM".

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.

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

Attribute   Name

Type

Mult.

Stereotypes

Description

_resourceInstance

ResourceInstance

OpenModelAttribute

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

Resource instance components of constituting a serivce instance.

Preliminary

URL to endpoint where more details can be gotten.

orchestrationStatus

String

availableInstanceNumber

Integer

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

serviceInstanceId

Identifier

  •     MANDATORY

Preliminary

Orchestration status of the service instance.

nsStatus

String

1

preliminary1

OpenModelAttribute

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

Preliminary

Uniquely identifies this instance of a service.

serviceInstanceName

 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:

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

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

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

0...1

OpenModelAttribute

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

instanceProfile

ServiceInstanceProfile

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.

Applied stereotypes:

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

Uniquely identifies this instance of a service.

The name assigned to the service-instance.availableInstanceNumber

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

An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM".

URL to endpoint where more details can be gotten.

Orchestration status of the service instance.

nsStatus

0...ServiceInstanceProfile    MANDATORY

Attribute   Name

Type

Mult.

Stereotypes

Description

serviceInstanceId

Identifier

Attribute   Name

Type

Mult.

Stereotypes

Description

serviceInstanceId

Identifier

1

OpenModelAttribute

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

Preliminary

serviceInstanceName

String

0...1

OpenModelAttribute

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

Preliminary

serviceType

String

0..1

OpenModelAttribute

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

Preliminary

serviceRole

String

1

OpenModelAttribute

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

Preliminary

selfLink

Uri

1

OpenModelAttribute

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

Preliminary

orchestrationStatus

String

1

OpenModelAttribute

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

Preliminary

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

1

OpenModelAttribute

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

Preliminary

Uniquely identifies this instance of a service.



serviceInstanceName

String

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.

instanceProfile

0...1

OpenModelAttribute

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

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

Filter is used to find service descriptors and service instances according to specific properties of those services

Applied stereotypes:

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

Attribute   Name

Type

Mult.

Stereotypes

Description

filterId

Identifier

1

OpenModelAttribute

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

Unique indentifier of this filter.

1.1.8            FilterAtomic

A simple filter that holds a specific attributes comparison expression.

Parent class: filter

Applied stereotypes:

  • Experimental
  • OpenModelClass
    • support: MANDATORY
  • valueRange:  no range constraint
  • support:    MANDATORY
  • Compared value (can be a name of a parameter in referenced class).

     

    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

    Attribute   Name

    Type

    Mult.

    Stereotypes

    Description

    metricName

    String

    1

    OpenModelAttribute

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

    Name of compared parameter or attribute of the class that references the filter.

    operator

    Operator

    Preliminary

    Orchestration status of the service instance.



    nsStatus


    String

    1

    preliminary1

    OpenModelAttribute

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

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

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

    value

    KeyValuePair

    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.

    A filter that is an aggregation of multiple atomic filters. Aggregation can be for example AND or OR logical operations.

    Parent class: filter

    Applied stereotypes:

    • Experimentalpreliminary
    • OpenModelClass
      • support: MANDATORY  OPTIONAL

    Attribute   Name

    Type

    Mult.

    Stereotypes

    Description

    compositeOperator

    selectionCriteriaId

    CompositeOperator

    Identifier

    0..

    1

    OpenModelAttribute

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

     

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

    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

    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.

    Applied stereotypes:

    • OpenModelClass
      • support: MANDATOR

    Attribute   Name

    Type

    Mult.

    Stereotypes

    Description

    _serviceDescriptor

    ServiceDescriptor

    0..*

    Attribute   Name

    Type

    Mult.

    Stereotypes

    Description

    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

    Uniquely references a SD.

    profileId

    Identifier profileProperties KeyValuePair

    0..*

    OpenModelAttribute

    preliminary

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

    value

    String

    1

    OpenModelAttribute

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

     Unique identifier of this Service Profile.

    preliminary

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

     

    valueType

    String 1 OpenModelAttribute
    • isInvariant: false
    • valueRange:
    no

    Attribute  Name

    Type

    Mult.

    Access

     Stereotypes

    Description

    properties

    KeyValuePair

    0..*

    RW

    OpenModelAttribute
    •  no range constraint
    • support:    MANDATORY

    Specific properties this service holds.

        

    2.1       Data Types

    2.1.1            ServiceConfigurableProperties

    Define the configurable properties of the service.

    preliminary

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

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

     Describe the specific configurable properties for the service.

     

    2.1.2           ServiceLifecycleManagementScript

    The LifeCycleManagementScript information element specifies a script for the service.

    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

    Attribute  Name

    Type

    Mult.

    Access

     

    Stereotypes

    Description

    event

    compositeOperator

    ServiceLcmEvent

    0..*

    RW

    CompositeOperator

    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

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

    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

    instanceProperties

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

    Attribute  Name

    Type

    Mult.

    Access

     Stereotypes

    Description

    event

    ServiceLcmEvent

    0..*

    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.

    preliminary

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

     

     

    lcmTransitionEvent

    String

    0..*

    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.

     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

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

     Record a set of property information this service instance holds, for example latency of this instance.

    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
  • The properties of the service instance, e.g. frequencies or latency for this RAN slice instance.

     

     

    • 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           CompositeOperator1           CompositeOperator

    Contains Enumeration Literals:

    •  AND
    •  OR
    •  XOR

    3.1.2           Operator2           Operator

    Contains Enumeration Literals:

    •  MORETHAN
    •  LESSTHAN
    •  EQUAL

    3.1.3           ServiceLcmEvent3           ServiceLcmEvent

    Contains Enumeration Literals:

    •  EVENT_START_DEPLOYMENT
    •  EVENT_END_DEPLOYMENT
    •  EVENT_START_CONFIGURATION
    •  EVENT_END_CONFIGURATION
    •  EVENT_START_TERMINATION
    •  EVENT_END_TERMINATION