summaryrefslogtreecommitdiffstats
path: root/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst
diff options
context:
space:
mode:
authorBozawglanian, Hagop (hb755d) <hb755d@att.com>2018-09-04 21:44:28 +0000
committerBozawglanian, Hagop (hb755d) <hb755d@att.com>2018-09-04 21:44:28 +0000
commitc4e85b64d93f7bb4cdcf13cbc65f2256e5bb7a33 (patch)
treebe3abe0eb6ea4407da81dcb3917dbf1d8f35e77a /docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst
parent7b7ff003d1133f68bdd17812112e5a5abc47a7f6 (diff)
VNFRQTS - Breaking up Chapter 5 - Heat
Breaking up the Heat section to make it more granular. Issue-ID: VNFRQTS-275 Change-Id: I020469d7aea199cd71c4d7c67664ad4dbc4071c9 Signed-off-by: Bozawglanian, Hagop (hb755d) <hb755d@att.com>
Diffstat (limited to 'docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst')
-rw-r--r--docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst94
1 files changed, 94 insertions, 0 deletions
diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst
new file mode 100644
index 0000000..ac0d603
--- /dev/null
+++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}.rst
@@ -0,0 +1,94 @@
+.. 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.
+
+{network-role}
+-----------------------------
+
+The assignment of a {network-role} is discussed in
+:ref:`ONAP Heat Networking`.
+
+.. req::
+ :id: R-21330
+ :target: VNF
+ :keyword: MUST
+
+ A VNF's Heat Orchestration Template's Resource property
+ parameter that is associated with external network **MUST**
+ include the '{network-role}' as part of the parameter name.
+
+.. req::
+ :id: R-11168
+ :target: VNF
+ :keyword: MUST
+
+ A VNF's Heat Orchestration Template's Resource ID that is
+ associated with an external network **MUST** include the
+ '{network-role}' as part of the resource ID.
+
+.. req::
+ :id: R-84322
+ :target: VNF
+ :keyword: MUST
+
+ A VNF's Heat Orchestration Template's Resource property
+ parameter that is associated with an internal network
+ **MUST** include 'int\_{network-role}' as part of the parameter
+ name, where 'int\_' is a hard coded string.
+
+.. req::
+ :id: R-96983
+ :target: VNF
+ :keyword: MUST
+
+ A VNF's Heat Orchestration Template's Resource ID that is
+ associated with an internal network **MUST** include
+ 'int\_{network-role}' as part of the Resource ID, where
+ 'int\_' is a hard coded string.
+
+.. req::
+ :id: R-26506
+ :target: VNF
+ :keyword: MUST
+
+ A VNF's Heat Orchestration Template's '{network-role}'
+ **MUST** contain only alphanumeric characters and/or
+ underscores '_' and **MUST NOT** contain any of the following
+ strings: '_int' or 'int\_' or '\_int\_'.
+
+.. req::
+ :id: R-00977
+ :target: VNF
+ :keyword: MUST NOT
+
+ A VNF's Heat Orchestration Template's '{network-role}'
+ **MUST NOT** be a substring of '{vm-type}'.
+
+For example, if a VNF has a '{vm-type}' of 'oam' and a
+'{network-role}' of 'oam\_protected' would be a violation of the requirement.
+
+
+.. req::
+ :id: R-58424
+ :target: VNF
+ :keyword: MUST
+
+ A VNF's Heat Orchestration Template's use of '{network-role}'
+ in all Resource property parameter names **MUST** be the same case.
+
+.. req::
+ :id: R-21511
+ :target: VNF
+ :keyword: MUST
+
+ A VNF's Heat Orchestration Template's use of '{network-role}'
+ in all Resource IDs **MUST** be the same case.
+
+.. req::
+ :id: R-86588
+ :target: VNF
+ :keyword: SHOULD
+
+ A VNF's Heat Orchestration Template's '{network-role}' case
+ in Resource property parameter names **SHOULD** match the case
+ of '{network-role}' in Resource IDs and vice versa.