summaryrefslogtreecommitdiffstats
path: root/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst
blob: e77073296c1a0c9bcf9ccaa0d64d3d3d95d0529d (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
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
.. Licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property.  All rights reserved.

.. _ONAP Heat Orchestration Templates Overview:

ONAP Heat Orchestration Templates Overview
-----------------------------------------------

ONAP supports a modular Heat Orchestration Template design pattern,
referred to as *VNF Modularity.*

.. _heat_onap_vnf_modularity_overview:

ONAP VNF Modularity Overview
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


.. req::
    :id: R-69663
    :target: VNF
    :keyword: MAY

    A VNF **MAY** be composed from one or more Heat Orchestration
    Templates, each of which represents a subset of the overall VNF.

The Heat Orchestration Templates can be thought of a components or modules of
the VNF and are referred to as *VNF Modules*. During orchestration,
these modules are
deployed incrementally to create the complete VNF.


.. req::
    :id: R-33132
    :target: VNF
    :keyword: MAY
    :updated: casablanca

    A VNF's Heat Orchestration Template **MAY** be
     1.) Base Module Heat Orchestration Template (also referred to as a
         Base Module),
     2.) Incremental Module Heat Orchestration Template (referred to as
         an Incremental Module), or
     3.) a Cinder Volume Module Heat Orchestration Template (referred to as
         Cinder Volume  Module).

.. req::
    :id: R-37028
    :target: VNF
    :keyword: MUST
    :updated: casablanca

    A VNF **MUST** be composed of one Base Module

.. req::
    :id: R-13196
    :target: VNF
    :keyword: MAY

    A VNF **MAY** be composed of zero to many Incremental Modules.

.. req::
    :id: R-20974
    :target: VNF
    :keyword: MUST
    :updated: casablanca

    At orchestration time, the VNF's Base Module **MUST**
    be deployed first, prior to any incremental modules.

.. req::
    :id: R-28980
    :target: VNF
    :keyword: MAY

    A VNF's incremental module **MAY** be used for initial VNF deployment only.

.. req::
    :id: R-86926
    :target: VNF
    :keyword: MAY

    A VNF's incremental module **MAY** be used for scale out only.

A VNF's Incremental Module that is used for scale out is deployed sometime
after initial VNF deployment to add capacity.


.. req::
    :id: R-91497
    :target: VNF
    :keyword: MAY

    A VNF's incremental module **MAY** be used for both deployment and
    scale out.

.. req::
    :id: R-68122
    :target: VNF
    :keyword: MAY

    A VNF's incremental module **MAY** be deployed more than once,
    either during initial VNF deployment and/or scale out.

.. req::
    :id: R-46119
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume
    **MAY** be defined in a Base Module.

.. req::
    :id: R-90748
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume
    **MAY** be defined in an Incremental Module.

.. req::
    :id: R-03251
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume
    **MAY** be defined in a Cinder Volume Module.

ONAP also supports the concept of an optional, independently deployed Cinder
volume via a separate Heat Orchestration Templates, referred to as a Cinder
Volume Module. This allows the volume to persist after a Virtual Machine
(VM) (i.e., OS::Nova::Server) is deleted, allowing the volume to be reused
on another instance (e.g., during a failover activity).

.. req::
    :id: R-11200
    :target: VNF
    :keyword: MUST
    :validation_mode: static
    :updated: casablanca

    A VNF's Cinder Volume Module, when it exists, **MUST** be 1:1
    with a Base module or Incremental module.

It is strongly recommended that Cinder Volumes be created in a Cinder Volume
Module.

.. req::
    :id: R-38474
    :target: VNF
    :keyword: MUST
    :validation_mode: static
    :updated: casablanca

    A VNF's Base Module **MUST** have a corresponding Environment File.

.. req::
    :id: R-81725
    :target: VNF
    :keyword: MUST
    :validation_mode: static
    :updated: casablanca

    A VNF's Incremental Module **MUST** have a corresponding Environment File

.. req::
    :id: R-53433
    :target: VNF
    :keyword: MUST
    :validation_mode: static
    :updated: casablanca

    A VNF's Cinder Volume Module **MUST** have a corresponding environment file

