summaryrefslogtreecommitdiffstats
path: root/requirements/resource_management/05-impl.rst
blob: 7bbaa0c2a52b143065dc2cb811c58cb337450965 (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
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
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
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
Detailed architecture and message flows
=======================================

Detailed northbound interface specification
-------------------------------------------

.. Note::
   Once the output of the work from ETSI NFV IFA has been made publicly
   available, the UML diagrams and REST/JSON examples in this section will be
   extended

Resource Capacity Management
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Subscribe Capacity Change Event
_______________________________

**SubscribeRequest (Consumer -> VIM)**

.. uml::

   @startuml
   class SubscribeRequest {
      + zone [0..N]: Identifier
      + attributes [0..1]: String
      + resourceItems [0..1]: String
      + thresholds [0..N]: String
      + notificationId [0..1]: Identifier
   }
   @enduml

Subscription from Consumer to VIM to be notified about capacity changes.
Input Parameters:

* Zone [0..N]: Identification of the zone(s) to notify regarding capacity
  change events
* Attributes [0..1]: Attributes of resource items to be notified regarding
  capacity change events
* ResourceItems [0..1]: Identifiers of existing resource items to be notified
  regarding capacity change events (such as images, flavors, virtual
  containers, networks, physical machines, etc.)
* Thresholds [0..N]: Lower/Upper limits for triggering change event for
  used/reserved/total capacity change for specified resource items
* NotificationId [0..1]: Identification of existing capacity change event
  notification issued by the VIM. When specified. The previously defined
  conditions for change event notifications wil be re-used and notification
  sent to the additional requestor.

Application/json::

  {
    "zone": ["opnfv-JP8", "opnfv-JP9"],
    "resourceitems": "numvcinstances"
  }

**SubscribeReply (VIM -> Consumer)**

.. uml::

   @startuml
   class SubscribeReply {
      + subscriptionId [1]: Identifier
      + created [1]: DateTime
      + message [0..1]: String
   }
   @enduml

Reply Parameters:

* subscriptionId (Identifier): Identification of the capacity change event
  notification issued by the VIM.
* created (DateTime): Timestamp when subscription has been created
* m	essage [0..1] (String): Output message that provides additional information
  about the subscribe request

Application/json::

  {
    "created": "2015-03-23T00:00:01Z",
    "notificationId": "abcdef-ghijkl-123456789"
  }

Query Resource Capacity
_______________________

**QueryRequest (NFVO -> VIM)**

.. uml::

   @startuml
   class QueryCapacityRequest {
      + capacityQueryFilter [0..1]: CapacityQueryFilterClass
   }

   class CapacityQueryFilter {
      + zone [0..1]: Identifier
      + resourceItems [0..1]: String
      + flavorID [0..1]: Identifier
      + timePeriod [0..1]: DateTime
   }

   QueryCapacityRequest "1" *- "0..1" CapacityQueryFilter : ""
   @enduml

.. -*

Request to find out about used, reserved and total capacity.
A CapacityQueryFilter can be used to narrow down the capacity details returned
in the response message.

Input Parameters:

* capacityQueryFilter (CapacityQueryFilterClass): Optional information to
  narrow down the QueryCapacityRequest, for example to limit the query to given
  resource items, or a given resource zone. The capacityQueryFilter can also
  include a FlavorId or template ID. In this case, the QueryCapacity is a
  request to obtain information of the number of virtual resources that can be
  instantiated according to this flavor with the actual available capacity.
  A timePeriod can be specified to narrow down the query to a certain period of time.

Application/json::

  {
    "capacityqueryfilter": {
      "resourceitems": "numvcinstances,virtualmemorysize",
      "zone": "opnfv-JP7"
    }
  }

**QueryReply (VIM -> NFVO)**

.. uml::

   @startuml
   class QueryCapacityReply {
      + capacityInformation [0..N]: CapacityInformationClass
      + zone [0..1]: Identifier
      + lastUpdate [0..1]: DateTime
      + message [0..1]: String
   }

   QueryCapacityReply "1" *- "0..N" CapacityInformationClass : ""
   @enduml

.. -*

Reply Parameters:

* capacityInformation [0..N] (CapacityInformationClass): Capacity information
  matching the CapacityQueryFilter specified in the QueryCapacityRequest
* Zone [0..1] (Identifier): Identification of the resource zone
* lastUpdate [0..1] (DateTime): Timestamp of the capacity last update
* message [0..1] (String): Output message that provides additional information
  about the query capacity request

Application/json::

  {
    "capacityInformation": {
      "numvcinstances": {
        "used": 5,
        "reserved": 1,
        "total": 10
      },
      "virtualmemorysize": {
        "used": 4,
        "reserved": 6,
        "total": 16
      }
    },
    "zone":"opnfv-JP7",
    "lastUpdate":"2015-03-23T00:00:00Z"
  }

Notify Capacity Change Event
____________________________

**CapacityChangeNotification (VIM -> Consumer)**

.. uml::

   @startuml
   class CapacityChangeNotification {
      + capacityInformation [0..1]: CapacityInformationClass
      + zone [0..1]: Identifier
      + notificationTime [1]: DateTime
      + notificationId [1]: Identifier
   }

   CapacityChangeNotification "1" *- "0..1" CapacityInformationClass : ""
   @enduml

.. -*

Notification about capacity changes

Notify Parameters:

* capacityInformation [0..1] (CapacityInformationClass): Capacity information
  matching a given subscription request defined by the Consumer
* zone [0..1] (Identifier): Identification of the resource zone
* notificationTime [1] (DateTime): Timestamp when the capacity change is
  detected
* notificationId [1]: Identification of the capacity change event notification
  issued by the VIM.

Application/json::

  {
    "capacity": {
      "numvcinstances": {
        "used": 16,
        "reserved": 2,
        "total": 20
      }
    },
    "zone": "opnfv-JP8",
    "notificationTime":"2015-03-23T12:00:05Z",
    "notificationId":"abcdef-ghijkl-123456789"
  }

Resource Reservation
^^^^^^^^^^^^^^^^^^^^

Create Resource Reservation
___________________________

**CreateResourceReservationRequest (NFVO -> VIM)**

.. uml::

   @startuml
   class CreateResourceReservationRequest {
      + start [0..1]: DateTime
      + end [0..1]: DateTime
      + expiry [0..1]: DateTime
      + virtualizationContainerReservation [0..N]: VirtualizationContainerReservationClass
      + computePoolReservation [0..1]: ComputePoolReservationClass
      + storagePoolReservation [0..1]: StoragePoolReservationClass
      + networkReservation [0..1]: NetworkReservationClass
      + zone [0..1]: Identifier
   }

   class VirtualizationContainerReservationClass {
      + containerId [1]: Identifier
      + flavor [0..1]: FlavorClass
   }

   CreateResourceReservationRequest "1" *- "0..N" VirtualizationContainerReservationClass : ""
   VirtualizationContainerReservationClass "1" *-- "0..1" FlavorClass
   CreateResourceReservationRequest "1" *-- "0..1" ComputePoolReservationClass
   CreateResourceReservationRequest "1" *-- "0..1" StoragePoolReservationClass
   CreateResourceReservationRequest "1" *-- "0..1" NetworkReservationClass
   @enduml

.. -*

**CreateResourceReservationReply (VIM -> NFVO)**

.. uml::

   @startuml
   class CreateResourceReservationReply {
      + reservationId [1]: Identifier
      + virtualizationContainerReserved [0..N]: VirtualizationContainerReservedClass
      + computePoolReserved [0..1]: ComputePoolReservedClass
      + storagePoolReserved [0..1]: StoragePoolReservedClass
      + networkReserved [0..1]: NetworkReservedClass
      + reservationStatus [1]: String
      + startTime [0..1]: Time
      + endTime [0..1]: Time
      + message [0..1]: String
   }

   class VirtualizationContainerReservedClass {
      + containerId [1]: Identifier
      + flavor [0..1]: FlavorClass
   }

   CreateResourceReservationReply "1" *- "0..N" VirtualizationContainerReservedClass : ""
   VirtualizationContainerReservedClass "1" *-- "0..1" FlavorClass
   CreateResourceReservationReply "1" *-- "0..1" ComputePoolReservedClass
   CreateResourceReservationReply "1" *-- "0..1" StoragePoolReservedClass
   CreateResourceReservationReply "1" *-- "0..1" NetworkReservedClass
   @enduml

.. -*

Subscribe / Notify Reservation Event
____________________________________

**SubscribeRequest (Consumer -> VIM)**

.. uml::

   @startuml
   class SubscribeRequest {
      + reservationId [1]: Identifier
      + eventType [0..1]: String
   }
   @enduml

**SubscribeReply (VIM -> Consumer)**

.. uml::

   @startuml
   class SubscribeReply {
      + notificationId [1]: Identifier
      + created [1]: DateTime
      + message [0..1]: String
   }
   @enduml

**NotifyReservationEvent (VIM -> Consumer)**

.. uml::

   @startuml
   class ReservationEventNotification {
      + notificationId [1]: Identifier
      + reservationId [1]: Identifier
      + notificationTime [1]: DateTime
      + vimId [1]: Identifier
      + eventType [1]: String
      + eventDetails [1]: String
      + message [0..1]: String
   }
   @enduml

Query Resource Reservation
__________________________

**QueryResourceReservationRequest (Consumer -> VIM)**

.. uml::

   @startuml
   class QueryResourceReservationRequest {
      + reservationQueryFilter [0..1]: ReservationQueryFilterClass
   }

   QueryResourceReservationRequest "1" *- "0..1" ReservationQueryFilterClass : ""
   @enduml

.. -*

**QueryResourceReservationReply (VIM -> Consumer)**

.. uml::

   @startuml
   class CreateResourceReservationReply {
      + reservationId [1]: Identifier
      + virtualizationContainerReserved [0..N]: VirtualizationContainerReservedClass
      + computePoolReserved [0..1]: ComputePoolReservedClass
      + storagePoolReserved [0..1]: StoragePoolReservedClass
      + networkReserved [0..1]: NetworkReservedClass
      + reservationStatus [1]: String
      + message [0..1]: String
   }

   class VirtualizationContainerReservedClass {
      + containerId [1]: Identifier
      + flavor [0..1]: FlavorClass
   }

   CreateResourceReservationReply "1" *- "0..N" VirtualizationContainerReservedClass : ""
   VirtualizationContainerReservedClass "1" *-- "0..1" FlavorClass
   CreateResourceReservationReply "1" *-- "0..1" ComputePoolReservedClass
   CreateResourceReservationReply "1" *-- "0..1" StoragePoolReservedClass
   CreateResourceReservationReply "1" *-- "0..1" NetworkReservedClass
   @enduml

.. -*

Update Resource Reservation
___________________________

**UpdateResourceReservationRequest (NFVO ->VIM)**

.. uml::

   @startuml
   class UpdateResourceReservationRequest {
      + reservationId [1]: Identifier
      + start [0..1]: DateTime
      + end [0..1]: DateTime
      + expiry [0..1]: DateTime
      + virtualizationContainerReservation [0..N]: VirtualizationContainerReservationClass
      + computePoolReservation [0..1]: ComputePoolReservationClass
      + storagePoolReservation [0..1]: StoragePoolReservationClass
      + networkReservation [0..1]: NetworkReservationClass
      + zone [0..1]: Identifier
   }

   class VirtualizationContainerReservationClass {
      + containerId [1]: Identifier
      + flavor [0..1]: FlavorClass
   }

   UpdateResourceReservationRequest "1" *- "0..N" VirtualizationContainerReservationClass : ""
   VirtualizationContainerReservationClass "1" *-- "0..1" FlavorClass
   UpdateResourceReservationRequest "1" *-- "0..1" ComputePoolReservationClass
   UpdateResourceReservationRequest "1" *-- "0..1" StoragePoolReservationClass
   UpdateResourceReservationRequest "1" *-- "0..1" NetworkReservationClass
   @enduml

.. -*

**UpdateResourceReservationReply (VIM -> NFVO)**

.. uml::

   @startuml
   class UpdateResourceReservationReply {
      + reservationId [1]: Identifier
      + virtualizationContainerReserved [0..N]: VirtualizationContainerReservedClass
      + computePoolReserved [0..1]: ComputePoolReservedClass
      + storagePoolReserved [0..1]: StoragePoolReservedClass
      + networkReserved [0..1]: NetworkReservedClass
      + reservationStatus [1]: String
      + message [0..1]: String
   }

   class VirtualizationContainerReservedClass {
      + containerId [1]: Identifier
      + flavor [0..1]: FlavorClass
   }

   UpdateResourceReservationReply "1" *- "0..N" VirtualizationContainerReservedClass : ""
   VirtualizationContainerReservedClass "1" *-- "0..1" FlavorClass
   UpdateResourceReservationReply "1" *-- "0..1" ComputePoolReservedClass
   UpdateResourceReservationReply "1" *-- "0..1" StoragePoolReservedClass
   UpdateResourceReservationReply "1" *-- "0..1" NetworkReservedClass
   @enduml

.. -*

Release Resource Reservation
____________________________

**ReleaseResourceReservationRequest (NFVO -> VIM)**

.. uml::

   @startuml
   class ReleaseResourceReservationRequest {
      + reservationId [1]: Identifier
   }
   @enduml

**ReleaseResourceReservationReply (VIM -> NFVO)**

.. uml::

   @startuml
   class ReleaseResourceReservationReply {
      + reservationId [1]: Identifier
      + message [0..1]: String
   }
   @enduml


Detailed Message Flows
----------------------

Resource Capacity Management
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. figure:: images/figure5.png
   :width: 90%

   Capacity Management Scenario

Figure 5 shows a detailed message flow between the consumers and the
functionalblocks inside the VIM and has the following steps:

Step 1: The consumer subscribes to capacity change notifications

Step 2: The Capacity Manager monitors the capacity information for the various
types of resources by querying the various Controllers (e.g. Nova, Neutron,
Cinder), either periodically or on demand and updates capacity information in
the Capacity Map

Step 3: Capacity changes are notified to the consumer

Step 4: The consumer queries the Capacity Manager to retrieve capacity detailed
information

Resource Reservation
^^^^^^^^^^^^^^^^^^^^

.. figure:: images/figure6.png
   :width: 90%

   Resource Reservation for Future Use Scenario

Figure 6 shows a detailed message flow between the consumers and the functional
blocks inside the VIM and has the following steps:

Step 1: The consumer creates a resource reservation request for future use by
setting a start and end time for the allocation

Step 2: The consumer gets an immediate reply with a reservation status message
"reservationStatus" and an identifier to be used with this reservation instance
"reservationID"

Step 3: The consumer subscribes to reservation notification events

Step 4: The Resource Reservation Manager checks the feasibility of the
reservation request by consulting the Capacity Manager

Step 5: The Resource Reservation Manager reserves the resources and stores the
list of reservations IDs generated by the Controllers (e.g. Nova, Neutron,
Cinder) in the Reservation Map

Step 6: Once the reservation process is completed, the VIM sends a notification
message to the consumer with information on the reserved resources

Step 7: When start time arrives, the consumer creates a resource allocation
request.

Step 8: The consumer gets an immediate reply with an allocation status message
"allocationStatus".

Step 9: The consumer subscribes to allocation notification events

Step 10: The Resource Allocation Manager allocates the reserved resources. If
not all reserved resources are allocated before expiry, the reserved resources
are released and a notification is sent to the consumer

Step 11: Once the allocation process is completed, the VIM sends a notification
message to the consumer with information on the allocated resources