docs/Chapter5/Heat/General Guidelines for Heat.rst

   1 .. Licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
   4
   5 .. _General Guidelines for Heat:
   6
   7 General Guidelines for Heat
   8 ----------------------------
   9
  10 This section contains general Heat Orchestration Template guidelines
  11 and requirements.
  12
  13 Heat Template Compliance
  14 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  15
  16 The Heat Orchestration Template requirements with RFC 2119
  17 keywords **MUST** and **MUST NOT** can be validated against a set of Heat
  18 Templates via the VNF Validation Program (VVP).
  19
  20 **NOTE**: Not all requirements are currently testable via VVP.
  21
  22 The VVP *validation scripts* project contains python validation
  23 scripts that will parse Heat Orchestration Templates in a given directory
  24 to ensure that they comply with ONAP Heat Orchestration Template requirements.
  25
  26 For instructions on how to use the VVP validation scripts,
  27 please see the validation scripts
  28 `README <https://github.com/onap/vvp-validation-scripts>`__
  29
  30
  31 YAML Format
  32 ^^^^^^^^^^^^^^
  33
  34 .. req::
  35     :id: R-95303
  36     :target: VNF
  37     :keyword: MUST
  38
  39     A VNF's Heat Orchestration Template **MUST** be defined using valid YAML.
  40
  41 YAML (YAML Ain't
  42 Markup Language) is a human friendly data serialization standard for all
  43 programming languages. See http://www.yaml.org/.