These concepts will be described in more detail throughout the document.
This overview is provided to set the stage and help clarify the concepts
that will be introduced.

Nested Heat Orchestration Templates Overview
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ONAP supports nested Heat Orchestration Templates per OpenStack
specifications.


.. req::
    :id: R-36582
    :target: VNF
    :keyword: MAY

    A VNF's Base Module **MAY** utilize nested heat.

.. req::
    :id: R-56721
    :target: VNF
    :keyword: MAY

    A VNF's Incremental Module **MAY** utilize nested heat.

.. req::
    :id: R-30395
    :target: VNF
    :keyword: MAY

    A VNF's Cinder Volume Module **MAY** utilize nested heat.

Nested templates may be suitable for larger VNFs that contain many
repeated instances of the same VM type(s). A common usage pattern is to
create a nested template for each VM type along with its supporting
resources. The Heat Orchestration Template may then reference these
nested templates either statically (by repeated definition) or
dynamically (via OS::Heat::ResourceGroup).

See :ref:`Nested Heat Templates` for additional details.

ONAP Heat Orchestration Template Filenames
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In order to enable ONAP to understand the relationship between Heat
files, the following Heat file naming convention must be utilized.

In the examples below, <text> represents any alphanumeric string that
must not contain any special characters and must not contain the word
"base".


.. req::
    :id: R-87485
    :target: VNF
    :keyword: MUST
    :validation_mode: static

    A VNF's Heat Orchestration Template's file extension **MUST**
    be in the lower case format ``.yaml`` or ``.yml``.

.. req::
    :id: R-56438
    :target: VNF
    :keyword: MUST
    :validation_mode: static

    A VNF's Heat Orchestration Template's Nested YAML file extension **MUST**
    be in the lower case format ``.yaml`` or ``.yml``.

.. req::
    :id: R-74304
    :target: VNF
    :keyword: MUST
    :validation_mode: static

    A VNF's Heat Orchestration Template's Environment file extension **MUST**
    be in the lower case format ``.env``.

.. req::
    :id: R-99646
    :target: VNF
    :keyword: MUST
    :validation_mode: static

    A VNF's YAML files (i.e, Heat Orchestration Template files and
    Nested files) **MUST** have a unique name in the scope of the VNF.

Base Modules
~~~~~~~~~~~~


.. req::
    :id: R-81339
    :target: VNF
    :keyword: MUST
    :validation_mode: static
    :updated: casablanca

    A VNF Heat Orchestration Template's Base Module file name **MUST** include
    case insensitive 'base' in the filename and
    **MUST** match one of the following four
    formats:

     1.) ``base_<text>.y[a]ml``

     2.) ``<text>_base.y[a]ml``

     3.) ``base.y[a]ml``

     4.) ``<text>_base_<text>``.y[a]ml

    where ``<text>`` **MUST** contain only alphanumeric characters and
    underscores '_' and **MUST NOT** contain the case insensitive word ``base``.

.. req::
    :id: R-91342
    :target: VNF
    :keyword: MUST
    :validation_mode: static

    A VNF Heat Orchestration Template's Base Module's Environment File
    **MUST** be named identical to the VNF Heat Orchestration Template's
    Base Module with ``.y[a]ml`` replaced with ``.env``.

Incremental Modules
~~~~~~~~~~~~~~~~~~~


.. req::
    :id: R-87247
    :target: VNF
    :keyword: MUST
    :validation_mode: static
    :updated: casablanca

    VNF Heat Orchestration Template's Incremental Module file name
    **MUST** contain only alphanumeric characters and underscores
    '_' and **MUST NOT** contain the case insensitive word ``base``.

.. req::
    :id: R-94509
    :target: VNF
    :keyword: MUST
    :validation_mode: static

    A VNF Heat Orchestration Template's Incremental Module's Environment File
    **MUST** be named identical to the VNF Heat Orchestration Template's
    Incremental Module with ``.y[a]ml`` replaced with ``.env``.

To clearly identify the incremental module, it is recommended to use the
following naming options for modules:

 -  ``module_<text>.y[a]ml``

 -  ``<text>_module.y[a]ml``

 -  ``module.y[a]ml``

 -  ``<text>_module_<text>.y[a]ml``

