docs/ONAP release 2 spec/im/LifecycleManagementScript.rst


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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

.. Copyright 2018 (China Mobile)
.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode

Class: LifecycleManagementScript
================================

+--------------------+-------------+------------------+-------------------+-------------------------------------+
| **Attribute Name** | **Type**    | **Multiplicity** | **Description**   | **Applied Stereotypes**             |
+====================+=============+==================+===================+=====================================+
| event              | Enum        | 0..N             | Describes         | support:                            |
|                    |             |                  | VNF               | MANDATORY                           |
|                    |             |                  | lifecycle         |                                     |
|                    |             |                  | event(s) or       | valueRange:                         |
|                    |             |                  | an external       | for                                 |
|                    |             |                  | stimulus          | lifecycle                           |
|                    |             |                  | detected on       | events,                             |
|                    |             |                  | a VNFM            | include:                            |
|                    |             |                  | reference         | "EVENT_START_INSTANTIATION",        |
|                    |             |                  | point.            | "EVENT_END_INSTANTIATION",          |
|                    |             |                  |                   | "EVENT_START_SCALING",              |
|                    |             |                  | NOTE: At          | "EVENT_END_SCALING",                |
|                    |             |                  | least one         | "EVENT_START_SCALING_TO_LEVEL",     |
|                    |             |                  | of these          | "EVENT_END_SCALING_TO_LEVEL",       |
|                    |             |                  | two               | "EVENT_START_HEALING",              |
|                    |             |                  | attributes        | "EVENT_END_HEALING",                |
|                    |             |                  | shall be          | "EVENT_START_TERMINATION",          |
|                    |             |                  | included.         | "EVENT_END_TERMINATION",            |
|                    |             |                  |                   | "EVENT_START_VNF_FLAVOR_CHANGE",    |
|                    |             |                  |                   | "EVENT_END_VNF_FLAVOR_CHANGE",      |
|                    |             |                  |                   | "EVENT_START_VNF_OPERATION_CHANGE", |
|                    |             |                  |                   | "EVENT_END_VNF_OPERATION_CHANGE",   |
|                    |             |                  |                   | "EVENT_START_VNF_EXT_CONN_CHANGE",  |
|                    |             |                  |                   | "EVENT_END_VNF_EXT_CONN_CHANGE",    |
|                    |             |                  |                   | "EVENT_START_VNFINFO_MODIFICATION", |
|                    |             |                  |                   | "EVENT_END_VNFINFO_MODIFICATION";   |
|                    |             |                  |                   | for                                 |
|                    |             |                  |                   | external                            |
|                    |             |                  |                   | stimulus,                           |
|                    |             |                  |                   | include:                            |
|                    |             |                  |                   | receipt of                          |
|                    |             |                  |                   | request                             |
|                    |             |                  |                   | message of                          |
|                    |             |                  |                   | instantiation,                      |
|                    |             |                  |                   | scaling,                            |
|                    |             |                  |                   | healing,                            |
|                    |             |                  |                   | termination,                        |
|                    |             |                  |                   | change of                           |
|                    |             |                  |                   | VNF                                 |
|                    |             |                  |                   | flavour,                            |
|                    |             |                  |                   | change of                           |
|                    |             |                  |                   | the                                 |
|                    |             |                  |                   | operation                           |
|                    |             |                  |                   | state of                            |
|                    |             |                  |                   | the VNF,                            |
|                    |             |                  |                   | change of                           |
|                    |             |                  |                   | external                            |
|                    |             |                  |                   | VNF                                 |
|                    |             |                  |                   | connectivity,                       |
|                    |             |                  |                   | modification                        |
|                    |             |                  |                   | of VNF                              |
|                    |             |                  |                   | information                         |
|                    |             |                  |                   | or the                              |
|                    |             |                  |                   | receipt of                          |
|                    |             |                  |                   | a                                   |
|                    |             |                  |                   | notification                        |
|                    |             |                  |                   | regarding                           |
|                    |             |                  |                   | the change                          |
|                    |             |                  |                   | of a VNF                            |
|                    |             |                  |                   | indicator                           |
|                    |             |                  |                   | value.                              |
+--------------------+-------------+------------------+-------------------+-------------------------------------+
| lcmTransitionEvent | String      | 0..N             | Describes         | support:                            |
|                    |             |                  | the               | MANDATORY                           |
|                    |             |                  | transition        |                                     |
|                    |             |                  | VNF               |                                     |
|                    |             |                  | lifecycle         |                                     |
|                    |             |                  | event(s)          |                                     |
|                    |             |                  | that cannot       |                                     |
|                    |             |                  | be mapped         |                                     |
|                    |             |                  | to any of         |                                     |
|                    |             |                  | the               |                                     |
|                    |             |                  | enumerated        |                                     |
|                    |             |                  | values            |                                     |
|                    |             |                  | defined for       |                                     |
|                    |             |                  | the event         |                                     |
|                    |             |                  | attribute.        |                                     |
|                    |             |                  |                   |                                     |
|                    |             |                  | NOTE: At          |                                     |
|                    |             |                  | least one         |                                     |
|                    |             |                  | of these          |                                     |
|                    |             |                  | two               |                                     |
|                    |             |                  | attributes        |                                     |
|                    |             |                  | shall be          |                                     |
|                    |             |                  | included.         |                                     |
+--------------------+-------------+------------------+-------------------+-------------------------------------+
| script             | String      | 1                | Information       | support:                            |
|                    |             |                  | to locate a       | MANDATORY                           |
|                    |             |                  | VNF LCM           |                                     |
|                    |             |                  | script            |                                     |
|                    |             |                  | (e.g.             |                                     |
|                    |             |                  | written in        |                                     |
|                    |             |                  | a DSL as          |                                     |
|                    |             |                  | specified         |                                     |
|                    |             |                  | in                |                                     |
|                    |             |                  | requirement       |                                     |
|                    |             |                  | VNF_PACK.LCM.001) |                                     |
|                    |             |                  | triggered         |                                     |
|                    |             |                  | to react to       |                                     |
|                    |             |                  | one of the        |                                     |
|                    |             |                  | events            |                                     |
|                    |             |                  | listed in         |                                     |
|                    |             |                  | the event         |                                     |
|                    |             |                  | attribute.        |                                     |
+--------------------+-------------+------------------+-------------------+-------------------------------------+
| scriptDsl          | String      | 1                | Defines the       | support:                            |
|                    |             |                  | domain            | MANDATORY                           |
|                    |             |                  | specific          |                                     |
|                    |             |                  | language          |                                     |
|                    |             |                  | (i.e. the         |                                     |
|                    |             |                  | type) of          |                                     |
|                    |             |                  | script that       |                                     |
|                    |             |                  | is                |                                     |
|                    |             |                  | provided.         |                                     |
|                    |             |                  | Types of          |                                     |
|                    |             |                  | scripts           |                                     |
|                    |             |                  | could             |                                     |
|                    |             |                  | include           |                                     |
|                    |             |                  | bash,             |                                     |
|                    |             |                  | python,           |                                     |
|                    |             |                  | etc.              |                                     |
+--------------------+-------------+------------------+-------------------+-------------------------------------+
| scriptInput        | KeyValuePair| 0..N             | Array of          | support:                            |
|                    |             |                  | KVP               | MANDATORY                           |
|                    |             |                  | 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.           |                                     |
+--------------------+-------------+------------------+-------------------+-------------------------------------+