NSLifecycleManagement_def.yaml 15.8 KB
Newer Older
1
# Copyright (c) ETSI 2017.
2
3
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
4
  HealNsRequest:
5
    description: >
6
7
8
9
      This operation supports the healing of an NS instance, 
      either by healing the complete NS instance or by healing one of
      more of the VNF instances that are part of this NS. 
      It shall comply with the provisions defined in Table 6.5.2.13-1.
10
11
    type: object
    properties:
12
      healNsData:
13
        description: >
14
15
16
          Indicates the reason why a healing procedure is required.
        $ref: "#/definitions/HealNsData"
      healVnfData:
17
        description: >
18
19
20
          Additional parameters passed by the NFVO as input to the healing
          process, specific to the VNF being healed, as declared in the VNFD
          as part of "HealVnfOpConfig".        
21
22
        type: array
        items:
23
          $ref: "#/definitions/HealVnfData"
24

25
  NsLcmOpOcc:
26
    description: >
27
28
      This type represents a request a NS lifecycle operation occurrence. 
      It shall comply with the provisions defined in Table 6.5.2.3-1.
29
30
31
    type: object
    required:
      - id
32
33
34
35
      - operationState
      - stateEnteredTime
      - nsInstanceId
      - lcmOperationType
36
      - startTime
37
38
39
      - isAutomaticInvocation
      - operationParams
      - isCancelPending
40
      - _links
41
42
43
    properties:
      id:
        description: >
44
          Identifier of this NS lifecycle operation occurrence.
45
        $ref: "SOL005_def.yaml#/definitions/Identifier"
46
      operationState:
47
        description: >
48
49
50
          The state of the NS LCM operation.
        $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOperationStateType"
      stateEnteredTime:
51
        description: >
52
          Date-time when the current state was entered.
53
        type: string
54
55
        format: date-time
      nsInstanceId:
56
        description: >
57
          Identifier of the NS instance to which the operation applies.
58
        $ref: "SOL005_def.yaml#/definitions/Identifier"
59
      lcmOperationType:
60
        description: >
61
62
          Type of the actual LCM operation represented by this
          lcm operation occurrence.
63
        $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpType"
64
      startTime:
65
        description: >
66
          Date-time of the start of the operation.
67
        type: string
68
69
        format: date-time
      isAutomaticInvocation:
70
        description: >
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
          Set to true if this NS LCM operation occurrence has
          been automatically triggered by the NFVO. This occurs
          in the case of auto-scaling, auto-healing and when a
          nested NS is modified as a result of an operation on its
          composite NS. Set to false otherwise.
        type: boolean
      operationParams:
        description: >
          Input parameters of the LCM operation. This attribute
          shall be formatted according to the request data type of
          the related LCM operation.
          The following mapping between lcmOperationType and
          the data type of this attribute shall apply:
          - INSTANTIATE: InstantiateNsRequest
          - SCALE: ScaleNsRequest
          - UPDATE: UpdateNsRequest
          - HEAL: HealNsRequest
          - TERMINATE: TerminateNsRequest
89
90
91
92
93
94
        type: string
        enum:
          - INSTANTIATE
          - SCALE
          - UPDATE
          - HEAL
95
          - TERMINATE
96
      isCancelPending:
97
        description: >
98
99
100
101
102
103
          If the LCM operation occurrence is in "PROCESSING"
          or "ROLLING_BACK" state and the operation is being
          cancelled, this attribute shall be set to true. Otherwise, it
          shall be set to false.
        type: boolean
      cancelMode:
104
        description: >
105
106
107
108
109
110
111
112
113
114
          The mode of an ongoing cancellation. Shall be present
          when isCancelPending=true, and shall be absent otherwise.
        $ref: "#/definitions/CancelModeType"
      error:
        description: >
          If "operationState" is "FAILED_TEMP" or "FAILED" or "operationState"
          is "PROCESSING" or "ROLLING_BACK" and previous value of
          "operationState" was "FAILED_TEMP", this attribute shall be present
          and contain error information, unless it has been requested to be
          excluded via an attribute selector.
115
        $ref: "#/definitions/ProblemDetails"
116
      resourceChanges:
117
        description: >
118
119
120
          This attribute contains information about the cumulative
          changes to virtualised resources that were performed so
          far by the LCM operation since its start, if applicable
121
122
        type: object
        properties:
123
          affectedVnfs:
124
            description: >
125
126
              Information about the VNF instances that were affected
              during the lifecycle operation, if this notification
127
              represents the result of a lifecycle operation.
128
129
            type: array
            items:
