Summary of changes

• changed various requirement targets (i.e. changing "The VNF..." to "A VNF...")
• Fixed RST section headers throughout entire document
• removed redundant text in "Heat Orchestration Template Structure" section
• moved text around in various sections for readability
• Added additional text in various sections for clarity
• reworded various requirements
• Removed "ONAP Parameter Classifications Overview" section, this section and subsections are redundant with other sections of the document and have created confusion in the past. Kept Output Parameters section

New Requirements

• R-91273 A VNF Heat Orchestration’s template’s parameter for the OS::Nova::Server resource property availability_zone *MAY NOT* be used in any OS::Nova::Resource.

• R-36772 A VNF’s Heat Orchestration Template’s parameter *MUST* include the attribute “type:”.

• R-11441 A VNF’s Heat Orchestration Template’s parameter ype *MUST* be one of the following values: "string", "number", "json", "comma_delimited_list" or "boolean".

• R-32094 A VNF's Heat Orchestration Template parameter declaration *MAY* contain the attribute "label:"

• R-32557 A VNF's Heat Orchestration Template parameter declaration MAY contain the attribute "hidden:".

• R-40518 A VNF's Heat Orchestration Template’s parameter defined as type "string" *MAY* have a parameter constraint defined.

• R-96227 A VNF's Heat Orchestration Template’s parameter defined as type "json" *MAY* have a parameter constraint defined.

• R-79817 A VNF's Heat Orchestration Template’s parameter defined as type "comma_delimited_list" *MAY* have a parameter constraint defined.

• R-06613 A VNF's Heat Orchestration Template’s parameter defined as type "boolean" *MAY* have a parameter constraint defined.

• R-22589 A VNF’s Heat Orchestration Template parameter declaration *MAY* contain the attribute "immutable:".

• R-40551 A VNF's Heat Orchestration Template's Nested YAML files *MAY* (or *MAY NOT*) contain the section "resources:".

• R-53952 A VNF’s Heat Orchestration Template’s Resource *MUST NOT* reference a HTTP-based resource definitions.

• R-71699 A VNF’s Heat Orchestration Template’s Resource *MUST NOT* reference a HTTP-based Nested YAML file.

• R-46968 VNF’s Heat Orchestration Template’s Resouce *MAY* declare the attribute “depends_on:”.

• R-63137 VNF’s Heat Orchestration Template’s Resouce *MAY* declare the attribute “update_policy:”.

• R-43740 A VNF’s Heat Orchestration Template’s Resouce *MAY* declare the attribute “deletion_policy:”.

• R-78569 A VNF’s Heat Orchestration Template’s Resouce *MAY* declare the attribute “external_id:”.

• R-36982 A VNF’s Heat Orchestration template *MAY* contain the “outputs:” section.

• R-68198 A VNF’s Heat Orchestration template’s Environment File’s “parameters:” section *MAY* (or *MAY NOT*) enumerate parameters.

• R-59930 A VNF’s Heat Orchestration template’s Environment File’s *MAY* contain the “parameter_defaults:” section.

• R-46096 A VNF’s Heat Orchestration template’s Environment File’s *MAY* contain the “encrypted_parameters:” section.

• R-24893 A VNF’s Heat Orchestration template’s Environment File’s *MAY* contain the “event_sinks:” section.

• R-42685 A VNF’s Heat Orchestration template’s Environment File’s *MAY* contain the “parameter_merge_strategies:” section.

• R-67231 A VNF’s Heat Orchestration template’s Environment File’s *MUST NOT* contain the “resource_registry:” section.

• R-69663 A VNF *MAY* be composed from one or more Heat Orchestration Templates, each of which represents a subset of the overall VNF.

• R-33132 A VNF’s Heat Orchestration Template *MAY* be 1.) Base Module Heat Orchestration Template (also referred to as a Base Module), 2.) Incremental Module Heat Orchestration Template (referred to as an Incremental Module), or 3.) a Cinder Volume Module Heat Orchestration Template (referred to as Cinder Volume Module).

• R-13196 A VNF *MAY* be composed of zero to many Incremental Modules

• R-28980 A VNF’s incremental module *MAY* be used for initial VNF deployment only.

• R-86926 A VNF’s incremental module *MAY* be used for scale out only.

• R-91497 A VNF’s incremental module *MAY* be used for both deployment and scale out.

• R-68122 A VNF’s incremental module *MAY* be deployed more than once, either during initial VNF deployment and/or scale out.

