summaryrefslogtreecommitdiffstats
path: root/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst
blob: f6c4541cee7a5738c228683a248a032ddd468417 (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
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
.. 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 Template Format:

ONAP Heat Orchestration Template Format
------------------------------------------------
As stated above, Heat Orchestration templates must be defined in YAML.

.. req::
    :id: R-92635
    :keyword: MUST
    :validation_mode: static

    A VNF's Heat Orchestration Template **MUST** be compliant with the
    OpenStack Template Guide.

The OpenStack Template Guide is defined at
https://docs.openstack.org/heat/latest/template_guide/index.html#top.

Heat Orchestration Template Structure
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Heat Orchestration template structure follows the following format, as
defined by OpenStack at
https://docs.openstack.org/developer/heat/template_guide/hot_spec.html.

.. code-block:: yaml

  heat_template_version: <date>

  description:
    # a description of the template

  parameter_groups:
    # a declaration of input parameter groups and order

  parameters:
    # declaration of input parameters

  resources:
    # declaration of template resources

  outputs:
    # declaration of output parameters

  conditions:
    # declaration of conditions


heat_template_version
~~~~~~~~~~~~~~~~~~~~~~~


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

    A VNF's Heat Orchestration template **MUST** contain the
    section ``heat_template_version:``.

The section ``heat_template_version:`` must be set to a date that
is supported by the OpenStack environment.

description
~~~~~~~~~~~~


.. req::
    :id: R-39402
    :keyword: MUST
    :validation_mode: static

    A VNF's Heat Orchestration Template **MUST** contain the
    section ``description:``.

parameter_groups
~~~~~~~~~~~~~~~~~~~~~~

A VNF Heat Orchestration template may
contain the section "parameter_groups:".

parameters
~~~~~~~~~~~~~~~~~~~~~~

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

    A VNF Heat Orchestration's template **MUST** contain the
    section ``parameters:``.


.. code-block:: yaml

  parameters:

    <param name>:

      type: <string | number | json | comma_delimited_list | boolean>

      label: <human-readable name of the parameter>

      description: <description of the parameter>

      default: <default value for parameter>

      hidden: <true | false>

      constraints:

        <parameter constraints>

      immutable: <true | false>

This section allows for
specifying input parameters that have to be provided when instantiating
the template. Each parameter is specified in a separate nested block
with the name of the parameters defined in the first line and additional
attributes (e.g., type, label) defined as nested elements.


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

    A VNF Heat Orchestration's template's parameter **MUST** be used
    in a resource with the exception of the parameters for the
    ``OS::Nova::Server`` resource property ``availability_zone``.

.. req::
    :id: R-91273
    :target: VNF
    :keyword: MAY NOT

    A VNF Heat Orchestration's template's parameter for the
    ``OS::Nova::Server`` resource property ``availability_zone``
    **MAY NOT** be used in any ``OS::Nova::Server``.

That is, the parameter associated with the property ``availability_zone``
maybe declared but not used in a resource.

<param name>
+++++++++++++

The name of the parameter.


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

    A VNF's Heat Orchestration Template's parameter name
    (i.e., <param name>) **MUST** contain only alphanumeric
    characters and underscores ('_').

type
++++


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

    A VNF's Heat Orchestration Template's parameter **MUST** include the
    attribute ``type:``.

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

    A VNF's Heat Orchestration Template's parameter type **MUST** be one of
    the following values:

    * ``string``
    * ``number``
    * ``json``
    * ``comma_delimited_list``
    * ``boolean``

label
++++++


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

    A VNF's Heat Orchestration Template parameter declaration **MAY**
    contain the attribute ``label:``.

description
+++++++++++++


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

    A VNF's Heat Orchestration Template parameter declaration **MUST**
    contain the attribute ``description``.

Note that the parameter attribute ``description:`` is an OpenStack optional
attribute that provides a description of the parameter.
ONAP implementation requires this attribute.

default
++++++++


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

    A VNF Heat Orchestration Template parameter declaration **MUST NOT**
    contain the ``default`` attribute.

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

    If a VNF Heat Orchestration Template parameter has a default value,
    it **MUST** be enumerated in the environment file.

Note that the parameter attribute ``default:`` is an OpenStack optional
attribute that declares the default value of the parameter.
ONAP implementation prohibits the use of this attribute.

hidden
+++++++


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

    A VNF's Heat Orchestration Template parameter declaration **MAY**
    contain the attribute ``hidden:``.

The parameter attribute ``hidden:`` is an OpenStack optional attribute that
defines whether the parameters should be hidden when a user requests
information about a stack created from the template.
This attribute can be used to hide passwords specified as parameters.

constraints
++++++++++++

The parameter attribute ``constraints:`` is an OpenStack optional attribute
that defines a list of constraints to apply to the parameter.


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

    A VNF's Heat Orchestration Template's parameter defined
    in a non-nested YAML file as type
    ``number`` **MUST** have a parameter constraint of ``range`` or
    ``allowed_values`` defined.

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

    A VNF's Heat Orchestration Template's parameter defined
    in a non-nested YAML file as type
    ``string`` **MAY** have a parameter constraint defined.

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

    A VNF's Heat Orchestration Template's parameter defined
    in a non-nested YAML file as type
    ``json`` **MAY** have a parameter constraint defined.

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

    A VNF's Heat Orchestration Template's parameter defined
    in a non-nested YAML file as
    type ``comma_delimited_list`` **MAY** have a parameter constraint defined.

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

    A VNF's Heat Orchestration Template's parameter defined
    in a non-nested YAML file as type
    ``boolean`` **MAY** have a parameter constraint defined.

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

    A VNF's Heat Orchestration Template's parameter defined
    in a nested YAML file
    **MUST NOT** have a parameter constraint defined.

The constraints block of a parameter definition defines additional
validation constraints that apply to the value of the parameter.
The parameter values provided in the VNF Heat Orchestration Template are
validated against the constraints at instantiation time.
The stack creation fails if the parameter value doesn't comply to
the constraints.

The constraints are defined as a list with the following syntax

.. code-block:: yaml

  constraints:

    <constraint type>: <constraint definition>

    description: <constraint description>

..

**<constraint type>** Provides the type of constraint to apply.
The list of OpenStack supported constraints can be found at
https://docs.openstack.org/heat/latest/template_guide/hot_spec.html .

**<constraint definition>** provides the actual constraint.
The syntax and constraint is dependent of the <constraint type> used.

**description:** is an optional attribute that provides a description of
the constraint. The text is presented to the user when the value the user
defines violates the constraint. If omitted, a default validation message is
presented to the user.



Below is a brief overview of the ``range`` and ``allowed values`` constraints.
For complete details on constraints, see
https://docs.openstack.org/heat/latest/template_guide/hot_spec.html#parameter-constraints


**range**

``range``: The ``range`` constraint applies to parameters of ``type: number``.
It defines a lower and upper limit for the numeric value of the parameter.
The syntax of the ``range`` constraint is

.. code-block:: yaml

    range: { min: <lower limit>, max: <upper limit> }

..

It is possible to define a range constraint with only a lower limit or an
upper limit.

**allowed_values**

``allowed_values``: The ``allowed_values`` constraint applies to parameters of
type ``string`` or type ``number``. It specifies a set of possible values
for a parameter. At deployment time, the user-provided value for the
respective parameter must match one of the elements of the list.
The syntax of the ``allowed_values`` constraint is

.. code-block:: yaml

    allowed_values: [ <value>, <value>, ... ]

    Alternatively, the following YAML list notation can be used

    allowed_values:

    - <value>

    - <value>

    - ...

immutable
++++++++++++


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

    A VNF's Heat Orchestration Template parameter declaration
    **MAY** contain the attribute ``immutable:``.

The parameter attribute ``immutable`` is an OpenStack optional attribute
that defines whether the parameter is updatable. A Heat Orchestration Template
stack update fails if ``immutable`` is set to ``true`` and the parameter value is
changed.  This attribute ``immutable`` defaults to ``false``.

.. _resources:

resources
~~~~~~~~~~~~


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

    A VNF's Heat Orchestration template **MUST**
    contain the section ``resources:``.

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

    A VNF's Heat Orchestration Template's
    ``resources:`` section **MUST** contain the declaration of at
    least one resource.

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

    A VNF's Heat Orchestration Template's Nested YAML files **MAY**
    (or **MAY NOT**) contain the section ``resources:``.

Each resource is defined as a
separate block in the resources section with the following syntax.

.. code-block:: yaml

  resources:

    <resource ID>:

      type: <resource type>

      properties:

        <property name>: <property value>

      metadata:

        <resource specific metadata>

      depends_on: <resource ID or list of ID>

      update_policy: <update policy>

      deletion_policy: <deletion policy>

      external_id: <external resource ID>

      condition: <condition name or expression or boolean>



resource ID
+++++++++++++


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

    A VNF's Heat Orchestration Template's resource name
    (i.e., <resource ID>) **MUST** only contain alphanumeric
    characters and underscores ('_').

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

    A VNF's <resource ID> **MUST** be unique across all Heat
    Orchestration Templates and all HEAT Orchestration Template
    Nested YAML files that are used to create the VNF.

Note that a VNF can be composed of one or more Heat Orchestration Templates.

Note that OpenStack requires the <resource ID> to be unique to the
Heat Orchestration Template and not unique across all Heat
Orchestration Templates the compose the VNF.

type
+++++

The resource attribute ``type`` is an OpenStack required attribute that
defines the resource type, such as ``OS::Nova::Server`` or ``OS::Neutron::Port``.

The resource attribute ``type`` may specify a VNF HEAT
Orchestration Template Nested YAML file.


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

    A VNF's Heat Orchestration Template's Resource
    **MUST NOT** reference a HTTP-based resource definitions.

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

    A VNF's Heat Orchestration Template's Resource
    **MUST NOT** reference a HTTP-based Nested YAML file.

properties
+++++++++++++

The resource attribute ``properties`` is an OpenStack optional attribute that
provides a list of resource-specific properties. The property value can
be provided in place, or via a function
(e.g., `Intrinsic functions <https://docs.openstack.org/developer/heat/template_guide/hot_spec.html#hot-spec-intrinsic-functions>`__).


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

    If a VNF's Heat Orchestration Template resource attribute
    ``property:`` uses a nested ``get_param``, the nested
    ``get_param`` **MUST** reference an index.

metadata
++++++++++

The resource attribute ``metadata`` is an OpenStack optional attribute.


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

    A VNF's Heat Orchestration Template's Resource **MAY** declare the
    attribute ``metadata``.


depends_on
+++++++++++

The resource attribute ``depends_on`` is an OpenStack optional attribute.
See `Section <https://docs.openstack.org/developer/heat/template_guide/hot_spec.html#hot-spec-resources-dependencies>`__ 9.7 for additional details.


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

    VNF's Heat Orchestration Template's Resource **MAY** declare the
    attribute ``depends_on:``.

update_policy
++++++++++++++


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

    VNF's Heat Orchestration Template's Resource **MAY** declare the
    attribute ``update_policy:``.

deletion_policy
+++++++++++++++++++


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

    VNF's Heat Orchestration Template's Resource **MAY** declare the
    attribute ``deletion_policy:``.

If specified, the ``deletion_policy`` attribute for resources allows
values ``Delete``, ``Retain``, and ``Snapshot``.
Starting with heat_template_version 2016-10-14,
lowercase equivalents are also allowed.

The default policy is to delete the physical resource when
deleting a resource from the stack.

external_id
++++++++++++


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

    VNF's Heat Orchestration Template's Resource **MAY** declare the
    attribute ``external_id:``.

This attribute allows for specifying the resource_id for an existing external
(to the stack) resource. External resources cannot depend on other resources,
but we allow other resources to depend on external resource. This attribute
is optional. Note: when this is specified, properties will not be used for
building the resource and the resource is not managed by Heat. This is not
possible to update that attribute. Also, resource won't be deleted by
heat when stack is deleted.


condition
+++++++++++

The resource attribute ``condition`` is an OpenStack optional attribute.

outputs
~~~~~~~~~


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

    A VNF's Heat Orchestration template **MAY** contain the ``outputs:``
    section.

This section allows for specifying output parameters
available to users once the template has been instantiated. If the
section is specified, it will need to adhere to specific requirements.
See :ref:`Output Parameters` and
:ref:`ONAP Output Parameter Names` for additional details.

Environment File Format
^^^^^^^^^^^^^^^^^^^^^^^^^^

A VNF's Heat Orchestration Template's environment file is a yaml text file.
(https://docs.openstack.org/developer/heat/template_guide/environment.html)


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

    A VNF's Heat Orchestration template **MUST** have a
    corresponding environment file.

The use of an environment file in OpenStack is optional. In ONAP, it is
mandatory. A Heat Orchestration Template uploaded to ONAP must have a
corresponding environment file, even if no parameters are enumerated in
the mandatory parameter section.


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

    A VNF's Heat Orchestration template's Environment File **MUST**
    contain the ``parameters:`` section.

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

    A VNF's Heat Orchestration template's Environment File's
    ``parameters:`` section **MAY** (or **MAY NOT**) enumerate parameters.

ONAP implementation requires the parameters section in the environmental
file to be declared.  The parameters section contains a list of key/value
pairs.


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

    A VNF's Heat Orchestration template's Environment File's
    **MAY** contain the ``parameter_defaults:`` section.

The ``parameter_defaults:`` section contains default parameters that are
passed to all template resources.


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

    A VNF's Heat Orchestration template's Environment File's
    **MAY** contain the ``encrypted_parameters:`` section.

The ``encrypted_parameters:`` section contains a list of encrypted parameters.


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

    A VNF's Heat Orchestration template's Environment File's
    **MAY** contain the ``event_sinks:`` section.

The ``event_sinks:`` section contains the list of endpoints that would receive
stack events.


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

    A VNF's Heat Orchestration template's Environment File's
    **MAY** contain the ``parameter_merge_strategies:`` section.

The ``parameter_merge_strategies:`` section provides the merge strategies for
merging parameters and parameter defaults from the environment file.


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

    A VNF's Heat Orchestration template's Environment File's
    **MUST NOT** contain the ``resource_registry:`` section.

ONAP implementation does not support the Environment File resource_registry
section.  The resource_registry section allows for the definition of custom
resources.

SDC Treatment of Environment Files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Parameter values enumerated in the environment file are used by SDC as
the default value. However, the SDC user may use the SDC GUI to
overwrite the default values in the environment file.

SDC generates a new environment file for distribution to MSO based on
the uploaded environment file and the user provided GUI updates. The
user uploaded environment file is discarded when the new file is
created.

ONAP has requirements for what parameters must be enumerated in the
environment file and what parameter must not be enumerated in the
environment file. See :ref:`Output Parameters` and
:ref:`ONAP Heat Resource ID and Parameter Naming Convention` for more details.