summaryrefslogtreecommitdiffstats
path: root/docs/ONAP release 1 spec/im/service-im.rst
blob: 7e93e41004b49f74adaa58de16924d15a0e1ee36 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
===================================================================
ONAP Service Descriptor Information Model Specification (Amsterdam)
===================================================================

Scope
-----

The scope of the present document is to describe the SD Information Model Specification.

Terms, Definitions and Abbreviations
------------------------------------

For the purposes of the present document, the following abbreviations apply:

+-----------------+---------------------------------------------------------------------+
|  Abbreviation   |                      Definition                                     |
+-----------------+---------------------------------------------------------------------+
|      SO         | Service Orchestrator                                                |
+-----------------+---------------------------------------------------------------------+
|      SD         | Service Descriptor                                                  |
+-----------------+---------------------------------------------------------------------+
|      RD         | Resource Descriptor                                                 |
+-----------------+---------------------------------------------------------------------+
|      VF         | Virtual Function                                                    |
+-----------------+---------------------------------------------------------------------+

SD Infomration Model Overview
-----------------------------

The Service Descriptor (SD) is a deployment template which consists of information used by the Service Orchestrator (SO) for life cycle management of a service.
A service is a composition of resources. The description of a service as used by the Service Orchestration (SO) to deploy a service instance includes or references the descriptors of its constituent objects: one or more resources;
A resource could be a VL, VF, WAN Descriptor etc.

Functional Requirements
-----------------------

The following table specifies requirements to the templates for SD instances.

+------------------+-------------------------------------------------------+
|   Numbering      |                Requirement Description                |
+------------------+-------------------------------------------------------+
|   NST_SD001      | The SD shall reference the resource applicable to its |
|                  | constituent services.                                 |
+------------------+-------------------------------------------------------+       

SD Information Model Definitions
--------------------------------
The SD information element is a template whose instances are used by the SO for the lifecycle management of Services.

+-----------+-----------+-------------+----------+-------------------------------------------+
|Attribute  | Qualifier | Cardinality |  Content |                 Description               |
+-----------+-----------+-------------+----------+-------------------------------------------+
|    id     |     M     |      1      |Identifier| Identifier of this SD information element.|
|           |           |             |          |It globally uniquely identifies an instance|
|           |           |             |          |of the SD.                                 |
+-----------+-----------+-------------+----------+-------------------------------------------+
| designer  |     M     |      1      | String   | Designer of this SD.                      |
+-----------+-----------+-------------+----------+-------------------------------------------+
|   name    |     M     |      1      | String   | The name of the SD.                       |
+-----------+-----------+-------------+----------+-------------------------------------------+
| version   |     M     |      1      | String   | The vesion of the SD.                     |
+-----------+-----------+-------------+----------+-------------------------------------------+
|description|     M     |      1      | String   | The description of the SD.                |
+-----------+-----------+-------------+----------+-------------------------------------------+
|  vendor   |     M     |      1      | String   | The vendor of the SD. (TBD)               |
+-----------+-----------+-------------+----------+-------------------------------------------+    
|    type   |     M     |      1      | String   | Value set to "Service".                   |
+-----------+-----------+-------------+----------+-------------------------------------------+
| category  |     M     |      1      | String   | Value set to either "E2E" or "NS".        |
+-----------+-----------+-------------+----------+-------------------------------------------+
|serviceType|     M     |      1      | String   | The ServiceType of the SD.                |
+-----------+-----------+-------------+----------+-------------------------------------------+
|ServiceRole|     M     |      1      | String   | The ServiceRole of the SD.                |
+-----------+-----------+-------------+----------+-------------------------------------------+
|  resource |     M     |    1..N     | RD       | The consituent RDs of the SD.             |
|           |           |             |          | It could be VF/WAN Descriptor etc.        |
+-----------+-----------+-------------+----------+-------------------------------------------+