Cinder Volume Modules
~~~~~~~~~~~~~~~~~~~~~


.. req::
    :id: R-82732
    :target: VNF
    :keyword: MUST
    :validation_mode: static
    :updated: casablanca

    A VNF Heat Orchestration Template's Cinder Volume Module **MUST**
    be named identical to the base or incremental module it is supporting with
    ``_volume`` appended.

.. req::
    :id: R-31141
    :target: VNF
    :keyword: MUST
    :validation_mode: static
    :updated: casablanca

    VNF Heat Orchestration Template's Cinder Volume Module's Environment File
    **MUST** be named identical to the VNF Heat Orchestration Template's
    Cinder Volume Module with ``.y[a]ml`` replaced with ``.env``.

Nested Heat file
~~~~~~~~~~~~~~~~


.. req::
    :id: R-76057
    :target: VNF
    :keyword: MUST
    :validation_mode: static
    :updated: casablanca

    VNF Heat Orchestration Template's Nested YAML file name **MUST** contain
    only alphanumeric characters and underscores '_' and
    **MUST NOT** contain the case insensitive word ``base``.

.. req::
    :id: R-70276
    :target: VNF
    :keyword: MUST NOT
    :validation_mode: static

    A VNF HEAT's Orchestration Nested Template's YAML file name **MUST NOT**
    be in the format ``{vm-type}.y[a]ml`` where ``{vm-type}`` is defined
    in the Heat Orchestration Template.

Examples include

 -  ``<text>.y[a]ml``

 -  ``nest_<text>.y[a]ml``

 -  ``<text>_nest.y[a]ml``

 -  ``nest.y[a]ml``

 -  ``<text>_nest_<text>.y[a]ml``

VNF Heat Orchestration Template's Nested YAML file does not have a
corresponding environment files, per OpenStack specifications.

.. _Output Parameters:

Output Parameters
^^^^^^^^^^^^^^^^^^^^^^

The output parameters are parameters defined in the output section of a
Heat Orchestration Template. The ONAP output parameters are subdivided
into three categories:

1. ONAP Base Module Output Parameters

2. ONAP Volume Module Output Parameters

3. ONAP Predefined Output Parameters.

ONAP Base Module Output Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

ONAP Base Module Output Parameters are declared in the ``outputs:`` section
of the VNF's Heat Orchestration Template's Base Module. A Base Module Output
Parameter is available as an input parameter (i.e., declared in
the ``parameters:`` section) to all Incremental Modules in the VNF.

A Base Module Output Parameter may be used as an input parameter in any
incremental module in the VNF.  Note that the parameter is not available to
other VNFs.


.. req::
    :id: R-52753
    :target: VNF
    :keyword: MUST
    :validation_mode: static

    VNF's Heat Orchestration Template's Base Module's output parameter's
    name and type **MUST** match the VNF's Heat Orchestration Template's
    incremental Module's name and type unless the output parameter is of
    type ``comma_delimited_list``, then the corresponding input parameter
    **MUST** be declared as type ``json``.

If the Output parameter has a comma_delimited_list value (e.g., a collection
of UUIDs from a Resource Group), then the corresponding input parameter must
be declared as type ``json`` and not a ``comma_delimited_list``,
which is actually a string value with embedded commas.


.. req::
    :id: R-22608
    :target: VNF
    :keyword: MUST NOT
    :validation_mode: static

    When a VNF's Heat Orchestration Template's Base Module's output
    parameter is declared as an input parameter in an Incremental Module,
    the parameter attribute ``constraints:`` **MUST NOT** be declared.

Additional details on ONAP Base Module Output Parameters are provided in
:ref:`ONAP Output Parameter Names` and ONAP VNF Modularity.

ONAP Volume Module Output Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. req::
    :id: R-89913
    :target: VNF
    :keyword: MUST
    :validation_mode: static
    :updated: casablanca

    A VNF's Heat Orchestration Template's Cinder Volume Module Output
    Parameter(s)
    **MUST** include the
    UUID(s) of the Cinder Volumes created in template,
    while others **MAY** be included.

