diff options
author | stark, steven <ss820f@att.com> | 2018-05-03 14:13:24 -0700 |
---|---|---|
committer | stark, steven <ss820f@att.com> | 2018-05-03 14:17:18 -0700 |
commit | 3e079f4efbfeca035c19688d6f51bd811b1e2462 (patch) | |
tree | ec84adac30c9dc8549920a7032d62a168df3bea3 | |
parent | 2929c28fa33c329c9d8bd335e976b994920740fa (diff) |
[VNFRQTS] change req target for heat
Change "VNF Heat" to "VNF Heat Orchestration Template"
Change-Id: I59e9ecf3f3546519187e608d3417a5be13eb4c95
Issue-ID: VNFRQTS-212
Signed-off-by: stark, steven <ss820f@att.com>
-rw-r--r-- | docs/Chapter3.rst | 2 | ||||
-rw-r--r-- | docs/Chapter5.rst | 192 |
2 files changed, 97 insertions, 97 deletions
diff --git a/docs/Chapter3.rst b/docs/Chapter3.rst index 81e13b9..88f932c 100644 --- a/docs/Chapter3.rst +++ b/docs/Chapter3.rst @@ -17,7 +17,7 @@ - The VNF - The VNFC - The VNF Provider - - The VNF Heat + - The VNF Heat Orchestration Template - The VNF Package - Chapter 4 contains the VNF/PNF requirements involving the design and development of VNFs/PNFs. These requirements help VNFs/PNFs operate diff --git a/docs/Chapter5.rst b/docs/Chapter5.rst index 55628fd..decbfc7 100644 --- a/docs/Chapter5.rst +++ b/docs/Chapter5.rst @@ -1637,7 +1637,7 @@ YAML rules include: - Tabs are NOT allowed, use spaces ONLY. -- R-43125 The VNF Heat **MUST** indent properties and lists with 1 or +- R-43125 The VNF Heat Orchestration Template **MUST** indent properties and lists with 1 or more spaces. - All Resource IDs and resource property parameters are case-sensitive. @@ -1673,7 +1673,7 @@ https://docs.openstack.org/developer/heat/template_guide/hot_spec.html. # declaration of conditions -R-67888 The VNF Heat **MUST** contain the following +R-67888 The VNF Heat Orchestration Template **MUST** contain the following sections: - heat\_template\_version: @@ -1700,7 +1700,7 @@ to a date that is supported by the OpenStack environment. description ++++++++++++ -R-39402 The VNF Heat **MUST** contain the description section. +R-39402 The VNF Heat Orchestration Template **MUST** contain the description section. parameter\_groups +++++++++++++++++++ @@ -1711,7 +1711,7 @@ parameters should be grouped and the order to provide the parameters in. parameters +++++++++++ -R-35414 The VNF Heat **MUST** contain the parameter section. +R-35414 The VNF Heat Orchestration Template **MUST** contain the parameter section. This section allows for specifying input parameters that must be provided when instantiating @@ -1719,7 +1719,7 @@ the template. Each parameter is specified in a separated nested block with the name of the parameters defined in the first line and additional attributes (e.g., type, label) defined as nested elements. -R-90279 The VNF Heat **MUST** use in a resource all parameters declared in +R-90279 The VNF Heat Orchestration Template **MUST** use in a resource all parameters declared in a template except for the parameters for the OS::Nova::Server property availability\_zone. See `Property: availability\_zone`_. for more details on availability\_zone. @@ -1750,7 +1750,7 @@ availability\_zone. - The type of the parameter. Supported types are string, number, comma\_delimited\_list, json and boolean. - - R-28657 The VNF Heat **MUST** provide the attribute 'type' on + - R-28657 The VNF Heat Orchestration Template **MUST** provide the attribute 'type' on parameters per the OpenStack Heat Orchestration Template standard. - label: @@ -1763,14 +1763,14 @@ availability\_zone. - A human readable description for the parameter. - - R-44001 The VNF Heat **MUST** provide the attribute 'description' + - R-44001 The VNF Heat Orchestration Template **MUST** provide the attribute 'description' on parameters. (Note that this attribute is OpenStack optional.) - default: - A default value for the parameter. - - R-90526 The VNF Heat **MUST NOT** use the attribute 'default'. + - R-90526 The VNF Heat Orchestration Template **MUST NOT** use the attribute 'default'. If a parameter has a default value, it must be provided in the environment file. (Note that this attribute is OpenStack optional.) @@ -1808,7 +1808,7 @@ availability\_zone. If omitted, a default validation message is presented to the user. This attribute is optional. -- R-88863 The VNF Heat **MUST** have a constraint of range or +- R-88863 The VNF Heat Orchestration Template **MUST** have a constraint of range or allowed\_values for a parameter type 'number'. - range: The range constraint applies to parameters of type number. @@ -1859,7 +1859,7 @@ availability\_zone. resources ++++++++++ -R-23664 The VNF Heat **MUST** have a resources: section with the +R-23664 The VNF Heat Orchestration Template **MUST** have a resources: section with the declaration of at least one resource. This section @@ -1891,7 +1891,7 @@ with the following syntax. - A resource ID that must be unique within the resources section of the Heat Orchestration Template. - - R-16447 The VNF Heat **MUST** have unique resource IDs across all Heat + - R-16447 The VNF Heat Orchestration Template **MUST** have unique resource IDs across all Heat Orchestration Templates that compose the VNF. This requirement also applies when a VNF is composed of more than one Heat Orchestration Template (see ONAP VNF Modularity Overview). @@ -1918,7 +1918,7 @@ with the following syntax. - Resource-specific metadata. This section is optional, except for the resource OS::Nova::Server. See `Resource: OS::Nova::Server - Parameters`_. - - R-97199 The VNF Heat **MUST** use the metadata property for + - R-97199 The VNF Heat Orchestration Template **MUST** use the metadata property for OS::Nova::Server resource type. - depends\_on @@ -1990,7 +1990,7 @@ The environment file can contain the following sections: - parameter\_merge\_strategies: Merge strategies for merging parameters and parameter defaults from the environment file. -R-03324 The VNF Heat **MUST** contain the following sections in the +R-03324 The VNF Heat Orchestration Template **MUST** contain the following sections in the environment file: - parameters: @@ -2069,10 +2069,10 @@ must not contain any special characters and must not contain the word Base Modules ~~~~~~~~~~~~~~ -R-19473 The VNF Heat **MUST** include “base” in the filename for the +R-19473 The VNF Heat Orchestration Template **MUST** include “base” in the filename for the base module -R-81339 The VNF Heat **MUST** match one of the following options for +R-81339 The VNF Heat Orchestration Template **MUST** match one of the following options for the base module file name: - base\_<text>.y[a]ml @@ -2083,7 +2083,7 @@ the base module file name: - <text>\_base\_<text>.y[a]ml -R-91342 The VNF Heat **MUST** name the base module’s corresponding +R-91342 The VNF Heat Orchestration Template **MUST** name the base module’s corresponding environment file to be identical to the base module with “.y[a]ml” replaced with “.env”. @@ -2093,12 +2093,12 @@ Incremental Modules There is no explicit naming convention for the incremental modules. As noted above, <text> represents any alphanumeric string. -R-87247 The VNF Heat **MUST NOT** use any special characters or the +R-87247 The VNF Heat Orchestration Template **MUST NOT** use any special characters or the word “base” in the name of the incremental module. - <text>.y[a]ml -R-94509 The VNF Heat **MUST** name the incremental module’s +R-94509 The VNF Heat Orchestration Template **MUST** name the incremental module’s corresponding environment file to be identical to the incremental module with “.y[a]ml” replaced with “.env”. @@ -2114,7 +2114,7 @@ following naming options for modules: Cinder Volume Modules ~~~~~~~~~~~~~~~~~~~~~~~ -R-82732 The VNF Heat **MUST** name the Cinder volume module file name +R-82732 The VNF Heat Orchestration Template **MUST** name the Cinder volume module file name to be the same as the corresponding module it is supporting (base module or incremental module) with “\_volume” appended. @@ -2122,7 +2122,7 @@ module or incremental module) with “\_volume” appended. - <incremental module name>\_volume.y[a]ml -R-31141 The VNF Heat **MUST** name the volume module’s corresponding +R-31141 The VNF Heat Orchestration Template **MUST** name the volume module’s corresponding environment file to be identical to the volume module with “.y[a]ml” replaced with “.env”. @@ -2132,7 +2132,7 @@ Nested Heat file There is no explicit naming convention for nested Heat files with the following exceptions; the name should contain “nest”. -R-76057 The VNF Heat **MUST NOT** use special characters +R-76057 The VNF Heat Orchestration Template **MUST NOT** use special characters or the word “base” in the file name for the nested template. As noted above, <text> represents any alphanumeric string. @@ -2142,7 +2142,7 @@ As noted above, <text> represents any alphanumeric string. Nested Heat files do not have corresponding environment files, per OpenStack specifications. -R-18224 The VNF Heat **MUST** pass in as properties all parameter values +R-18224 The VNF Heat Orchestration Template **MUST** pass in as properties all parameter values associated with the nested heat file in the resource definition defined in the parent heat template. @@ -2330,7 +2330,7 @@ The volume template output parameters are only available for the module module (base or incremental) that the Cinder volume module is associated with. -- R-07443 The VNF Heat **MUST** match the Output parameter name and type with +- R-07443 The VNF Heat Orchestration Template **MUST** match the Output parameter name and type with the input parameter name and type unless the Output parameter is of the type comma\_delimited\_list. @@ -2400,7 +2400,7 @@ LCPs. An External Network may be a Neutron Network or a Contrail Network -R-23983 The VNF **MUST** pass the external networks into the VNF Heat +R-23983 The VNF **MUST** pass the external networks into The VNF Heat Orchestration Template Orchestration Templates as parameters. - Neutron Network-id (UUID) @@ -2437,23 +2437,23 @@ when attaching VMs to an external network OS::ContrailV2::VirtualMachineInterfaces. This allows the assignment of a virtual IP (VIP) address to a set of VMs. -R-63345 The VNF Heat **MUST** pass the appropriate external +R-63345 The VNF Heat Orchestration Template **MUST** pass the appropriate external network IDs into nested VM templates when nested Heat is used. Internal Networks ----------------- -R-35666 The VNF Heat **MUST** include the resource(s) to +R-35666 The VNF Heat Orchestration Template **MUST** include the resource(s) to create the internal network. The internal network must be either a Neutron Network or a Contrail Network. -R-86972 The VNF Heat **MUST** create internal networks in the Base +R-86972 The VNF Heat Orchestration Template **MUST** create internal networks in the Base Module, in the modular approach, with their resource IDs exposed as outputs (i.e., ONAP Base Module Output Parameters) for use by all incremental modules. If the Network resource ID is required in the base template, then a get\_resource must be used. -R-68936 The VNF Heat **SHOULD** assign a unique +R-68936 The VNF Heat Orchestration Template **SHOULD** assign a unique {network-role} in the context of the VNF, when the internal network is created. `ONAP Resource ID and Parameter Naming Convention`_ provides additional details. @@ -2494,16 +2494,16 @@ This section provides the ONAP naming requirements for {vm-type} ^^^^^^^^^^^ -R-01455 The VNF Heat **MUST** assign a VNF unique +R-01455 The VNF Heat Orchestration Template **MUST** assign a VNF unique {vm-type} for each Virtual Machine type (i.e., OS::Nova::Server) instantiated in the VNF. While the {vm-type} must be unique to the VNF, it does not have to be globally unique across all VNFs that ONAP supports. -R-82481 The VNF Heat **MUST** include {vm-type} as part of the parameter name +R-82481 The VNF Heat Orchestration Template **MUST** include {vm-type} as part of the parameter name for any parameter that is associated with a unique Virtual Machine type. -R-66729 The VNF Heat **MUST** include {vm-type} as part of the resource ID +R-66729 The VNF Heat Orchestration Template **MUST** include {vm-type} as part of the resource ID for any resource ID that is associated with a unique Virtual Machine type in the VNF. @@ -2517,10 +2517,10 @@ The {vm-type} should not contain the string “\_int” or “int\_” or “\_int\_”. It may cause the Pre-Amsterdam VNF Validation Program (i.e., ICE Project) process to produce erroneous error messages. -R-32394 The VNF Heat **MUST** use the same case for {vm-type} for all +R-32394 The VNF Heat Orchestration Template **MUST** use the same case for {vm-type} for all parameter names in the VNF. -R-46839 The VNF Heat **MUST** use the same case for {vm-type} for all +R-46839 The VNF Heat Orchestration Template **MUST** use the same case for {vm-type} for all Resource IDs in the VNF. It is recommended that the {vm-type} case in the parameter names matches @@ -2528,13 +2528,13 @@ the {vm-type} case in the Resource IDs. There are two exceptions to the above rules: -1. R-05008 The VNF Heat **MUST NOT** be prefixed with a common +1. R-05008 The VNF Heat Orchestration Template **MUST NOT** be prefixed with a common {vm-type} identifier for the six ONAP Metadata parameters. They are *vnf\_name*, *vnf\_id*, *vf\_module\_id*, *vf\_module\_name, vm\_role*. The ONAP Metadata parameters are described in `Resource: OS::Nova::Server – Metadata Parameters`_. -2. R-15422 The VNF Heat **MUST NOT** be prefixed with a common {vm-type} +2. R-15422 The VNF Heat Orchestration Template **MUST NOT** be prefixed with a common {vm-type} identifier the parameter referring to the OS::Nova::Server property availability\_zone . availability\_zone is described in `Property: availability_zone`_. @@ -2543,17 +2543,17 @@ There are two exceptions to the above rules: The assignment of a {network-role} is discussed in `Networking`_. -R-21330 The VNF Heat **MUST** include the {network-role} as part of the +R-21330 The VNF Heat Orchestration Template **MUST** include the {network-role} as part of the parameter name for any parameter that is associated with an external network. -R-11168 The VNF Heat **MUST** include the {network-role} as part of the +R-11168 The VNF Heat Orchestration Template **MUST** include the {network-role} as part of the resource ID for any resource ID that is associated with an external network must. -R-84322 The VNF Heat **MUST** include int\_{network-role} as part of the +R-84322 The VNF Heat Orchestration Template **MUST** include int\_{network-role} as part of the parameter name for any parameter that is associated with an internal network. -R-96983 The VNF Heat **MUST** include int\_{network-role} as part of the +R-96983 The VNF Heat Orchestration Template **MUST** include int\_{network-role} as part of the resource ID for any resource ID that is associated with an internal network. Note that {network-role} must not be a substring of {vm-type}. A @@ -2566,10 +2566,10 @@ The {network-role} should not contain the string “\_int” or “int\_” or “\_int\_”. It may cause the Pre-Amsterdam VNF Validation Program (i.e., ICE Project) process to produce erroneous error messages. -R-58424 The VNF Heat **MUST** use the same case for {network-role} for +R-58424 The VNF Heat Orchestration Template **MUST** use the same case for {network-role} for all parameter names in the VNF. -R-21511 The VNF Heat **MUST** use the same case for {network-role} for +R-21511 The VNF Heat Orchestration Template **MUST** use the same case for {network-role} for all Resource IDs in the VNF. It is recommended that the {network-role} case in the parameter names @@ -2580,25 +2580,25 @@ Resource IDs Heat Orchestration Template resources are described in `resources`_ -R-59629 The VNF Heat **MUST** have unique resource IDs within the +R-59629 The VNF Heat Orchestration Template **MUST** have unique resource IDs within the resources section of a Heat Orchestration Template. This is an OpenStack Requirement. -R-43319 The VNF Heat **MUST** have unique resource IDs +R-43319 The VNF Heat Orchestration Template **MUST** have unique resource IDs across all modules that compose the VNF, when a VNF is composed of more than one Heat Orchestration Template (i.e., modules). -R-54517 The VNF Heat **MUST** include {vm-type} in the resource ID +R-54517 The VNF Heat Orchestration Template **MUST** include {vm-type} in the resource ID when a resource is associated with a single {vm-type}. -R-96482 The VNF Heat **MUST** include {network-role} in the resource ID +R-96482 The VNF Heat Orchestration Template **MUST** include {network-role} in the resource ID when a resource is associated with a single external network. -R-98138 The VNF Heat **MUST** include int\_{network-role} in the resource ID +R-98138 The VNF Heat Orchestration Template **MUST** include int\_{network-role} in the resource ID when a resource is associated with a single internal network. -R-82115 The VNF Heat **MUST** include both the {vm-type} and +R-82115 The VNF Heat Orchestration Template **MUST** include both the {vm-type} and {network-role} in the resource ID, when a resource is associated with a single {vm-type} and a single external network. @@ -2610,7 +2610,7 @@ external network. {network-role}. An underscore will separate the three values (i.e., {vm-type}\_{index}\_{network-role}). -R-82551 The VNF Heat **MUST** include both the {vm-type} and +R-82551 The VNF Heat Orchestration Template **MUST** include both the {vm-type} and int\_{network-role} in the resource ID, when a resource is associated with a single {vm-type} and a single internal network. @@ -2631,7 +2631,7 @@ than one network, the resource ID - should contain the term “shared” and/or contain text that identifies the VNF. -R-69287 The VNF Heat **MUST** use only alphanumeric characters and “\_” +R-69287 The VNF Heat Orchestration Template **MUST** use only alphanumeric characters and “\_” underscores in the resource ID. Special characters must not be used. All {index} values must be zero based. That is, the {index} must start @@ -2757,13 +2757,13 @@ parameter. The parameters must be named {vm-type}\_image\_name in the Heat Orchestration Template. -R-71152 The VNF Heat **MUST** declare as type: string the parameter +R-71152 The VNF Heat Orchestration Template **MUST** declare as type: string the parameter for property image. -R-91125 The VNF Heat **MUST** enumerate the parameter for property +R-91125 The VNF Heat Orchestration Template **MUST** enumerate the parameter for property image in the Heat Orchestration Template environment file. -R-57282 The VNF Heat **MUST** have a separate parameter for image for +R-57282 The VNF Heat Orchestration Template **MUST** have a separate parameter for image for Each VM type (i.e., {vm-type}) even if more than one {vm-type} shares the same image. This provides maximum clarity and flexibility. @@ -2785,13 +2785,13 @@ parameter. The parameters must be named {vm-type}\_flavor\_name in the Heat Orchestration Template. -R-50436 The VNF Heat **MUST** declare the parameter property for +R-50436 The VNF Heat Orchestration Template **MUST** declare the parameter property for flavor as type: string. -R-69431 The VNF Heat **MUST** enumerate the parameter for property +R-69431 The VNF Heat Orchestration Template **MUST** enumerate the parameter for property flavor in the Heat Orchestration Template environment file. -R-40499 The VNF Heat **MUST** have a separate parameter for flavor for each +R-40499 The VNF Heat Orchestration Template **MUST** have a separate parameter for flavor for each VM type (i.e., {vm-type}) even if more than one {vm-type} shares the same flavor. This provides maximum clarity and flexibility. @@ -2812,10 +2812,10 @@ parameter. The parameter value is provided to the Heat template by ONAP. -R-22838 The VNF Heat **MUST NOT** enumerate the parameter for property name +R-22838 The VNF Heat Orchestration Template **MUST NOT** enumerate the parameter for property name in the environment file. -R-51430 The VNF Heat **MUST** declare the parameter for property name as +R-51430 The VNF Heat Orchestration Template **MUST** declare the parameter for property name as type: string or type: comma\_delimited\_list If the parameter is declared as type:string, the parameter must be named @@ -2919,14 +2919,14 @@ Orchestration parameter. The parameter value is provided to the Heat template by ONAP. The parameter must not be enumerated in the environment file. -R-98450 The VNF Heat **MUST** name the parameter availability\_zone\_{index} +R-98450 The VNF Heat Orchestration Template **MUST** name the parameter availability\_zone\_{index} in the Heat Orchestration Template. -R-13561 The VNF Heat **MUST** start the {index} at zero. +R-13561 The VNF Heat Orchestration Template **MUST** start the {index} at zero. -R-60204 The VNF Heat **MUST** increment the {index} by one. +R-60204 The VNF Heat Orchestration Template **MUST** increment the {index} by one. -R-36887 The VNF Heat **MUST NOT** include the {vm-type} in the parameter name. +R-36887 The VNF Heat Orchestration Template **MUST NOT** include the {vm-type} in the parameter name. The parameter must be declared as type: string @@ -3019,7 +3019,7 @@ The resource OS::Nova::Server has an OpenStack optional property metadata. The metadata property is mandatory for ONAP Heat Orchestration Templates; it must be included. -R-17020 The VNF Heat **MUST** include the following three mandatory +R-17020 The VNF Heat Orchestration Template **MUST** include the following three mandatory metadata parameters for an OS::Nova::Server resource: - vnf\_id @@ -3075,10 +3075,10 @@ Template at orchestration time. The parameter must be declared as type: string -R-55218 The VNF Heat **MUST NOT** have parameter constraints defined +R-55218 The VNF Heat Orchestration Template **MUST NOT** have parameter constraints defined for the OS::Nova::Server metadata parameter vnf\_id. -R-20856 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server +R-20856 The VNF Heat Orchestration Template **MUST NOT** enumerate the OS::Nova::Server metadata parameter vnf\_id in environment file. *Example Parameter Definition* @@ -3102,10 +3102,10 @@ Heat Orchestration Template at orchestration time. The parameter must be declared as type: string -R-98374 The VNF Heat **MUST NOT** have parameter constraints +R-98374 The VNF Heat Orchestration Template **MUST NOT** have parameter constraints defined for the OS::Nova::Server metadata parameter vf\_module\_id. -R-72871 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server +R-72871 The VNF Heat Orchestration Template **MUST NOT** enumerate the OS::Nova::Server metadata parameter vf\_module\_id in environment file. *Example Parameter Definition* @@ -3129,10 +3129,10 @@ time. The parameter must be declared as type: string -R-44318 The VNF Heat **MUST NOT** have parameter constraints defined +R-44318 The VNF Heat Orchestration Template **MUST NOT** have parameter constraints defined for the OS::Nova::Server metadata parameter vnf\_name. -R-36542 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server +R-36542 The VNF Heat Orchestration Template **MUST NOT** enumerate the OS::Nova::Server metadata parameter vnf\_name in the environment file. *Example Parameter Definition* @@ -3302,7 +3302,7 @@ External Networks When the parameter references an external network -- R-72050 The VNF Heat **MUST** contain {network-role} in the parameter name +- R-72050 The VNF Heat Orchestration Template **MUST** contain {network-role} in the parameter name - the parameter must not be enumerated in the Heat environment file @@ -3360,7 +3360,7 @@ Internal Networks When the parameter references an internal network -- R-57576 The VNF Heat **MUST** contain int\_{network-role} +- R-57576 The VNF Heat Orchestration Template **MUST** contain int\_{network-role} in the parameter name. - the parameter may be enumerated in the environment file. @@ -3424,7 +3424,7 @@ defined in OpenStack. External Networks ++++++++++++++++++ -R-93272 The VNF Heat **MUST** adhere to the following parameter naming +R-93272 The VNF Heat Orchestration Template **MUST** adhere to the following parameter naming convention in the Heat Orchestration Template, when the parameter associated with the property network is referencing an “external” network: @@ -3471,7 +3471,7 @@ to assign IP addresses. Internal Networks ++++++++++++++++++ -R-65373 The VNF Heat **MUST** adhere to the following parameter naming +R-65373 The VNF Heat Orchestration Template **MUST** adhere to the following parameter naming convention, when the parameter associated with the property network is referencing an “internal” network: @@ -3519,7 +3519,7 @@ assigned IP addresses. Subnet of an External Networks +++++++++++++++++++++++++++++++ -R-47716 The VNF Heat **MUST** adhere to the following parameter naming +R-47716 The VNF Heat Orchestration Template **MUST** adhere to the following parameter naming convention for the property fixed\_ips and Map Property subnet\_id parameter, when the parameter is referencing a subnet of an “external” network. @@ -3606,7 +3606,7 @@ balancer. Internal Networks ++++++++++++++++++ -R-20106 The VNF Heat **MUST** adhere to the following naming convention for +R-20106 The VNF Heat Orchestration Template **MUST** adhere to the following naming convention for the property fixed\_ips and Map Property subnet\_id parameter, when the parameter is referencing the subnet of an “internal” network: @@ -3650,7 +3650,7 @@ An IP address is assigned to a port on a VM (referenced by {vm-type}) that is connected to an external network (referenced by {network-role}) or internal network (referenced by int\_{network-role}). -R-41177 The VNF Heat **MUST** include {vm-type} and {network-role} +R-41177 The VNF Heat Orchestration Template **MUST** include {vm-type} and {network-role} in the parameter name, when a SDN-C IP assignment is made to a port connected to an external network. @@ -3666,7 +3666,7 @@ assign IP addresses to an external network, the parameter name is dependent on the parameter type (comma\_delimited\_list or string) and IP address type (IPv4 or IPv6). -R-84898 The VNF Heat **MUST** adhere to the following naming convention, +R-84898 The VNF Heat Orchestration Template **MUST** adhere to the following naming convention, when the parameter for property fixed\_ips and Map Property ip\_address is declared type: comma\_delimited\_list: @@ -3728,7 +3728,7 @@ an oam network and the {vm-type} has been defined as db for database. - “ip_address”: {get_param: [ db_oam_ips, 1 ]} - “ip_address”: {get_param: [ db_oam_v6_ips, 1 ]} -R-34960 The VNF Heat **MUST** adhere to the following +R-34960 The VNF Heat Orchestration Template **MUST** adhere to the following naming convention, when the parameter for property fixed\_ips and Map Property ip\_address is declared type: string: @@ -3807,7 +3807,7 @@ assign IP addresses to an internal network, the parameter name is dependent on the parameter type (comma\_delimited\_list or string) and IP address type (IPv4 or IPv6). -R-62584 The VNF Heat **MUST** adhere to +R-62584 The VNF Heat Orchestration Template **MUST** adhere to the following naming convention, when the parameter for property fixed\_ips and Map Property ip\_address is declared type: comma\_delimited\_list: @@ -3876,7 +3876,7 @@ database. - “ip_address”: {get_param: [ db_int_oam_int_ips, 1 ]} - “ip_address”: {get_param: [ db_int_oam_int_v6_ips, 1 ]} -R-29256 The VNF Heat **MUST** must adhere to the following +R-29256 The VNF Heat Orchestration Template **MUST** must adhere to the following naming convention, when the parameter for property fixed\_ips and Map Property ip\_address is declared type: string: @@ -3986,7 +3986,7 @@ Neutron-style Floating IPs. External Networks ++++++++++++++++++ -R-61282 The VNF Heat **MUST** +R-61282 The VNF Heat Orchestration Template **MUST** adhere to the following naming convention for the property allowed\_address\_pairs and Map Property ip\_address parameter, when the parameter is referencing an “external” network: @@ -4051,7 +4051,7 @@ an oam network and the {vm-type} has been defined as db for database. Internal Networks +++++++++++++++++++ -R-16805 The VNF Heat **MUST** adhere to the following naming convention +R-16805 The VNF Heat Orchestration Template **MUST** adhere to the following naming convention for the property allowed\_address\_pairs and Map Property ip\_address parameter when the parameter is referencing an “internal” network. @@ -4196,7 +4196,7 @@ OS::Nova::Server resources must be defined when the property is used. Not all resources require the property name (e.g., it is optional) and some resources do not support the property. -R-85734 The VNF Heat **MUST** use the intrinsic function str\_replace +R-85734 The VNF Heat Orchestration Template **MUST** use the intrinsic function str\_replace in conjunction with the ONAP supplied metadata parameter vnf\_name to generate a unique value, when the property name for a non OS::Nova::Server resources is defined @@ -4600,7 +4600,7 @@ module. Use of separate volume modules is optional. A Cinder volume may be embedded within the Base Module or Incremental Module if persistence is not required. -R-47788 The VNF Heat **MUST** have a 1:1 scope of a cinder volume module, +R-47788 The VNF Heat Orchestration Template **MUST** have a 1:1 scope of a cinder volume module, when it exists, with the Base Module or Incremental Module A single volume module must create only the volumes @@ -4614,7 +4614,7 @@ The following rules apply to independent volume Heat templates: - A single Cinder volume module must include all Cinder volumes needed by the Base/Incremental module. -- R-79531 The VNF Heat **MUST** define “outputs” in the volume +- R-79531 The VNF Heat Orchestration Template **MUST** define “outputs” in the volume template for each Cinder volume resource universally unique identifier (UUID) (i.e. ONAP Volume Template Output Parameters). @@ -4700,20 +4700,20 @@ ONAP Support of Environment Files The use of an environment file in OpenStack is optional. In ONAP, it is mandatory. -R-86285 The VNF Heat **MUST** have a +R-86285 The VNF Heat Orchestration Template **MUST** have a corresponding environment file, even if no parameters are required to be enumerated. (Note that ONAP, the open source version of ONAP, does not programmatically enforce the use of an environment file.) -R-67205 The VNF Heat **MUST** have a corresponding +R-67205 The VNF Heat Orchestration Template **MUST** have a corresponding environment file for a Base Module. -R-35727 The VNF Heat **MUST** have a +R-35727 The VNF Heat Orchestration Template **MUST** have a corresponding environment file for an Incremental module. -R-22656 The VNF Heat **MUST** have a corresponding environment file +R-22656 The VNF Heat Orchestration Template **MUST** have a corresponding environment file for a Cinder Volume Module. A nested heat template must not have an environment file; OpenStack does @@ -4793,10 +4793,10 @@ Nested heat templates must be referenced by file name. The use of resource\_registry in the environment file is not supported and must not be used. -R-89868 The VNF Heat **MUST** have unique file names within the scope +R-89868 The VNF Heat Orchestration Template **MUST** have unique file names within the scope of the VNF for a nested heat yaml file. -R-52530 The VNF Heat **MUST NOT** use a directory hierarchy for +R-52530 The VNF Heat Orchestration Template **MUST NOT** use a directory hierarchy for nested templates. All templates must be in a single, flat directory (per VNF). @@ -4807,11 +4807,11 @@ Note that: - Constrains must not be defined for any parameter enumerated in a nested heat template. -- R-11041 The VNF Heat **MUST** have the resource calling the +- R-11041 The VNF Heat Orchestration Template **MUST** have the resource calling the nested yaml file pass in as properties all parameters defined in nested yaml file. -- R-61183 The VNF Heat **MUST NOT** change the parameter names, when OS::Nova::Server metadata parameters are past into a nested heat +- R-61183 The VNF Heat Orchestration Template **MUST NOT** change the parameter names, when OS::Nova::Server metadata parameters are past into a nested heat template. - With nested templates, outputs are required to expose any resource @@ -5037,16 +5037,16 @@ a VM on startup via the “personality” property. Support for Heat Files is subject to the following limitations: -R-76718 The VNF Heat **MUST** reference the get\_files targets in +R-76718 The VNF Heat Orchestration Template **MUST** reference the get\_files targets in Heat templates by file name, and the corresponding files should be delivered to ONAP along with the Heat templates. R-41888 The VNE Heat **MUST NOT** use URL-based file retrieval. -R-62177 The VNF Heat **MUST** have unique file names for the included +R-62177 The VNF Heat Orchestration Template **MUST** have unique file names for the included files within the scope of the VNF. -R-87848 The VNF Heat **MUST** have all included files in a single, flat +R-87848 The VNF Heat Orchestration Template **MUST** have all included files in a single, flat directory per VNF. ONAP does not support a directory hierarchy. - Included files may be used by all Modules within a given VNF. @@ -5081,7 +5081,7 @@ keypair. The Heat should be structured in such a way as to: - Pass a public key as a parameter value instead of a keypair name -- Create a new keypair within the VNF Heat templates (in the base +- Create a new keypair within The VNF Heat Orchestration Template (in the base module) for use within that VNF By following this approach, the end result is the same as pre-creating |