130
131
              $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedVnf"
          affectedPnfs:
132
            description: >
133
134
135
              Information about the PNF instances that were affected
              during the lifecycle operation, if this notification
              represents the result of a lifecycle operation.
136
137
            type: array
            items:
138
139
              $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedPnf"
          affectedVls:
140
            description: >
141
142
143
              Information about the VL instances that were affected
              during the lifecycle operation, if this notification
              represents the result of a lifecycle operation.
144
145
            type: array
            items:
146
147
              $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedVl"
          affectedVnffgs:
148
            description: >
149
150
151
              Information about the VNFFG instances that were
              affected during the lifecycle operation, if this notification              
              represents the result of a lifecycle operation. See note
152
153
            type: array
            items:
154
155
              $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedVnffg"
          affectedNss:
156
            description: >
157
158
159
              Information about the nested NS instances that were
              affected during the lifecycle operation, if this notification
              represents the result of a lifecycle operation. See note.
160
161
            type: array
            items:
162
163
              $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedNs"
          affectedSaps:
164
            description: >
165
166
167
              Information about the nested NS instances that were
              affected during the lifecycle operation, if this notification
              represents the result of a lifecycle operation. See note.
168
169
            type: array
            items:
170
171
172
173
174
              $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedSap"
      _links:
        description: >
          Links to resources related to this resource.
        type: object
175
176
        required:
          - self
177
          - nsInstance
178
179
        properties:
          self:
180
            description: >
181
182
183
              URI of this resource.
            $ref: "SOL005_def.yaml#/definitions/Link"
          nsInstance:
184
            description: >
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
              Link to the NS instance that the operation applies to.
            $ref: "SOL005_def.yaml#/definitions/Link"
          cancel:
            description: >
              Link to the task resource that represents the "cancel"
              operation for this LCM operation occurrence, if
              cancelling is currently allowed.
            $ref: "SOL005_def.yaml#/definitions/Link"
          retry:
            description: >
              Link to the task resource that represents the "cancel"
              operation for this LCM operation occurrence, 
              if cancelling is currently allowed.
            $ref: "SOL005_def.yaml#/definitions/Link"
          rollback:
            description: >
201
202
203
              Link to the task resource that represents the "rollback"
              operation for this LCM operation occurrence, if rolling
              back is currently allowed.
204
205
206
207
208
209
210
211
212
213
214
215
216
217
            $ref: "SOL005_def.yaml#/definitions/Link"
          continue:
            description: >
              Link to the task resource that represents the "continue"
              operation for this LCM operation occurrence, if rolling
              back is currently allowed.
            $ref: "SOL005_def.yaml#/definitions/Link"
          fail:
            description: >
              Link to the task resource that represents the "fail"
              operation for this LCM operation occurrence, if rolling
              back is currently allowed.
            $ref: "SOL005_def.yaml#/definitions/Link"
  CancelMode:
218
    description: >
219
220
      This type represents a parameter to select the mode of canceling an ongoing NS LCM operation occurrence. 
      It shall comply with the provisions defined in Table 6.5.2.16-1..
221
    type: object
222
    required:
223
224
225
      - cancelMode
    properties:
      cancelMode:
226
        description: >
227
228
          Cancellation mode to apply.
        $ref: "#/definitions/CancelModeType"
229

230
  CancelModeType:
231
    description: >
232
      Cancellation mode.
233

234
235
236
237
238
      The NFVO shall not start any new VNF lifecycle management and resource
      management operation, and shall wait for the ongoing VNF lifecycle management
      and resource management operations in the underlying system, typically the VNFM
      and VIM, to finish execution or to time out. After that, the NFVO shall put the
      operation occurrence into the FAILED_TEMP state.
239

240
241
242
243
244
      The NFVO shall not start any new VNF lifecycle management and resource
      management operation, shall cancel the ongoing VNF lifecycle management and
      resource management operations in the underlying system, typically the VNFM and
      VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO
      shall put the operation occurrence into the FAILED_TEMP state.
245
246
    type: string
    enum:
247
248
      - GRACEFUL
      - FORCEFUL
249

250
  HealNsData:
251
    description: >
252
253
      This type represents the information used to heal a NS. 
      It shall comply with the provisions defined in Table 6.5.3.43-1.
254
    type: object
255
256
    required:
      - degreeHealing
257
    properties:
258
      degreeHealing:
259
        description: >