A VNF's Heat Orchestration Template's Cinder Volume Module Output Parameter(s)
are only available for the module (base or incremental) that the volume
template is associated with.


.. req::
    :id: R-07443
    :target: VNF
    :keyword: MUST
    :validation_mode: static
    :updated: casablanca

    A VNF's Heat Orchestration Templates' Cinder Volume Module Output
    Parameter's name and type **MUST** match the input parameter name and type
    in the corresponding Base Module or Incremental Module unless the Output
    Parameter is of the type ``comma_delimited_list``, then the corresponding
    input parameter **MUST** be declared as type ``json``.

If the Output parameter has a comma_delimited_list value (e.g., a collection
of UUIDs from a Resource Group), then the corresponding input parameter must
be declared as type json and not a comma_delimited_list, which is actually
a string value with embedded commas.


.. req::
    :id: R-20547
    :target: VNF
    :keyword: MUST NOT
    :validation_mode: static

    When an ONAP Volume Module Output Parameter is declared as an input
    parameter in a base or an incremental module Heat Orchestration
    Template, parameter constraints **MUST NOT** be declared.

Additional details on ONAP Base Module Output Parameters are provided in
:ref:`ONAP Output Parameter Names` and :ref:`ONAP Heat Cinder Volumes`.

ONAP Predefined Output Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

ONAP will look for a small set of pre-defined Heat output parameters to
capture resource attributes for inventory in ONAP. These output parameters
are optional and currently only two parameters are supported. These output
parameters are optional and are specified in
:ref:`OAM Management IP Addresses`.

Support of heat stack update
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ONAP does not support the use of heat stack-update command for scaling
(growth/de-growth).


.. req::
    :id: R-39349
    :target: VNF
    :keyword: MUST NOT
    :validation_mode: static

    A VNF Heat Orchestration Template **MUST NOT** be designed to utilize the
    OpenStack ``heat stack-update`` command for scaling (growth/de-growth).

.. req::
    :id: R-43413
    :target: VNF
    :keyword: MUST
    :validation_mode: static

    A VNF **MUST** utilize a modular Heat Orchestration Template design to
    support scaling (growth/de-growth).

It is important to note that ONAP only supports heat stack-update for
image upgrades.

Scope of a Heat Orchestration Template
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


.. req::
    :id: R-59482
    :target: VNF
    :keyword: MUST NOT
    :validation_mode: static

    A VNF's Heat Orchestration Template **MUST NOT** be VNF instance
    specific or cloud site specific.

ONAP provides the instance specific parameter values to the Heat
Orchestration Template at orchestration time.


.. req::
    :id: R-01896
    :target: VNF
    :keyword: MUST
    :validation_mode: static

    A VNF's Heat Orchestration Template's parameter values that are constant
    across all deployments **MUST** be declared in a Heat Orchestration
    Template Environment File.

ONAP VNF On-Boarding
^^^^^^^^^^^^^^^^^^^^

.. req::
    :id: R-511776
    :keyword: MUST

    When a VNF's Heat Orchestration Template is ready
    to be on-boarded to ONAP,
    all files composing the VNF Heat Orchestration Template
    **MUST** be placed in a flat (i.e., non-hierarchical) directory and
    archived using ZIP.  The resulting ZIP file is uploaded into ONAP.

The VNF's Heat Orchestration Template's ZIP file must include
the base module YAML file (R-37028) and corresponding environment file
(R-38474).  

The VNF's Heat Orchestration Template's ZIP file **MAY** include

* One or more incremental module YAML files (R-13196) and corresponding
  environment files (R-81725).
* One or more volume module YAML files (R-03251) and corresponding 
  environment files (R-53433). 
* One or more nested YAML files (R-36582, R-56721, R-30395).
* One or more files that are retrieved via the intrinsic function
  ``get_file``.  The ``get_file`` function returns the content of a file
  into a Heat Orchestration Template. It is generally used as a file
  inclusion mechanism for files containing scripts or configuration files.
  (See Section 9.3)

.. req::
    :id: R-348813
    :keyword: MUST

    The VNF's Heat Orchestration Template's ZIP file **MUST NOT** include
    a binary image file.