summaryrefslogtreecommitdiffstats
path: root/docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst
diff options
context:
space:
mode:
authorweinstock, alan <aw2574@att.com>2018-11-21 22:53:17 +0000
committerweinstock, alan <aw2574@att.com>2018-11-26 20:56:05 +0000
commitedec0990d48d668b7b542f17f9ed7bdbc22b48f5 (patch)
tree393a92756a3e5348d89eec3cb9f702c1f5bdc39c /docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst
parent4b07020149224cae7d8815def6b7a8753206ba2c (diff)
[VNFRQTS] requirements for flat directories
Change-Id: Ie354adbc6c9a9a27df1a1aa2b534336633071723 Issue-ID: VNFRQTS-495 Signed-off-by: weinstock, alan <aw2574@att.com>
Diffstat (limited to 'docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst')
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Orchestration Templates Overview.rst38
1 files changed, 38 insertions, 0 deletions
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.
+