260
261
262
263
264
265
266
267
268
269
          Indicates the degree of healing. Possible values
          include:
          - HEAL_RESTORE: Complete the healing of
          the NS restoring the state of the NS before
          the failure occurred
          - HEAL_QOS: Complete the healing of the NS
          based on the newest QoS values
          - HEAL_RESET: Complete the healing of the
          NS resetting to the original instantiation state of the NS
          - PARTIAL_HEALING
270
        type: string
271
        enum:
272
273
          - HEAL_RESTORE
          - HEAL_QOS
274
275
          - HEAL_RESET
          - PARTIAL_HEALING
276
277
278
279
280
281
282
      actionsHealing:
        description: >
          Used to specify dedicated healing actions in a
          particular order (e.g. as a script). The actionsHealing
          attribute can be used to provide a specific script whose
          content and actions might only be possible to be
          derived during runtime.
283
        type: array
284
285
286
        items:
          $ref: "SOL005_def.yaml#/definitions/String"
      healScript:
287
        description: >
288
289
290
291
292
          Reference to a script from the NSD that shall be used
          to execute dedicated healing actions in a particular
          order. The healScript, since it refers to a script in the
          NSD, can be used to execute healing actions which
          are defined during NS design time.
293
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
294
      additionalParamsforNs:
295
        description: >
296
297
298
          Allows the OSS/BSS to provide additional
          parameter(s) to the healing process at the NS level.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
299

300
  HealVnfData:
301
    description: >
302
303
304
305
      This type represents the information to heal a VNF that is part of an NS. 
      The NFVO shall then invoke the HealVNF
      operation towards the appropriate VNFM. 
      It shall comply with the provisions defined in Table 6.5.3.44-1.
306
    type: object
307
308
    required:
      - vnfInstanceId
309
310
311
    properties:
      vnfInstanceId:
        description: >
312
313
          Identifies the VNF instance, part of the NS, requiring a
          healing action.
314
        $ref: "SOL005_def.yaml#/definitions/Identifier"
315
      cause:
316
        description: >
317
          Indicates the reason why a healing procedure is required.
318
        type: string
319
      additionalParams:
320
        description: >
321
322
323
324
          Additional parameters passed by the NFVO as input to
          the healing process, specific to the VNF being healed.
          EXAMPLE: Input parameters to VNF-specific healing procedures.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
325

326
  TerminateNsRequest:
327
    description: >
328
329
      This type represents a NS termination request. 
      It shall comply with the provisions defined in Table 6.5.2.15-1.
330
331
    type: object
    properties:
332
      terminationTime:
333
        description: >
334
335
336
          Timestamp indicating the end time of the NS, i.e. the NS
          will be terminated automatically at this timestamp.
          Cardinality "0" indicates the NS termination takes place immediately
337
        $ref: "SOL005_def.yaml#/definitions/DateTime"
338

339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
  ProblemDetails:
    description: >
      The definition of the general "ProblemDetails" data structure from
      IETF RFC 7807 [19] is reproduced inthis structure. Compared to the
      general framework defined in IETF RFC 7807 [19], the "status" and
      "detail" attributes are mandated to be included by the present document,
      to ensure that the response contains additional textual information about
      an error. IETF RFC 7807 [19] foresees extensibility of the
      "ProblemDetails" type. It is possible that particular APIs in the present
      document, or particular implementations, define extensions to define
      additional attributes that provide more information about the error.
      The description column only provides some explanation of the meaning to
      Facilitate understanding of the design. For a full description, see
      IETF RFC 7807 [19].
    type: object
    required:
      - status
      - detail
    properties:
      type:
        description: >
          A URI reference according to IETF RFC 3986 [5] that identifies the
          problem type. It is encouraged that the URI provides human-readable
          documentation for the problem (e.g. using HTML) when dereferenced.
          When this member is not present, its value is assumed to be
          "about:blank".
        type: string
        format: URI
      title:
        description: >
          A short, human-readable summary of the problem type. It should not
          change from occurrence to occurrence of the problem, except for
          purposes of localization. If type is given and other than
          "about:blank", this attribute shall also be provided.
          A short, human-readable summary of the problem
          type.  It SHOULD NOT change from occurrence to occurrence of the
          problem, except for purposes of localization (e.g., using
          proactive content negotiation; see [RFC7231], Section 3.4).
        type: string
      status:
        description: >
          The HTTP status code for this occurrence of the problem.
          The HTTP status code ([RFC7231], Section 6) generated by the origin
          server for this occurrence of the problem.
        type: integer
      detail:
        description: >
          A human-readable explanation specific to this occurrence of the
          problem.
        type: string
      instance:
        description: >
          A URI reference that identifies the specific occurrence of the
          problem. It may yield further information if dereferenced.
        type: string
        format: URI