diff options
Diffstat (limited to 'docs/Chapter5/Heat')
4 files changed, 46 insertions, 110 deletions
diff --git a/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst b/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst index edc3b34..a97827c 100644 --- a/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst +++ b/docs/Chapter5/Heat/ONAP Heat Orchestration Template Format.rst @@ -786,20 +786,3 @@ 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. - diff --git a/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst b/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst index acc9ef3..e770732 100644 --- a/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst +++ b/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst @@ -575,3 +575,41 @@ Orchestration Template at orchestration time. 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. + diff --git a/docs/Chapter5/Heat/ONAP Heat Support of Environment Files.rst b/docs/Chapter5/Heat/ONAP Heat Support of Environment Files.rst index 35286f0..e8117ad 100644 --- a/docs/Chapter5/Heat/ONAP Heat Support of Environment Files.rst +++ b/docs/Chapter5/Heat/ONAP Heat Support of Environment Files.rst @@ -7,63 +7,4 @@ ONAP Heat Support of Environment Files ----------------------------------------- -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 required to -be enumerated. - -*(Note that ONAP does not programmatically enforce the use of -an environment file.)* - -As stated in :need:`R-38474`, :need:`R-81725`, and :need:`R-53433`: - - - * A VNF's Base Module **MUST** have a corresponding Environment File. - * A VNF's Incremental Module **MUST** have a corresponding Environment File. - * A VNF's Cinder Volume Module **MUST** have a corresponding environment - File. - -A nested heat template must not have an environment file; OpenStack does -not support it. - -The environment file must contain parameter values for the ONAP -Orchestration Constants and VNF Orchestration Constants. These -parameters are identical across all instances of a VNF type, and -expected to change infrequently. The ONAP Orchestration Constants are -associated with OS::Nova::Server image and flavor properties (See -:ref:`Property image` and :ref:`Property flavor`). Examples of VNF -Orchestration Constants are the networking parameters associated -with an internal network (e.g., private IP ranges) and Cinder -volume sizes. - -The environment file must not contain parameter values for parameters -that are instance specific (ONAP Orchestration Parameters, VNF -Orchestration Parameters). These parameters are supplied to the Heat by -ONAP at orchestration time. - -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 SO 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. Note that if the user did not change any values via GUI -updates, the SDC generated environment file will contain the same values -as the uploaded file. - -Use of Environment Files when using OpenStack "heat stack-create" CLI -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -When ONAP is instantiating the Heat Orchestration Template, certain -parameter must not be enumerated in the environment file. This document -provides the details of what parameters should not be enumerated. - -If the Heat Orchestration Template is to be instantiated from the -OpenStack Command Line Interface (CLI) using the command "heat -stack-create", all parameters must be enumerated in the environment -file. - +<section deleted> diff --git a/docs/Chapter5/Heat/ONAP Heat Template Constructs.rst b/docs/Chapter5/Heat/ONAP Heat Template Constructs.rst index 2627c7c..c7703c0 100644 --- a/docs/Chapter5/Heat/ONAP Heat Template Constructs.rst +++ b/docs/Chapter5/Heat/ONAP Heat Template Constructs.rst @@ -79,16 +79,6 @@ As stated in requirement :need:`R-99646`, 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. -.. req:: - :id: R-52530 - :target: VNF - :keyword: MUST - :validation_mode: static - :updated: casablanca - - A VNF's Heat Orchestration Template's Nested YAML file - **MUST** be in the same directory hierarchy as the VNF's Heat - Orchestration Templates. .. req:: :id: R-90022 @@ -624,13 +614,12 @@ unique name. Heat Files Support (get_file) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Heat Templates may contain the inclusion of text files into Heat -templates via the Heat get_file directive. This may be used, for -example, to define a common "user-data" script, or to inject files into -a VM on startup via the "personality" property. - -Support for Heat Files is subject to the following limitations: +A VNF's Heat Orchestration Template may contain the inclusion of text files +containing scripts or configuration files. The ``get_file`` intrinsic +function returns the content of a file into a Heat Orchestration Template. +The support for the ``get_file`` intrinsic function in ECOMP is subject to the +following limitations: .. req:: :id: R-76718 @@ -643,9 +632,9 @@ Support for Heat Files is subject to the following limitations: ``get_file``, the ``get_file`` target **MUST** be referenced in the Heat Orchestration Template by file name. -The ``get_file`` target files are on-boarded to SDC in the same package +The ``get_file`` target files are on-boarded to SDC in the same zip file that contains the VNF's complete Heat Orchestration Template. - +See requirement R-511776. .. req:: :id: R-41888 @@ -657,21 +646,6 @@ that contains the VNF's complete Heat Orchestration Template. A VNF's Heat Orchestration Template intrinsic function ``get_file`` **MUST NOT** utilize URL-based file retrieval. -.. req:: - :id: R-87848 - :target: VNF - :keyword: MUST - :validation_mode: static - :updated: casablanca - - When using the intrinsic function get_file, ONAP does not support - a directory hierarchy for included files. All files must be in a - single, flat directory per VNF. A VNF's Heat Orchestration - Template's ``get_file`` target files **MUST** be in the same - directory hierarchy as the VNF's Heat Orchestration Templates. - -ONAP does not support a hierarchical structure. A VNF's YAML files -must be in a single, flat directory. .. req:: :id: R-05050 |