docs/Chapter5/Heat/ONAP Heat Support of Environment Files.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 .. _ONAP Heat Support of Environment Files:
   6
   7 ONAP Heat Support of Environment Files
   8 -----------------------------------------
   9
  10 The use of an environment file in OpenStack is optional.  In ONAP, it is
  11 mandatory. A Heat Orchestration Template uploaded to ONAP must have a
  12 corresponding environment file, even if no parameters are required to
  13 be enumerated.
  14
  15 *(Note that ONAP does not programmatically enforce the use of
  16 an environment file.)*
  17
  18 As stated in :need:`R-38474`, :need:`R-81725`, and :need:`R-53433`:
  19
  20
  21   * A VNF's Base Module **MUST** have a corresponding Environment File.
  22   * A VNF's Incremental Module **MUST** have a corresponding Environment File.
  23   * A VNF's Cinder Volume Module **MUST** have a corresponding environment
  24     File.
  25
  26 A nested heat template must not have an environment file; OpenStack does
  27 not support it.
  28
  29 The environment file must contain parameter values for the ONAP
  30 Orchestration Constants and VNF Orchestration Constants. These
  31 parameters are identical across all instances of a VNF type, and
  32 expected to change infrequently. The ONAP Orchestration Constants are
  33 associated with OS::Nova::Server image and flavor properties (See
  34 :ref:`Property image` and :ref:`Property flavor`). Examples of VNF
  35 Orchestration Constants are the networking parameters associated
  36 with an internal network (e.g., private IP ranges) and Cinder
  37 volume sizes.
  38
  39 The environment file must not contain parameter values for parameters
  40 that are instance specific (ONAP Orchestration Parameters, VNF
  41 Orchestration Parameters). These parameters are supplied to the Heat by
  42 ONAP at orchestration time.
  43
  44 SDC Treatment of Environment Files
  45 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  46
  47 Parameter values enumerated in the environment file are used by SDC as
  48 the default value. However, the SDC user may use the SDC GUI to
  49 overwrite the default values in the environment file.
  50
  51 SDC generates a new environment file for distribution to SO based on
  52 the uploaded environment file and the user provided GUI updates. The
  53 user uploaded environment file is discarded when the new file is
  54 created. Note that if the user did not change any values via GUI
  55 updates, the SDC generated environment file will contain the same values
  56 as the uploaded file.
  57
  58 Use of Environment Files when using OpenStack "heat stack-create" CLI
  59 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  60
  61 When ONAP is instantiating the Heat Orchestration Template, certain
  62 parameter must not be enumerated in the environment file. This document
  63 provides the details of what parameters should not be enumerated.
  64
  65 If the Heat Orchestration Template is to be instantiated from the
  66 OpenStack Command Line Interface (CLI) using the command "heat
  67 stack-create", all parameters must be enumerated in the environment
  68 file.
  69