• R-46119 A VNF’s Heat Orchestration Template’s Resource OS::Heat::CinderVolume *MAY* be defined in a Base Module.

• R-90748 A VNF’s Heat Orchestration Template’s Resource OS::Cinder::Volume *MAY* be defined in an Incremental Module.

• R-03251 A VNF’s Heat Orchestration Template’s Resource OS::Cinder::Volume *MAY* be defined in a Cinder Volume Module.

• R-36582 A VNF’s Base Module *MAY* utilize nested heat.

• R-56721 A VNF’s Incremental Module *MAY* utilize nested heat.

• R-30395 A VNF’s Cinder Volume Module *MAY* utilize nested heat.

• R-87485 A VNF’s Heat Orchestration Template’s file extension *MUST* be in the lower case format ‘.yaml’ or ‘.yml’.

• R-56438 A VNF’s Heat Orchestration Template’s Nested YAML file extension *MUST* be in the lower case format ‘.yaml’ or ‘.yml’.

• R-74304 A VNF’s Heat Orchestration Template’s Environment file extension *MUST* be in the lower case format ‘.env’.

• R-89913 A VNF’s Heat Orchestration Template’s Cinder Volume Module Output Parameter(s) *MUST* be the UUID(s) of the Cinder Volumes created in template.

• R-20547 When an ONAP Volume Module Output Parameter is declared as an input parameter in a base or an incremental module Heat Orchestration Template, parameter constraints *MUST NOT* be declared.

• R-39349 A VNF Heat Orchestration Template *MUST NOT* be designed to utilize the OpenStack ‘heat stack-update’ command for scaling (growth/de-growth).

• R-43413 A VNF *MUST* utilize a modular Heat Orchestration Template design to support scaling (growth/de-growth).

• R-59482 A VNF’s Heat Orchestration Template *MUST NOT* be VNF instance specific or Cloud site specific

• R-56750 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.

• R-01896 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.

• R-16968 A VNF’s Heat Orchestration Templates *MUST NOT* include heat resources to create external networks.

• R-00606 A VNF *MAY* be connected to zero, one or more than one external networks.

• R-57424 A VNF’s port connected to an external network *MUST* connect the port to VMs in another VNF and/or an external gateway and/or external router.

• R-29865 A VNF’s port connected to an external network *MUST NOT* connect the port to VMs in the same VNF.

• R-69014 When a VNF connects to an external network, a network role, referred to as the ‘{network-role}’ *MUST* be assigned to the external network for use in the VNF’s Heat Orchestration Template.

• R-05201 When a VNF connects to two or more external networks, each external network *MUST* be assigned a unique ‘{network-role}’ in the context of the VNF for use in the VNF’s Heat Orchestration Template.

• R-83015 A VNF’s ‘{network-role}’ assigned to an external network *MUST* be different than the ‘{network-role}’ assigned to the VNF’s internal networks, if internal networks exist.

• R-87096 A VNF *MAY* contain zero, one or more than one internal networks.

• R-52425 A VNF’s port connected to an internal network *MUST* connect the port to VMs in the same VNF.

• R-46461 A VNF’s port connected to an internal network *MUST NOT* connect the port to VMs in another VNF and/or an external gateway and/or external router.

• R-68936 When a VNF creates an internal network, a network role, referred to as the ‘{network-role}’ *MUST* be assigned to the internal network for use in the VNF’s Heat Orchestration Template.

• R-32025 When a VNF creates two or more internal networks, each internal network *MUST* be assigned a unique ‘{network-role}’ in the context of the VNF for use in the VNF’s Heat Orchestration Template.

• R-69874 A VNF’s ‘{network-role}’ assigned to an internal network *MUST* be different than the ‘{network-role}’ assigned to the VNF’s external networks.

• R-34726 If a VNF’s port is connected to an internal network and the port is created in the same Heat Orchestration Template as the internal network, then the port resource *MUST* use a ‘get_resource’ to obtain the network UUID.

• R-22688 If a VNF’s port is connected to an internal network and the port is created in an Incremental Module and the internal network is created in the Base Module then the UUID of the internal network *MUST* be exposed as a parameter in the ‘outputs:’ section of the Base Module and the port resource *MUST* use a ‘get_param’ to obtain the network UUID.

Removed Requirements

• Consolidated R-19473 and R-81339 into one requirement

• R-23983 The VNF *MUST* pass the external networks into The VNF Heat Orchestration Template
  Orchestration Templates as parameters.