diff options
| -rw-r--r-- | docs/docs_vfw.rst | 120 | ||||
| -rw-r--r-- | docs/files/vFWCL_vFWSNK_report.json | 3126 | ||||
| -rw-r--r-- | docs/files/vFWCL_vPKG_report.json | 3115 |
3 files changed, 3773 insertions, 2588 deletions
diff --git a/docs/docs_vfw.rst b/docs/docs_vfw.rst index 010fb4ac3..b9ed9adb7 100644 --- a/docs/docs_vfw.rst +++ b/docs/docs_vfw.rst @@ -6,11 +6,11 @@ vFirewall Use Case Source files ~~~~~~~~~~~~ -- vFirewall/vSink template file: https://git.onap.org/demo/tree/heat/vFWCL/vFWSNK/base_vfw.yaml?h=dublin -- vFirewall/vSink environment file: https://git.onap.org/demo/tree/heat/vFWCL/vFWSNK/base_vfw.env?h=dublin +- vFirewall/vSink template file: https://git.onap.org/demo/tree/heat/vFWCL/vFWSNK/base_vfw.yaml?h=elalto +- vFirewall/vSink environment file: https://git.onap.org/demo/tree/heat/vFWCL/vFWSNK/base_vfw.env?h=elalto -- vPacketGenerator template file: https://git.onap.org/demo/tree/heat/vFWCL/vPKG/base_vpkg.env?h=dublin -- vPacketGenerator environment file: https://git.onap.org/demo/tree/heat/vFWCL/vPKG/base_vpkg.env?h=dublin +- vPacketGenerator template file: https://git.onap.org/demo/tree/heat/vFWCL/vPKG/base_vpkg.env?h=elalto +- vPacketGenerator environment file: https://git.onap.org/demo/tree/heat/vFWCL/vPKG/base_vpkg.env?h=elalto VVP Report ~~~~~~~~~~ @@ -22,30 +22,43 @@ VVP Report Description ~~~~~~~~~~~ -The use case is composed of three virtual functions (VFs): packet generator, firewall, and traffic sink. -These VFs run in three separate VMs. The packet generator sends packets to the packet sink through the firewall. -The firewall reports the volume of traffic passing though to the ONAP DCAE collector. To check the traffic volume -that lands at the sink VM, you can access the link http://sink_ip_address:667 through your browser and enable -automatic page refresh by clicking the "Off" button. You can see the traffic volume in the charts. - -The packet generator includes a script that periodically generates different volumes of traffic. The closed-loop -policy has been configured to re-adjust the traffic volume when high-water or low-water marks are crossed. - -Since Casablanca, we have used a vFWCL service tag for this testing instead of the vFW service tag. vFW servic tag -is a regression for onboard and instantiation of a single VNF service (all three VMs in the same VNF) where as the +The use case, introduced in Amsterdam version, is composed of three virtual +functions (VFs): packet generator, firewall, and traffic sink. +These VFs run in three separate VMs. The packet generator sends packets to the +packet sink through the firewall. +The firewall reports the volume of traffic passing though to the ONAP DCAE +collector. To check the traffic volume that lands at the sink VM, you can access +the link http://sink_ip_address:667 through your browser and enable automatic page +refresh by clicking the "Off" button. You can see the traffic volume in the charts. + +The packet generator includes a script that periodically generates different +volumes of traffic. The closed-loop policy has been configured to re-adjust the +traffic volume when high-water or low-water marks are crossed. + +Since Casablanca, we have used a vFWCL service tag for this testing instead of +the vFW service tag. vFW servic tag is a regression for onboard and +instantiation of a single VNF service (all three VMs in the same VNF) where as the vFWCL is a two VNF service (vFW+ vSNK and separeate vPKG) -./demo-k8s.sh onap instantiateVFWCL can be used to onboard and instantiate a vFWCL via robot scripts or follow the procedure to use the GUI that is available in the documentation. +./demo-k8s.sh onap instantiateVFWCL can be used to onboard and instantiate a +vFWCL via robot scripts or follow the procedure to use the GUI that is available +in the documentation. Closed-Loop for vFirewall Use Case ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Through the ONAP Portal's Policy Portal, we can find the configuration and operation policies that are currently -enabled for the vFirewall use case: - -- The configuration policy sets the thresholds for generating an onset event from DCAE to the Policy engine. Currently, the high-water mark is set to 700 packets while the low-water mark is set to 300 packets. The measurement interval is set to 10 seconds. -- When a threshold is crossed (i.e. the number of received packets is below 300 packets or above 700 packets per 10 seconds), the Policy engine executes the operational policy to request APPC to adjust the traffic volume to 500 packets per 10 seconds. +Through the ONAP Portal's Policy Portal, we can find the configuration and +operation policies that are currently enabled for the vFirewall use case: + +- The configuration policy sets the thresholds for generating an onset event + from DCAE to the Policy engine. Currently, the high-water mark is set to 700 + packets while the low-water mark is set to 300 packets. + The measurement interval is set to 10 seconds. +- When a threshold is crossed (i.e. the number of received packets is below 300 + packets or above 700 packets per 10 seconds), the Policy engine executes the + operational policy to request APPC to adjust the traffic volume to 500 packets + per 10 seconds. - APPC sends a request to the packet generator to adjust the traffic volume. - Changes to the traffic volume can be observed through the link http://sink_ip_address:667. @@ -53,12 +66,15 @@ enabled for the vFirewall use case: Adjust packet generator ~~~~~~~~~~~~~~~~~~~~~~~ -The packet generator contains 10 streams: fw_udp1, fw_udp2, fw_udp3, ..., fw_udp10. Each stream generates 100 packets -per 10 seconds. A script in /opt/run_traffic_fw_demo.sh on the packet generator VM starts automatically and alternates high -traffic (i.e. 10 active streams at the same time) and low traffic (1 active stream) every 5 minutes. +The packet generator contains 10 streams: fw_udp1, fw_udp2, fw_udp3, ..., fw_udp10. +Each stream generates 100 packets per 10 seconds. +A script in /opt/run_traffic_fw_demo.sh on the packet generator VM starts +automatically and alternates high traffic (i.e. 10 active streams at the same +time) and low traffic (1 active stream) every 5 minutes. -To adjust the traffic volume produced by the packet generator, run the following command in a shell, replacing PacketGen_IP in -the HTTP argument with localhost (if you run it in the packet generator VM) or the packet generator IP address: +To adjust the traffic volume produced by the packet generator, run the following +command in a shell, replacing PacketGen_IP in the HTTP argument with localhost +(if you run it in the packet generator VM) or the packet generator IP address: :: @@ -76,46 +92,50 @@ the HTTP argument with localhost (if you run it in the packet generator VM) or t The command above enables 5 streams. - - -Preconditions -~~~~~~~~~~~~~ - -The control loop name in DCAE's TCA micro-service needs to match the Operational Policy control loop name. -Due to timing robot scripts that setup the operational policy do not change the control loop name in DCAE. -Do the following to update DCAE's consul entry for TCA to match the name assigned by robot to the operational -policy. The control loop name generated by policy can be viewed in the log.html page on robot from the -instantiateVFWCL. - -- Connect to Consul: http://<k8s_host_ip>:30270/ui/#/dc1/services (change the IP based on the K8S cluster IP assignment) -- Click Key/Value on the bar at the top of the Consul menu -- Select "dcae-tca-analytics" microservice from the list on the left -- Search for "closedLoopControlName" key in the configuration policy JSON object -- Replace the standard ControlLoop-vFirewall-* closed loop names with the one generated by robot -- Click "Update" button to update the configuration policy - Running the Use Case ~~~~~~~~~~~~~~~~~~~~ -Users can run the use case using the automated Robot Framework or manually. For using the Robot Framework in an ONAP instance installed with OOM, users have to ssh to the Rancher VM and run the following command: +Users can run the use case using the automated Robot Framework or manually. +For using the Robot Framework in an ONAP instance installed with OOM, users have +to ssh to the Rancher VM and run the following command: :: bash oom/kubernetes/robot/demo-k8s.sh <namespace> vfwclosedloop <pgn-ip-address> -The script sets the packet generator to high and low rates, and checks whether the policy kicks in to modulate the rates back to medium. At the end of the test , robot sets the streams back to Medium so that it is setup for the next test. +The script sets the packet generator to high and low rates, and checks whether +the policy kicks in to modulate the rates back to medium. +At the end of the test , robot sets the streams back to Medium so that it is +setup for the next test. -For documentation about running the use case manually for previous releases, please look at the videos and the material available at this `wiki page`__. +For documentation about running the use case manually for previous releases, +please look at the videos and the material available at this `wiki page`__. __ https://wiki.onap.org/display/DW/Running+the+ONAP+Demos -Although videos are still valid, users are encouraged to use the Heat templates linked at the top of this page rather than the old Heat templates in that wiki page. +Although videos are still valid, users are encouraged to use the Heat templates +linked at the top of this page rather than the old Heat templates in that wiki page. Known issues and resolution ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The packet generator may become unresponsive to external inputs like changing the number of active streams. To solve the problem, reboot the packet generator VM. -Policy can lock the target VNF if there are too many failed attempts due to mis-configuration etc. Set the streams to medium and wait 30 minutes or so and the lock in policy will expire. Monitoring the DMaaP topic for DCAE_CL_OUTPUT can be used to confirm that no TCA events are coming in from the VNF through VES/TCA. +The packet generator may become unresponsive to external inputs like changing +the number of active streams. +To solve the problem, reboot the packet generator VM. + +Policy can lock the target VNF if there are too many failed attempts due to +mis-configuration etc. +Set the streams to medium and wait 30 minutes or so and the lock in policy will +expire. Monitoring the DMaaP topic for DCAE_CL_OUTPUT can be used to confirm +that no TCA events are coming in from the VNF through VES/TCA. :: http://<k8s-host>:30227/events/unauthenticated.DCAE_CL_OUTPUT/g1/c3?timeout=5000 + ++-------------+------------+ +| JIRA ID | Status | ++=============+============+ +| POLICY-2109 | Closed | ++-------------+------------+ +| INT-1272 | Closed | ++-------------+------------+ diff --git a/docs/files/vFWCL_vFWSNK_report.json b/docs/files/vFWCL_vFWSNK_report.json index e9d4deaaf..ac8114332 100644 --- a/docs/files/vFWCL_vFWSNK_report.json +++ b/docs/files/vFWCL_vFWSNK_report.json @@ -1,17 +1,17 @@ { - "version": "dublin", - "template_directory": "/tmp/demo/heat/vFWCL/vFWSNK", - "timestamp": "2019-04-24T18:41:31.997833", - "checksum": "4b28a0c62135134357d7b348b29aab1a", + "version": "elalto", + "template_directory": "/template", + "timestamp": "2019-10-15T09:19:10.438037", + "checksum": "a3a35fbe5883e744eecaed5b0f851cae", "categories": "", "outcome": "FAIL", "tests": [ { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.env" ], - "test_module": "test_get_attr_usage", - "test_case": "test_08_validate_get_attr_usage", + "test_module": "test_initial_configuration", + "test_case": "test_00_valid_yaml", "result": "PASS", "error": "", "requirements": [ @@ -24,74 +24,74 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_get_file_only_reference_local_files", - "test_case": "test_get_file_no_url_retrieval", + "test_module": "test_initial_configuration", + "test_case": "test_00_valid_yaml", "result": "PASS", "error": "", "requirements": [ { - "id": "R-41888", - "text": "A VNF's Heat Orchestration Template intrinsic function\n``get_file`` **MUST NOT** utilize URL-based file retrieval.", - "keyword": "MUST NOT" + "id": "R-95303", + "text": "A VNF's Heat Orchestration Template **MUST** be defined using valid YAML.", + "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_get_file_only_reference_local_files", - "test_case": "test_get_file_only_reference_local_files", + "test_module": "test_initial_configuration", + "test_case": "test_02_no_duplicate_keys_in_file", "result": "PASS", "error": "", "requirements": [ { - "id": "R-76718", - "text": "If a VNF's Heat Orchestration Template uses the intrinsic function\n``get_file``, the ``get_file`` target **MUST** be referenced in\nthe Heat Orchestration Template by file name.", + "id": "R-92635", + "text": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.env" ], "test_module": "test_initial_configuration", - "test_case": "test_00_valid_yaml", + "test_case": "test_02a_no_duplicate_keys_in_env", "result": "PASS", "error": "", "requirements": [ { - "id": "R-95303", - "text": "A VNF's Heat Orchestration Template **MUST** be defined using valid YAML.", + "id": "R-92635", + "text": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.env" + "../vvp/base_vfw.yaml" ], "test_module": "test_initial_configuration", - "test_case": "test_00_valid_yaml", + "test_case": "test_03_all_referenced_resources_exists", "result": "PASS", "error": "", "requirements": [ { - "id": "R-95303", - "text": "A VNF's Heat Orchestration Template **MUST** be defined using valid YAML.", + "id": "R-92635", + "text": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_initial_configuration", - "test_case": "test_02_no_duplicate_keys_in_file", + "test_case": "test_04_valid_nesting", "result": "PASS", "error": "", "requirements": [ @@ -104,10 +104,10 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_initial_configuration", - "test_case": "test_03_all_referenced_resources_exists", + "test_case": "test_05_all_get_param_have_defined_parameter", "result": "PASS", "error": "", "requirements": [ @@ -120,55 +120,71 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_initial_configuration", - "test_case": "test_04_valid_nesting", + "test_case": "test_06_heat_template_resource_section_has_resources", "result": "PASS", "error": "", "requirements": [ { - "id": "R-92635", - "text": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", + "id": "R-90152", + "text": "A VNF's Heat Orchestration Template's\n``resources:`` section **MUST** contain the declaration of at\nleast one resource.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_initial_configuration", - "test_case": "test_05_all_get_param_have_defined_parameter", + "test_module": "test_get_attr_usage", + "test_case": "test_08_validate_get_attr_usage", "result": "PASS", "error": "", "requirements": [ { - "id": "R-92635", - "text": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", + "id": "R-95303", + "text": "A VNF's Heat Orchestration Template **MUST** be defined using valid YAML.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_initial_configuration", - "test_case": "test_06_heat_template_resource_section_has_resources", + "test_module": "test_get_file_only_reference_local_files", + "test_case": "test_get_file_no_url_retrieval", "result": "PASS", "error": "", "requirements": [ { - "id": "R-90152", - "text": "A VNF's Heat Orchestration Template's\n``resources:`` section **MUST** contain the declaration of at\nleast one resource.", + "id": "R-41888", + "text": "A VNF's Heat Orchestration Template intrinsic function\n``get_file`` **MUST NOT** utilize URL-based file retrieval.", + "keyword": "MUST NOT" + } + ] + }, + { + "files": [ + "../vvp/base_vfw.yaml" + ], + "test_module": "test_get_file_only_reference_local_files", + "test_case": "test_get_file_only_reference_local_files", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-76718", + "text": "If a VNF's Heat Orchestration Template uses the intrinsic function\n``get_file``, the ``get_file`` target **MUST** be referenced in\nthe Heat Orchestration Template by file name.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_all_parameters_used_in_template", "test_case": "test_all_parameters_used_in_template", @@ -184,70 +200,55 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_allowed_address_pairs_include_vm_type_network_role", - "test_case": "test_external_aap_format", + "test_module": "test_resource_ids_alphanumeric_only", + "test_case": "test_alphanumeric_resource_ids_only", "result": "PASS", "error": "", "requirements": [ { - "id": "R-41492", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 Virtual IP (VIP)\naddress is assigned via ONAP automation\nusing the property ``allowed_address_pairs``\nmap property ``ip_address`` and\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as type ``string``.", - "keyword": "MUST" - }, - { - "id": "R-35735", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 Virtual IP (VIP)\naddress is assigned via ONAP automation\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as type ``string``.", + "id": "R-75141", + "text": "A VNF's Heat Orchestration Template's resource name\n(i.e., <resource ID>) **MUST** only contain alphanumeric\ncharacters and underscores ('_').", "keyword": "MUST" - }, - { - "id": "R-159016", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nECOMP definition, see Requirement R-57424),\nand an IPv4 and/or IPv6 Virtual IP (VIP)\naddress is assigned via ECOMP automation\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``, the\nparameter **MUST NOT** be declared as ``type: comma_deliited_list``.", - "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_allowed_address_pairs_include_vm_type_network_role", - "test_case": "test_internal_aap_format", + "test_module": "test_availability_zone", + "test_case": "test_availability_zone_naming", "result": "PASS", "error": "", "requirements": [ { - "id": "R-717227", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nECOMP definition, see Requirements R-52425 and R-46461),\nand an IPv4 Virtual IP (VIP)\naddress is assigned using the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file.\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", - "keyword": "MUST" - }, - { - "id": "R-805572", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nECOMP definition, see Requirements R-52425 and R-46461),\nand an IPv6 Virtual IP (VIP)\naddress is assigned\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "id": "R-98450", + "text": "A VNF's Heat Orchestration Template's base module or incremental module\nresource ``OS::Nova::Server``\nproperty ``availability_zone`` parameter\n**MUST** follow the naming convention\n\n* ``availability_zone_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at zero\nin a VNF's Heat Orchestration Templates and **MUST**\nincrement by one.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_availability_zone", - "test_case": "test_availability_zone_naming", + "test_module": "test_server_parameters", + "test_case": "test_availability_zone_parameter_type", "result": "PASS", "error": "", "requirements": [ { - "id": "R-98450", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``availability_zone`` parameter name\n**MUST** follow the naming convention\n\n* ``availability_zone_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at zero\nin a VNF's Heat Orchestration Templates and **MUST**\nincrement by one.", + "id": "R-23311", + "text": "The VNF's Heat Orchestration Template's base module or incremental module\nresource ``OS::Nova::Server`` property\n``availability_zone`` parameter **MUST** be declared as type: ``string``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_availability_zone_params_start_at_0", "test_case": "test_availability_zones_start_at_0", @@ -256,14 +257,14 @@ "requirements": [ { "id": "R-98450", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``availability_zone`` parameter name\n**MUST** follow the naming convention\n\n* ``availability_zone_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at zero\nin a VNF's Heat Orchestration Templates and **MUST**\nincrement by one.", + "text": "A VNF's Heat Orchestration Template's base module or incremental module\nresource ``OS::Nova::Server``\nproperty ``availability_zone`` parameter\n**MUST** follow the naming convention\n\n* ``availability_zone_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at zero\nin a VNF's Heat Orchestration Templates and **MUST**\nincrement by one.", "keyword": "MUST" } ] }, { "files": [ - "." + "../vvp/template" ], "test_module": "test_base_template_names", "test_case": "test_base_template_names", @@ -282,24 +283,24 @@ }, { "id": "R-81339", - "text": "A VNF Heat Orchestration Template's Base Module file name **MUST** include\ncase insensitive 'base' in the filename and\n**MUST** match one of the following four\nformats:\n\n 1.) ``base_<text>.y[a]ml``\n\n 2.) ``<text>_base.y[a]ml``\n\n 3.) ``base.y[a]ml``\n\n 4.) ``<text>_base_<text>``.y[a]ml\n\nwhere ``<text>`` **MUST** contain only alphanumeric characters and\nunderscores '_' and **MUST NOT** contain the case insensitive word ``base``.", + "text": "A VNF Heat Orchestration Template's Base Module file name **MUST** include\ncase insensitive 'base' in the filename and\n**MUST** match one of the following four\nformats:\n\n 1.) ``base_<text>.y[a]ml``\n\n 2.) ``<text>_base.y[a]ml``\n\n 3.) ``base.y[a]ml``\n\n 4.) ``<text>_base_<text>``.y[a]ml\n\nwhere ``<text>`` **MUST** contain only alphanumeric characters and\nunderscores '_' and **MUST NOT** contain the case insensitive string\n``base`` or ``volume``.", "keyword": "MUST" }, { "id": "R-87247", - "text": "VNF Heat Orchestration Template's Incremental Module file name\n**MUST** contain only alphanumeric characters and underscores\n'_' and **MUST NOT** contain the case insensitive word ``base``.", + "text": "VNF Heat Orchestration Template's Incremental Module file name\n**MUST** contain only alphanumeric characters and underscores\n'_' and **MUST NOT** contain the case insensitive string ``base``.", "keyword": "MUST" }, { "id": "R-76057", - "text": "VNF Heat Orchestration Template's Nested YAML file name **MUST** contain\nonly alphanumeric characters and underscores '_' and\n**MUST NOT** contain the case insensitive word ``base``.", + "text": "VNF Heat Orchestration Template's Nested YAML file name **MUST** contain\nonly alphanumeric characters and underscores '_' and\n**MUST NOT** contain the case insensitive string ``base``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_cloud_config_resource_id", "test_case": "test_cloud_config", @@ -315,7 +316,69 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" + ], + "test_module": "test_contrail_instance_ip_parameters", + "test_case": "test_contrail_external_instance_ip_address_parameter", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-100000", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n**MUST** be declared as either type ``string`` or type\n``comma_delimited_list``.", + "keyword": "MUST" + }, + { + "id": "R-100010", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the ONAP definition, see Requirement R-57424),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST" + }, + { + "id": "R-100030", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_ips``\n\n where\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the external\n network", + "keyword": "MUST" + }, + { + "id": "R-100050", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network\n(per the\nONAP definition, see Requirement R-57424),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST" + }, + { + "id": "R-100070", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vfw.yaml" + ], + "test_module": "test_contrail_instance_ip_parameters", + "test_case": "test_contrail_external_instance_subnet_id_parameter", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-100190", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid``\nparameter\n**MUST** be declared type ``string``.", + "keyword": "MUST" + }, + { + "id": "R-100200", + "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv4 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv4 subnet is to be specified\nusing the property ``subnet_uuid``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", + "keyword": "MUST" + }, + { + "id": "R-100220", + "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv6 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv6 subnet is to be specified\nusing the property ``subnet_uuid``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_v6_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vfw.yaml" ], "test_module": "test_contrail_fqdn", "test_case": "test_contrail_fqdn", @@ -331,7 +394,28 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" + ], + "test_module": "test_contrail_instance_ip_parameters", + "test_case": "test_contrail_incremental_module_internal_subnet_usage", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-100240", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::ContrailV2::InstanceIp`` in an Incremental Module is\n assigning an IP address\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``subnet_uuid``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "keyword": "MUST" + }, + { + "id": "R-100260", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::ContrailV2::InstanceIp`` in an Incremental Module is\n attaching\n to an internal network (per the ONAP definition,\n see Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``subnet_uuid``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vfw.yaml" ], "test_module": "test_contrail_instance_ip_resource_id", "test_case": "test_contrail_instance_ip_resource_id_external", @@ -340,19 +424,35 @@ "requirements": [ { "id": "R-53310", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv4 Address on a port attached to an external network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the {vm-type}\n* ``{network-role}`` is the network-role of the network that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type attached to the network of {network-role}\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` is the index of the IPv4 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv4 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an external network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network that the\n virtual machine interface is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` references the instance of the IPv4 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv4 address is configured on the\n virtual machine interface.", "keyword": "MUST" }, { "id": "R-46128", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv6 Address on a port attached to an external network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type\n attached to the network of {network-role}\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` is the index of the IPv6 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv6 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an external network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` references the instance of the IPv6 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv6 address is configured on the\n virtual machine interface.", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vfw.yaml" + ], + "test_module": "test_contrail_vmi_resource_id", + "test_case": "test_contrail_instance_ip_resource_id_external", + "result": "SKIP", + "error": "", + "requirements": [ + { + "id": "R-96253", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` Resource ID\nthat is attaching to an external network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_contrail_instance_ip_resource_id", "test_case": "test_contrail_instance_ip_resource_id_internal", @@ -361,67 +461,202 @@ "requirements": [ { "id": "R-62187", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv4 Address on a port attached to an internal network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type\n attached to the network of ``{network-role}``\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` is the index of the IPv4 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv4 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an internal network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` references the instance of the IPv4 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv4 address is configured on the\n virtual machine interface.", "keyword": "MUST" }, { "id": "R-87563", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv6 Address on a port attached to an internal network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type\n attached to the network of ``{network-role}``\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` is the index of the IPv6 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv6 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an internal network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` references the instance of the IPv6 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv6 address is configured on the\n virtual machine interface.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_contrail_irt_routes", - "test_case": "test_contrail_irt_route_param_format", + "test_module": "test_contrail_vmi_resource_id", + "test_case": "test_contrail_instance_ip_resource_id_internal", "result": "SKIP", "error": "", "requirements": [ { - "id": "R-28222", - "text": "If a VNF's Heat Orchestration Template\n``OS::ContrailV2::InterfaceRouteTable`` resource\n``interface_route_table_routes`` property\n``interface_route_table_routes_route`` map property parameter name\n**MUST** follow the format\n\n* ``{vm-type}_{network-role}_route_prefixes``", + "id": "R-50468", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` Resource ID\nthat is attaching to an internal network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vfw.yaml" + ], + "test_module": "test_contrail_resource_id", + "test_case": "test_contrail_interfaceroutetable_resource_id", + "result": "SKIP", + "error": "", + "requirements": [ + { + "id": "R-81214", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InterfaceRouteTable``\nResource ID\n**MUST**\ncontain the ``{network-role}``.", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vfw.yaml" + ], + "test_module": "test_contrail_instance_ip_parameters", + "test_case": "test_contrail_internal_instance_ip_address_parameter", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-100000", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n**MUST** be declared as either type ``string`` or type\n``comma_delimited_list``.", + "keyword": "MUST" + }, + { + "id": "R-100090", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is\ndefined as a ``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST" + }, + { + "id": "R-100110", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "keyword": "MUST" + }, + { + "id": "R-100130", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST" + }, + { + "id": "R-100150", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vfw.yaml" + ], + "test_module": "test_environment_file_parameters", + "test_case": "test_contrail_internal_instance_ip_does_exist_in_environment_file", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-100100", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_int_{network-role}_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-100120", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_int_{network-role}_int_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-100140", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_int_{network-role}_v6_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-100160", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_v6_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-100180", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp``\nproperty ``instance_ip_address``\nparameter associated with an internal network, i.e.,\n\n * ``{vm-type}_int_{network-role}_ip_{index}``\n * ``{vm-type}_int_{network-role}_v6_ip_{index}``\n * ``{vm-type}_int_{network-role}_ips``\n * ``{vm-type}_int_{network-role}_v6_ips``\n\n\n**MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and IP addresses **MUST** be\nassigned.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" + ], + "test_module": "test_contrail_instance_ip_parameters", + "test_case": "test_contrail_internal_instance_subnet_id_parameter", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-100190", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid``\nparameter\n**MUST** be declared type ``string``.", + "keyword": "MUST" + }, + { + "id": "R-100240", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::ContrailV2::InstanceIp`` in an Incremental Module is\n assigning an IP address\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``subnet_uuid``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "keyword": "MUST" + }, + { + "id": "R-100260", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::ContrailV2::InstanceIp`` in an Incremental Module is\n attaching\n to an internal network (per the ONAP definition,\n see Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``subnet_uuid``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vfw.yaml" + ], + "test_module": "test_allowed_address_pairs_include_vm_type_network_role", + "test_case": "test_contrail_internal_vmi_aap_parameter", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-100360", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 Virtual IP (VIP)\naddress is assigned using the map property,\n``virtual_machine_interface_allowed_address_pairs,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n, the parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file.\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "keyword": "MUST" + }, + { + "id": "R-100370", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 Virtual IP (VIP)\naddress is assigned\nusing the map property,\n``virtual_machine_interface_allowed_address_pairs,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n, the parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vfw.yaml" ], "test_module": "test_contrail_irt_routes", - "test_case": "test_contrail_irt_route_param_type", + "test_case": "test_contrail_irt_route_param_format", "result": "SKIP", "error": "", "requirements": [ { - "id": "R-19756", - "text": "If a VNF's Heat Orchestration Template\n``OS::ContrailV2::InterfaceRouteTable`` resource\n``interface_route_table_routes`` property\n``interface_route_table_routes_route`` map property parameter\n``{vm-type}_{network-role}_route_prefixes``\n**MUST** be defined as type ``json``.", + "id": "R-28222", + "text": "If a VNF's Heat Orchestration Template\n``OS::ContrailV2::InterfaceRouteTable`` resource\n``interface_route_table_routes`` property\n``interface_route_table_routes_route`` map property parameter name\n**MUST** follow the format\n\n* ``{vm-type}_{network-role}_route_prefixes``", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_contrail_resource_id", - "test_case": "test_contrail_interfaceroutetable_resource_id", + "test_module": "test_contrail_irt_routes", + "test_case": "test_contrail_irt_route_param_type", "result": "SKIP", "error": "", "requirements": [ { - "id": "R-81214", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InterfaceRouteTable``\nResource ID\n**MUST**\ncontain the ``{network-role}``.", + "id": "R-19756", + "text": "If a VNF's Heat Orchestration Template\n``OS::ContrailV2::InterfaceRouteTable`` resource\n``interface_route_table_routes`` property\n``interface_route_table_routes_route`` map property parameter\n``{vm-type}_{network-role}_route_prefixes``\n**MUST** be defined as type ``json``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_contrail_resource_id", "test_case": "test_contrail_networkipam_resource_id", @@ -437,7 +672,7 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_contrail_resource_id", "test_case": "test_contrail_porttuple_resource_id", @@ -453,7 +688,7 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_contrail_resource_id", "test_case": "test_contrail_servicehealthcheck_resource_id", @@ -469,7 +704,7 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_contrail_resource_id", "test_case": "test_contrail_servicetemplate_resource_id", @@ -478,62 +713,46 @@ "requirements": [ { "id": "R-16437", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate``\nResource ID **MUST** contain the ``{vm-type}``.", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::ServiceTemplate``\nResource ID **MUST** contain the ``{vm-type}``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_contrail_vmi_resource_id", - "test_case": "test_contrail_instance_ip_resource_id_external", - "result": "SKIP", - "error": "", - "requirements": [ - { - "id": "R-96253", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` that is attaching to an external network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` is the instance of the vmi on the vm-type\n attached to the network of ``{network-role}``", - "keyword": "MUST" - } - ] - }, - { - "files": [ - "base_vfw.yaml" - ], - "test_module": "test_contrail_vmi_resource_id", - "test_case": "test_contrail_instance_ip_resource_id_internal", - "result": "SKIP", + "test_module": "test_heat_parameter_section", + "test_case": "test_default_values", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-50468", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` that is attaching to an internal network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` is the instance of the vmi on the vm-type\n attached to the network of ``{network-role}``", + "id": "R-90526", + "text": "A VNF Heat Orchestration Template parameter declaration **MUST NOT**\ncontain the ``default`` attribute.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/template" ], - "test_module": "test_contrail_vn_resource_id", - "test_case": "test_neutron_net_resource_id", - "result": "SKIP", + "test_module": "test_volume_module_naming", + "test_case": "test_detected_volume_module_follows_naming_convention", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-99110", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualNetwork`` Resource ID **MUST** use the naming convention\n\n1) ``int_{network-role}_network``\n\nor\n\n2) ``int_{network-role}_RVN`` where RVN represents Resource Virtual\n Network\n\nVNF Heat Orchestration Templates can only create internal networks.\nThere is no ``{index}`` after ``{network-role}`` because ``{network-role}``\n**MUST** be unique in the scope of the VNF's\nHeat Orchestration Template.\n\nNote that option 1 is preferred.", + "id": "R-589037", + "text": "A VNF Heat Orchestration Template's Cinder Volume Module ``resources:``\nsection\n**MUST** only be defined using one of the following:\n\n* one of more ``OS::Cinder::Volume`` resources\n* one or more ``OS::Heat::ResourceGroup`` resources that call a nested YAML\n file that contains only ``OS::Cinder::Volume`` resources\n* a resource that calls a nested YAML file (static nesting) that contains\n only ``OS::Cinder::Volume`` resources", "keyword": "MUST" } ] }, { "files": [ - "." + "../vvp/template" ], "test_module": "test_env_and_yaml_same_name", "test_case": "test_env_and_yaml_same_name", @@ -559,7 +778,7 @@ }, { "files": [ - "../../../../../private/tmp/VVP-186/ice_validator/env_files0" + "../vvp/env_files0" ], "test_module": "test_env_no_resource_registry", "test_case": "test_env_no_resource_registry", @@ -575,7 +794,7 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_env_parameters_defined_in_template", "test_case": "test_env_params_are_defined_in_template", @@ -591,149 +810,117 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_environment_file_parameters", - "test_case": "test_nova_server_image_parameter_exists_in_environment_file", + "test_module": "test_nova_servers_environment_context", + "test_case": "test_environment_context", "result": "PASS", "error": "", "requirements": [ { - "id": "R-91125", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``image`` parameter **MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and a value **MUST** be assigned.", + "id": "R-20308", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``environment_context``\nparameter **MUST** be declared as ``environment_context`` and the\nparameter type **MUST** be defined as type: ``string``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_environment_file_parameters", - "test_case": "test_nova_server_flavor_parameter_exists_in_environment_file", - "result": "PASS", + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_environment_context_parameter_has_no_constraints", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-69431", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``flavor`` parameter **MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and a value **MUST** be assigned.", - "keyword": "MUST" + "id": "R-56183", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata``key/value pair ``environment_context``\nparameter ``environment_context`` **MUST NOT**\nhave parameter constraints defined.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.env" ], - "test_module": "test_environment_file_parameters", - "test_case": "test_neutron_port_internal_fixedips_ipaddress_parameter_exists_in_environment_file", + "test_module": "test_environment_file_structure", + "test_case": "test_environment_file_contains_required_sections", "result": "PASS", "error": "", "requirements": [ { - "id": "R-28795", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", - "keyword": "MUST" - }, - { - "id": "R-97201", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_v6_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", - "keyword": "MUST" - }, - { - "id": "R-93496", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``fixed_ips``\nmap property ``ip_address``\nparameter associated with an internal network, i.e.,\n\n * ``{vm-type}_int_{network-role}_ip_{index}``\n * ``{vm-type}_int_{network-role}_v6_ip_{index}``\n * ``{vm-type}_int_{network-role}_ips``\n * ``{vm-type}_int_{network-role}_v6_ips``\n\n\n**MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and IP addresses **MUST** be\nassigned.", - "keyword": "MUST" - }, - { - "id": "R-90206", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_int_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", - "keyword": "MUST" - }, - { - "id": "R-98569", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_v6_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", - "keyword": "MUST" - }, - { - "id": "R-93496", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``fixed_ips``\nmap property ``ip_address``\nparameter associated with an internal network, i.e.,\n\n * ``{vm-type}_int_{network-role}_ip_{index}``\n * ``{vm-type}_int_{network-role}_v6_ip_{index}``\n * ``{vm-type}_int_{network-role}_ips``\n * ``{vm-type}_int_{network-role}_v6_ips``\n\n\n**MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and IP addresses **MUST** be\nassigned.", + "id": "R-03324", + "text": "A VNF's Heat Orchestration template's Environment File **MUST**\ncontain the ``parameters:`` section.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_environment_file_parameters", - "test_case": "test_heat_rg_count_parameter_exists_in_environment_file", + "test_module": "test_allowed_address_pairs_include_vm_type_network_role", + "test_case": "test_external_aap_format", "result": "PASS", "error": "", "requirements": [ { - "id": "R-50011", - "text": "A VNF's Heat Orchestration Template's ``OS::Heat::ResourceGroup``\nproperty ``count`` **MUST** be enumerated in the VNF's\nHeat Orchestration Template's Environment File and **MUST** be\nassigned a value.", + "id": "R-41492", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv4 VIP is required to be supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nAs noted in the introduction to this section, the ONAP data model\ncan only support one IPv4 VIP address.", "keyword": "MUST" - } - ] - }, - { - "files": [ - "base_vfw.env" - ], - "test_module": "test_environment_file_structure", - "test_case": "test_environment_file_contains_required_sections", - "result": "PASS", - "error": "", - "requirements": [ + }, { - "id": "R-03324", - "text": "A VNF's Heat Orchestration template's Environment File **MUST**\ncontain the ``parameters:`` section.", + "id": "R-35735", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv6 VIP is required to be supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nAs noted in the introduction to this section, the ONAP data model\ncan only support one IPv6 VIP address.", + "keyword": "MUST" + }, + { + "id": "R-41493", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv4 VIP address and/or IPv6 VIP address\nis **not** supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\n\n* Parameter name **MAY** use any naming convention. That is, there is no\n ONAP mandatory parameter naming convention.\n* Parameter **MAY** be declared as type ``string`` or type\n``comma_delimited_list``.\n\nAnd the ``OS::Neutron::Port`` resource **MUST** contain\nresource-level ``metadata`` (not property-level).\n\nAnd the ``metadata`` format **MUST** must contain the\nkey value ``aap_exempt`` with a list of all\n``allowed_address_pairs`` map property ``ip_address`` parameters\n**not** supported by the ONAP data model.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_filename_is_vmtype_dot_yaml", - "test_case": "test_filename_is_vmtype_dot_yaml", + "test_module": "test_allowed_address_pairs_include_vm_type_network_role", + "test_case": "test_external_aap_format_contrail", "result": "PASS", "error": "", "requirements": [ { - "id": "R-70276", - "text": "A VNF HEAT's Orchestration Nested Template's YAML file name **MUST NOT**\nbe in the format ``{vm-type}.y[a]ml`` where ``{vm-type}`` is defined\nin the Heat Orchestration Template.", + "id": "R-100280", + "text": "If a VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface``\nis attaching to an external network (per the\nONAP definition, see Requirement R-57424), the\nmap property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameter\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", "keyword": "MUST NOT" - } - ] - }, - { - "files": [ - "." - ], - "test_module": "test_files_in_flat_dir", - "test_case": "test_files_in_flat_dir", - "result": "PASS", - "error": "", - "requirements": [ + }, { - "id": "R-511776", - "text": "When a VNF's Heat Orchestration Template is ready\nto be on-boarded to ONAP,\nall files composing the VNF Heat Orchestration Template\n**MUST** be placed in a flat (i.e., non-hierarchical) directory and\narchived using ZIP. The resulting ZIP file is uploaded into ONAP.", + "id": "R-100310", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an external\nnetwork (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 Virtual IP (VIP)\nis required to be supported by the ONAP data model,\nthe map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nThe ONAP data model can only support one IPv4 VIP address.", "keyword": "MUST" }, { - "id": "R-99646", - "text": "A VNF's YAML files (i.e, Heat Orchestration Template files and\nNested files) **MUST** have a unique name in the scope of the VNF.", + "id": "R-100330", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an external\nnetwork (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 Virtual IP (VIP)\nis required to be supported by the ONAP data model,\nthe map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nThe ONAP data model can only support one IPv6 VIP address.", + "keyword": "MUST" + }, + { + "id": "R-100350", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an\nexternal network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv4 VIP address and/or IPv6 VIP address\nis **not** supported by the ONAP data model,\nthe map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\n* Parameter name **MAY** use any naming convention. That is, there is no\n ONAP mandatory parameter naming convention.\n* Parameter **MAY** be declared as type ``string`` or type\n``comma_delimited_list``.\n\nAnd the ``OS::ContrailV2::VirtualMachineInterface`` resource\n**MUST** contain resource-level ``metadata`` (not property-level).\n\nAnd the ``metadata`` format **MUST** must contain the\nkey value ``aap_exempt`` with a list of all map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameters **not** supported by the ONAP data model.", + "keyword": "MUST NOT" + }, + { + "id": "R-41493", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv4 VIP address and/or IPv6 VIP address\nis **not** supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\n\n* Parameter name **MAY** use any naming convention. That is, there is no\n ONAP mandatory parameter naming convention.\n* Parameter **MAY** be declared as type ``string`` or type\n``comma_delimited_list``.\n\nAnd the ``OS::Neutron::Port`` resource **MUST** contain\nresource-level ``metadata`` (not property-level).\n\nAnd the ``metadata`` format **MUST** must contain the\nkey value ``aap_exempt`` with a list of all\n``allowed_address_pairs`` map property ``ip_address`` parameters\n**not** supported by the ONAP data model.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_fixed_ips_include_vm_type_network_role", "test_case": "test_external_fip_format", @@ -747,7 +934,7 @@ }, { "id": "R-35735", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 Virtual IP (VIP)\naddress is assigned via ONAP automation\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as type ``string``.", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv6 VIP is required to be supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nAs noted in the introduction to this section, the ONAP data model\ncan only support one IPv6 VIP address.", "keyword": "MUST" }, { @@ -774,75 +961,86 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_fixed_ips_include_vm_type_network_role", - "test_case": "test_internal_fip_format", + "test_module": "test_neutron_port_network_attachment", + "test_case": "test_external_network_parameter", "result": "PASS", "error": "", "requirements": [ { - "id": "R-27818", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", - "keyword": "MUST" - }, - { - "id": "R-29765", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "id": "R-62983", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424), the\n``network`` parameter name **MUST**\n\n * follow the naming convention ``{network-role}_net_id`` if the Neutron\n network UUID value is used to reference the network\n * follow the naming convention ``{network-role}_net_name`` if the\n OpenStack network name is used to reference the network.\n\nwhere ``{network-role}`` is the network-role of the external network\nand a ``get_param`` **MUST** be used as the intrinsic function.", "keyword": "MUST" - }, + } + ] + }, + { + "files": [ + "../vvp/base_vfw.yaml" + ], + "test_module": "test_neutron_port_fixed_ips_subnet", + "test_case": "test_external_subnet_format", + "result": "PASS", + "error": "", + "requirements": [ { - "id": "R-85235", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "id": "R-38236", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n**MUST** be declared type ``string``.", "keyword": "MUST" }, { - "id": "R-78380", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is\ndefined as a ``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "id": "R-62802", + "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` is attaching\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv4 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv4 subnet is to be specified\nusing the property ``fixed_ips``\nmap property ``subnet``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", "keyword": "MUST" }, { - "id": "R-34037", - "text": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n**MUST** be declared as either type ``string`` or type\n``comma_delimited_list``.", + "id": "R-15287", + "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` is attaching\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv6 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv6 subnet is to be specified\nusing the property ``fixed_ips``\nmap property ``subnet``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_v6_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_forbidden_resources", - "test_case": "test_neutron_floating_ip_resource_type", + "test_module": "test_filename_is_vmtype_dot_yaml", + "test_case": "test_filename_is_vmtype_dot_yaml", "result": "PASS", "error": "", "requirements": [ { - "id": "R-05257", - "text": "A VNF's Heat Orchestration Template's **MUST NOT**\ncontain the Resource ``OS::Neutron::FloatingIP``.", + "id": "R-70276", + "text": "A VNF HEAT's Orchestration Nested Template's YAML file name **MUST NOT**\nbe in the format ``{vm-type}.y[a]ml`` where ``{vm-type}`` is defined\nin the Heat Orchestration Template.", "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/template" ], - "test_module": "test_forbidden_resources", - "test_case": "test_neutron_floating_ip_association_resource_type", + "test_module": "test_files_in_flat_dir", + "test_case": "test_files_in_flat_dir", "result": "PASS", "error": "", "requirements": [ { - "id": "R-76449", - "text": "A VNF's Heat Orchestration Template's **MUST NOT**\ncontain the Resource ``OS::Neutron::FloatingIPAssociation``.", - "keyword": "MUST NOT" + "id": "R-511776", + "text": "When a VNF's Heat Orchestration Template is ready\nto be on-boarded to ONAP,\nall files composing the VNF Heat Orchestration Template\n**MUST** be placed in a flat (i.e., non-hierarchical) directory and\narchived using ZIP. The resulting ZIP file is uploaded into ONAP.", + "keyword": "MUST" + }, + { + "id": "R-99646", + "text": "A VNF's YAML files (i.e, Heat Orchestration Template files and\nNested files) **MUST** have a unique name in the scope of the VNF.", + "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_heat_pairs_provided", "test_case": "test_heat_pairs_provided", @@ -898,39 +1096,23 @@ }, { "files": [ - "base_vfw.yaml" - ], - "test_module": "test_heat_parameter_section", - "test_case": "test_default_values", - "result": "PASS", - "error": "", - "requirements": [ - { - "id": "R-90526", - "text": "A VNF Heat Orchestration Template parameter declaration **MUST NOT**\ncontain the ``default`` attribute.", - "keyword": "MUST" - } - ] - }, - { - "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_heat_parameter_section", - "test_case": "test_parameter_names", + "test_module": "test_environment_file_parameters", + "test_case": "test_heat_rg_count_parameter_exists_in_environment_file", "result": "PASS", "error": "", "requirements": [ { - "id": "R-25877", - "text": "A VNF's Heat Orchestration Template's parameter name\n(i.e., <param name>) **MUST** contain only alphanumeric\ncharacters and underscores ('_').", + "id": "R-50011", + "text": "A VNF's Heat Orchestration Template's ``OS::Heat::ResourceGroup``\nproperty ``count`` **MUST** be enumerated in the VNF's\nHeat Orchestration Template's Environment File and **MUST** be\nassigned a value.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_heat_template_parameters_contain_required_fields", "test_case": "test_heat_template_parameters_contain_required_fields", @@ -951,39 +1133,39 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_heat_template_structure", - "test_case": "test_heat_template_structure_contains_heat_template_version", + "test_case": "test_heat_template_structure_contains_description", "result": "PASS", "error": "", "requirements": [ { - "id": "R-27078", - "text": "A VNF's Heat Orchestration template **MUST** contain the\nsection ``heat_template_version:``.", + "id": "R-39402", + "text": "A VNF's Heat Orchestration Template **MUST** contain the\nsection ``description:``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_heat_template_structure", - "test_case": "test_heat_template_structure_contains_description", + "test_case": "test_heat_template_structure_contains_heat_template_version", "result": "PASS", "error": "", "requirements": [ { - "id": "R-39402", - "text": "A VNF's Heat Orchestration Template **MUST** contain the\nsection ``description:``.", + "id": "R-27078", + "text": "A VNF's Heat Orchestration template **MUST** contain the\nsection ``heat_template_version:``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_heat_template_structure", "test_case": "test_heat_template_structure_contains_parameters", @@ -999,7 +1181,7 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_heat_template_structure", "test_case": "test_heat_template_structure_contains_resources", @@ -1015,1221 +1197,1219 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_heat_template_structure", - "test_case": "test_parameter_type", + "test_module": "test_nested_parameters", + "test_case": "test_iip_instance_ip_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-11441", - "text": "A VNF's Heat Orchestration Template's parameter type **MUST** be one of\nthe following values:\n\n* ``string``\n* ``number``\n* ``json``\n* ``comma_delimited_list``\n* ``boolean``", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_ip_parameters_start_at_0", - "test_case": "test_ips_start_at_0", + "test_module": "test_nested_parameters", + "test_case": "test_iip_subnet_uuid_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-71577", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", - "keyword": "MUST" - }, - { - "id": "R-40971", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_multipart_mime_resource_id", - "test_case": "test_multipart_mime", - "result": "SKIP", + "test_module": "test_incremental_module", + "test_case": "test_incremental_module_has_server", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-30804", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::Heat::MultipartMime``\nResource ID\n**MUST**\ncontain the ``{vm-type}``.", + "id": "R-610030", + "text": "A VNF's Heat Orchestration Template's Incremental Module **MUST**\ndeclare one or more ``OS::Nova::Server`` resources. A ``OS::Nova::Server``\n**MAY** be created in the incremental module or a nested yaml file invoked\nby the incremental module.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameter_args", - "test_case": "test_nested_parameter_args", - "result": "SKIP", + "test_module": "test_resource_indices", + "test_case": "test_indices_start_at_0_increment", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-10834", - "text": "If a VNF's Heat Orchestration Template resource attribute\n``property:`` uses a nested ``get_param``, the nested\n``get_param`` **MUST** reference an index.\n\nThat is, to obtain a property value, two ``get_param`` intrinsic\nfunctions are used. The second ``get_param`` must be used\nto obtain an index value used to reference a parameter value in\na parameter defined as ``type: comma_delimited_list``. For\nexample:\n\n* ``name: {get_param: [ name, get_param: index ] }``", + "id": "R-11690", + "text": "When a VNF's Heat Orchestration Template's Resource ID contains an\n``{index}``, the ``{index}`` is a numeric value that **MUST** start at\nzero and **MUST** increment by one.\n\nAs stated in R-16447,\n*a VNF's <resource ID> MUST be unique across all Heat\nOrchestration Templates and all HEAT Orchestration Template\nNested YAML files that are used to create the VNF*. While the ``{index}``\nwill start at zero in the VNF, the ``{index}`` may not start at zero\nin a given Heat Orchestration Template or HEAT Orchestration Template\nNested YAML file.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_name_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_allowed_address_pairs_include_vm_type_network_role", + "test_case": "test_internal_aap_format", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-717227", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 Virtual IP (VIP)\naddress is assigned using the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file.\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "keyword": "MUST" + }, + { + "id": "R-805572", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 Virtual IP (VIP)\naddress is assigned\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_image_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_fixed_ips_include_vm_type_network_role", + "test_case": "test_internal_fip_format", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-27818", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST" + }, + { + "id": "R-29765", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "keyword": "MUST" + }, + { + "id": "R-85235", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "keyword": "MUST" + }, + { + "id": "R-78380", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is\ndefined as a ``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST" + }, + { + "id": "R-34037", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n**MUST** be declared as either type ``string`` or type\n``comma_delimited_list``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_flavor_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_neutron_port_network_attachment", + "test_case": "test_internal_network_parameters", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-86182", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port``\nis in an incremental module and\nis attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nthe ``network`` parameter name **MUST**\n\n * follow the naming convention ``int_{network-role}_net_id`` if the\n network UUID value is used to reference the network\n * follow the naming convention ``int_{network-role}_net_name`` if the\n network name in is used to reference the network.\n\nwhere ``{network-role}`` is the network-role of the internal network and\na ``get_param`` **MUST** be used as the intrinsic function.", + "keyword": "MUST" + }, + { + "id": "R-22688", + "text": "When a VNF's Heat Orchestration Template creates an internal network\n(per the ONAP definition, see Requirements R-52425 and R-46461\nand R-35666) and the internal network needs to be shared between modules\nwithin a VNF, the internal network **MUST** be created either in the\n\n* the base module\n* a nested YAML file invoked by the base module\n\nand the base module **MUST** contain an output parameter that provides\neither the network UUID or network name.\n\n* If the network UUID value is used to reference the network, the output\n parameter name in the base module **MUST** follow the naming convention\n ``int_{network-role}_net_id``\n* If the network name in is used to reference the network, the output\n parameter name in the base template **MUST** follow the naming convention\n ``int_{network-role}_net_name``\n\n``{network-role}`` **MUST** be the network-role of the internal network\ncreated in the Base Module.\n\nThe Base Module Output Parameter MUST be declared in the ``parameters:``\nsection of the Incremental Module(s) where the ``OS::Neutron::Port``\nresource(s) is attaching to the internal network.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_vnf_id_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_neutron_port_fixed_ips_subnet", + "test_case": "test_internal_subnet_format", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-38236", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n**MUST** be declared type ``string``.", + "keyword": "MUST" + }, + { + "id": "R-84123", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "keyword": "MUST" + }, + { + "id": "R-76160", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see Requirements\n R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_vf_module_id_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_ip_parameters_start_at_0", + "test_case": "test_ips_start_at_0", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-71577", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST" + }, + { + "id": "R-40971", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_vnf_name_parameter_name_doesnt_change_in_nested_template", - "result": "PASS", + "test_module": "test_multipart_mime_resource_id", + "test_case": "test_multipart_mime", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-30804", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::Heat::MultipartMime``\nResource ID\n**MUST**\ncontain the ``{vm-type}``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_vf_module_name_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_nested_parameter_args", + "test_case": "test_nested_parameter_args", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", - "keyword": "MUST" + "id": "R-10834", + "text": "A VNF's Heat Orchestration Template resource attribute ``property:``\n**MUST NOT** use more than two levels of nested ``get_param`` intrinsic\nfunctions when deriving a property value. SDC does not support nested\n``get_param`` with recursive lists (i.e., a list inside list).\nThe second ``get_param`` in a nested lookup must directly derive its value\nwithout further calls to ``get_param`` functions.\n\n* Example of valid nesting:\n\n * ``name: {get_param: [ {vm-type}_names, {get_param : index } ] }``\n\n* Examples of invalid nesting. SDC will not support these examples since\n there is an array inside array.\n\n * ``name: {get_param: [ {vm-type}_names, { get_param: [ indexlist, 0 ] } ] }``\n * ``name: {get_param: [ {vm-type}_names, { get_param: [ indexlist1, { get_param: indexlist2 } ] } ] }``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_vm_role_parameter_name_doesnt_change_in_nested_template", - "result": "PASS", + "test_module": "test_nested_template_parameters", + "test_case": "test_nested_template_parameters", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-11041", + "text": "All parameters defined in a VNFs Nested YAML file\n**MUST** be passed in as properties of the resource calling\nthe nested yaml file.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_vf_module_index_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_nesting_level", + "test_case": "test_nesting_level", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-60011", + "text": "A VNF's Heat Orchestration Template **MUST** have no more than two\nlevels of nesting.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_workload_context_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_nesting_nova_server", + "test_case": "test_nesting_nova_server", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-17528", + "text": "A VNF's Heat Orchestration Template's first level Nested YAML file\n**MUST NOT** contain more than one ``OS::Nova::Server`` resource.\nA VNF's Heat Orchestration Template's second level Nested YAML file\n**MUST NOT** contain an ``OS::Nova::Server`` resource.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_environment_context_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_network_format", + "test_case": "test_network_has_subnet", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-16241", + "text": "A VNF's internal network **MUST** have one subnet.\nA VNF's internal network **MAY** have more than one subnet.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_port_network_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_network_format", + "test_case": "test_network_resource_id_format", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", - "keyword": "MUST" + "id": "R-16968", + "text": "A VNF's Heat Orchestration Templates **MUST NOT** include heat\nresources to create external networks.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_port_fip_ip_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_internal_networks", + "test_case": "test_networks_exist_for_internal_network_params", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-35666", + "text": "If a VNF has an internal network, the VNF Heat Orchestration Template\n**MUST** include the heat resources to create the internal network.\n\nA VNF's Internal Network is created using Neutron Heat Resources\n(i.e., ``OS::Neutron::Net``, ``OS::Neutron::Subnet``) and/or\nContrail Heat Resources (i.e., ``OS::ContrailV2::VirtualNetwork``,\n``ContrailV2::NetworkIpam``).", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_port_fip_subnet_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_forbidden_resources", + "test_case": "test_neutron_floating_ip_association_resource_type", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", - "keyword": "MUST" + "id": "R-76449", + "text": "A VNF's Heat Orchestration Template's **MUST NOT**\ncontain the Resource ``OS::Neutron::FloatingIPAssociation``.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_port_aap_ip_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_forbidden_resources", + "test_case": "test_neutron_floating_ip_resource_type", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", - "keyword": "MUST" + "id": "R-05257", + "text": "A VNF's Heat Orchestration Template's **MUST NOT**\ncontain the Resource ``OS::Neutron::FloatingIP``.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_vmi_net_ref_parameter_name_doesnt_change_in_nested_template", - "result": "PASS", + "test_module": "test_contrail_vn_resource_id", + "test_case": "test_neutron_net_resource_id", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-99110", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualNetwork`` Resource ID **MUST** use the naming\nconvention\n\n* ``int_{network-role}_network``\n\nVNF Heat Orchestration Templates can only create internal networks.\nThere is no ``{index}`` after ``{network-role}`` because ``{network-role}``\n**MUST** be unique in the scope of the VNF's\nHeat Orchestration Template.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_vmi_aap_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_neutron_net_resource_id", + "test_case": "test_neutron_net_resource_id", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-25720", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Net``\nResource ID **MUST** use the naming convention\n\n* ``int_{network-role}_network``\n\nVNF Heat Orchestration Templates can only create internal networks.\nThere is no ``{index}`` after ``{network-role}`` because ``{network-role}``\n**MUST** be unique in the scope of the VNF's\nHeat Orchestration Template.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_iip_instance_ip_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_neutron_port_fixed_ips_subnet", + "test_case": "test_neutron_port_internal_fixed_ips_subnet_in_base", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-84123", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", "keyword": "MUST" - } - ] - }, - { - "files": [ - "base_vfw.yaml" - ], - "test_module": "test_nested_template_parameters", - "test_case": "test_nested_template_parameters", - "result": "SKIP", - "error": "", - "requirements": [ + }, { - "id": "R-11041", - "text": "All parameters defined in a VNFs Nested YAML file\n**MUST** be passed in as properties of the resource calling\nthe nested yaml file.", + "id": "R-76160", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see Requirements\n R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nesting_level", - "test_case": "test_nesting_level", + "test_module": "test_environment_file_parameters", + "test_case": "test_neutron_port_internal_fixedips_ipaddress_parameter_exists_in_environment_file", "result": "PASS", "error": "", "requirements": [ { - "id": "R-60011", - "text": "A VNF's Heat Orchestration Template **MUST** have no more than two\nlevels of nesting.", + "id": "R-28795", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-97201", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_v6_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-93496", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``fixed_ips``\nmap property ``ip_address``\nparameter associated with an internal network, i.e.,\n\n * ``{vm-type}_int_{network-role}_ip_{index}``\n * ``{vm-type}_int_{network-role}_v6_ip_{index}``\n * ``{vm-type}_int_{network-role}_ips``\n * ``{vm-type}_int_{network-role}_v6_ips``\n\n\n**MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and IP addresses **MUST** be\nassigned.", + "keyword": "MUST" + }, + { + "id": "R-90206", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_int_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-98569", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_v6_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-93496", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``fixed_ips``\nmap property ``ip_address``\nparameter associated with an internal network, i.e.,\n\n * ``{vm-type}_int_{network-role}_ip_{index}``\n * ``{vm-type}_int_{network-role}_v6_ip_{index}``\n * ``{vm-type}_int_{network-role}_ips``\n * ``{vm-type}_int_{network-role}_v6_ips``\n\n\n**MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and IP addresses **MUST** be\nassigned.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nesting_nova_server", - "test_case": "test_nesting_nova_server", + "test_module": "test_neutron_port_network_parameter", + "test_case": "test_neutron_port_network_param_is_string", "result": "PASS", "error": "", "requirements": [ { - "id": "R-17528", - "text": "A VNF's Heat Orchestration Template's first level Nested YAML file\n**MUST NOT** contain more than one ``OS::Nova::Server`` resource.\nA VNF's Heat Orchestration Template's second level Nested YAML file\n**MUST NOT** contain an ``OS::Nova::Server`` resource.", + "id": "R-18008", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``network`` parameter **MUST** be declared as type: ``string``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_network_format", - "test_case": "test_network_resource_id_format", + "test_module": "test_no_http_resources", + "test_case": "test_no_http_resources", "result": "PASS", "error": "", "requirements": [ { - "id": "R-16968", - "text": "A VNF's Heat Orchestration Templates **MUST NOT** include heat\nresources to create external networks.", + "id": "R-71699", + "text": "A VNF's Heat Orchestration Template's Resource\n**MUST NOT** reference a HTTP-based Nested YAML file.", "keyword": "MUST NOT" }, { - "id": "R-35666", - "text": "If a VNF has an internal network, the VNF Heat Orchestration Template\n**MUST** include the heat resources to create the internal network.", - "keyword": "MUST" + "id": "R-53952", + "text": "A VNF's Heat Orchestration Template's Resource\n**MUST NOT** reference a HTTP-based resource definitions.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/template" ], - "test_module": "test_network_format", - "test_case": "test_network_has_subnet", + "test_module": "test_no_image_files", + "test_case": "test_no_image_files_included", "result": "PASS", "error": "", "requirements": [ { - "id": "R-16241", - "text": "A VNF's internal network **MUST** have one subnet.\nA VNF's internal network **MAY** have more than one subnet.", + "id": "R-348813", + "text": "The VNF's Heat Orchestration Template's ZIP file **MUST NOT** include\na binary image file.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_neutron_net_resource_id", - "test_case": "test_neutron_net_resource_id", - "result": "PASS", - "error": "", + "test_module": "test_non_server_name", + "test_case": "test_non_server_name", + "result": "FAIL", + "error": " Improper name property for non-OS::Nova::Server resources. int_unprotected_private_network's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}. int_unprotected_private_subnet's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}. int_protected_private_network's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}. int_protected_private_subnet's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}\n", "requirements": [ { - "id": "R-25720", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Net``\nResource ID **MUST** use the naming convention\n\n* ``int_{network-role}_network``\n\nVNF Heat Orchestration Templates can only create internal networks.\nThere is no ``{index}`` after ``{network-role}`` because ``{network-role}``\n**MUST** be unique in the scope of the VNF's\nHeat Orchestration Template.", + "id": "R-85734", + "text": "If a VNF's Heat Orchestration Template contains the property ``name``\nfor a non ``OS::Nova::Server`` resource, the intrinsic function\n``str_replace`` **MUST** be used in conjunction with the ONAP\nsupplied metadata parameter ``vnf_name`` to generate a unique value.\nAdditional data **MAY** be used in the ``str_replace`` construct\nto generate a unique value.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_neutron_port_addresses", - "test_case": "test_neutron_port_external_ipaddress", + "test_module": "test_non_server_name", + "test_case": "test_non_server_name_unique", "result": "PASS", "error": "", "requirements": [ { - "id": "R-91810", - "text": "If a VNF requires ONAP to assign a Virtual IP (VIP) Address to\nports connected an external network, the port\n**MUST NOT** have more than one IPv4 VIP address.", - "keyword": "MUST NOT" + "id": "R-85734", + "text": "If a VNF's Heat Orchestration Template contains the property ``name``\nfor a non ``OS::Nova::Server`` resource, the intrinsic function\n``str_replace`` **MUST** be used in conjunction with the ONAP\nsupplied metadata parameter ``vnf_name`` to generate a unique value.\nAdditional data **MAY** be used in the ``str_replace`` construct\nto generate a unique value.", + "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_neutron_port_addresses", - "test_case": "test_neutron_port_external_ipaddress_v6", + "test_module": "test_nova_servers_vm_types", + "test_case": "test_nova_server_flavor_parameter", "result": "PASS", "error": "", "requirements": [ { - "id": "R-41956", - "text": "If a VNF requires ONAP to assign a Virtual IP (VIP) Address to\nports connected an external network, the port\n**MUST NOT** have more than one IPv6 VIP address.", - "keyword": "MUST NOT" + "id": "R-50436", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``flavor`` parameter **MUST** be declared as type: ``string``.", + "keyword": "MUST" + }, + { + "id": "R-45188", + "text": "The VNF's Heat Orchestration Template's Resource 'OS::Nova::Server' property\n``flavor`` parameter name **MUST** follow the naming convention\n``{vm-type}_flavor_name``.", + "keyword": "MUST" + }, + { + "id": "R-40499", + "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``flavor`` even if more than one ``{vm-type}`` shares the same flavor.", + "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_neutron_port_addresses", - "test_case": "test_neutron_port_floating", + "test_module": "test_environment_file_parameters", + "test_case": "test_nova_server_flavor_parameter_exists_in_environment_file", "result": "PASS", "error": "", "requirements": [ { - "id": "R-10754", - "text": "If a VNF has two or more ports that\nattach to an external network that require a Virtual IP Address (VIP),\nand the VNF requires ONAP automation to assign the IP address,\nall the Virtual Machines using the VIP address **MUST**\nbe instantiated in the same Base Module Heat Orchestration Template\nor in the same Incremental Module Heat Orchestration Template.", + "id": "R-69431", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``flavor`` parameter **MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and a value **MUST** be assigned.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_neutron_port_fixed_ips_subnet", - "test_case": "test_internal_subnet_format", + "test_module": "test_nova_servers_vm_types", + "test_case": "test_nova_server_image_parameter", "result": "PASS", "error": "", "requirements": [ { - "id": "R-38236", - "text": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n**MUST** be declared type ``string``.", + "id": "R-71152", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``image`` parameter **MUST** be declared as type: ``string``.", "keyword": "MUST" }, { - "id": "R-84123", - "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "id": "R-57282", + "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``image`` even if more than one ``{vm-type}`` shares the same image.", "keyword": "MUST" }, { - "id": "R-76160", - "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see Requirements\n R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "id": "R-58670", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``image`` parameter name **MUST** follow the naming convention\n``{vm-type}_image_name``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_neutron_port_fixed_ips_subnet", - "test_case": "test_external_subnet_format", + "test_module": "test_environment_file_parameters", + "test_case": "test_nova_server_image_parameter_exists_in_environment_file", "result": "PASS", "error": "", "requirements": [ { - "id": "R-38236", - "text": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n**MUST** be declared type ``string``.", - "keyword": "MUST" - }, - { - "id": "R-62802", - "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` is attaching\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv4 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv4 subnet is to be specified\nusing the property ``fixed_ips``\nmap property ``subnet``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", - "keyword": "MUST" - }, - { - "id": "R-15287", - "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` is attaching\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv6 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv6 subnet is to be specified\nusing the property ``fixed_ips``\nmap property ``subnet``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_v6_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", + "id": "R-91125", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``image`` parameter **MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and a value **MUST** be assigned.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_neutron_port_fixed_ips_subnet", - "test_case": "test_neutron_port_internal_fixed_ips_subnet_in_base", + "test_module": "test_nova_servers_vm_types", + "test_case": "test_nova_server_name_parameter", "result": "PASS", "error": "", "requirements": [ { - "id": "R-84123", - "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "id": "R-51430", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``name`` parameter **MUST** be declared as either type ``string``\nor type ``comma_delimited_list``.", "keyword": "MUST" }, { - "id": "R-76160", - "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see Requirements\n R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", - "keyword": "MUST" - } - ] - }, - { - "files": [ - "base_vfw.yaml" - ], - "test_module": "test_neutron_port_network_attachment", - "test_case": "test_internal_network_parameters", - "result": "PASS", - "error": "", - "requirements": [ - { - "id": "R-86182", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand the internal network is created in a\ndifferent Heat Orchestration Template than the ``OS::Neutron::Port``,\nthe ``network`` parameter name **MUST**\n\n * follow the naming convention ``int_{network-role}_net_id`` if the Neutron\n network UUID value is used to reference the network\n * follow the naming convention ``int_{network-role}_net_name`` if the\n OpenStack network name in is used to reference the network.\n\nwhere ``{network-role}`` is the network-role of the internal network and\na ``get_param`` **MUST** be used as the intrinsic function.", + "id": "R-54171", + "text": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``string``,\nthe parameter name **MUST** follow the naming convention\n\n* ``{vm-type}_name_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at\nzero in a VNF's Heat Orchestration Template and **MUST** increment by one.", "keyword": "MUST" }, { - "id": "R-22688", - "text": "If a VNF's port is connected to an internal network and the port is\ncreated in an Incremental Module and the internal network is created\nin the Base Module then the UUID of the internal network **MUST** be\nexposed as a parameter in the ``outputs:`` section of the Base Module\nand the port resource **MUST** use a ``get_param`` to obtain the network\nUUID.", + "id": "R-87817", + "text": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``comma_delimited_list``,\nthe parameter name **MUST** follow the naming convention\n``{vm-type}_names``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_neutron_port_network_attachment", - "test_case": "test_external_network_parameter", + "test_module": "test_nova_server_name_parameters_start_at_0", + "test_case": "test_nova_server_name_parameter_starts_at", "result": "PASS", "error": "", "requirements": [ { - "id": "R-62983", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424), the\n``network`` parameter name **MUST**\n\n * follow the naming convention ``{network-role}_net_id`` if the Neutron\n network UUID value is used to reference the network\n * follow the naming convention ``{network-role}_net_name`` if the\n OpenStack network name is used to reference the network.\n\nwhere ``{network-role}`` is the network-role of the external network\nand a ``get_param`` **MUST** be used as the intrinsic function.", + "id": "R-54171", + "text": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``string``,\nthe parameter name **MUST** follow the naming convention\n\n* ``{vm-type}_name_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at\nzero in a VNF's Heat Orchestration Template and **MUST** increment by one.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_neutron_port_network_parameter", - "test_case": "test_neutron_port_network_param_is_string", + "test_module": "test_nova_server_resource_id", + "test_case": "test_nova_server_resource_id", "result": "PASS", "error": "", "requirements": [ { - "id": "R-18008", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``network`` parameter **MUST** be declared as type: ``string``.", + "id": "R-29751", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nResource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_server_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` is the index.\n The ``{index}`` **MUST** starts at zero and increment by one\n as described in R-11690.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_no_http_resources", - "test_case": "test_no_http_resources", + "test_module": "test_nova_servers_resource_ids", + "test_case": "test_nova_servers_valid_resource_ids", "result": "PASS", "error": "", "requirements": [ { - "id": "R-71699", - "text": "A VNF's Heat Orchestration Template's Resource\n**MUST NOT** reference a HTTP-based Nested YAML file.", - "keyword": "MUST NOT" + "id": "R-40499", + "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``flavor`` even if more than one ``{vm-type}`` shares the same flavor.", + "keyword": "MUST" }, { - "id": "R-53952", - "text": "A VNF's Heat Orchestration Template's Resource\n**MUST NOT** reference a HTTP-based resource definitions.", - "keyword": "MUST NOT" + "id": "R-57282", + "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``image`` even if more than one ``{vm-type}`` shares the same image.", + "keyword": "MUST" } ] }, { "files": [ - "." + "../vvp/base_vfw.yaml" ], - "test_module": "test_no_image_files", - "test_case": "test_no_image_files_included", + "test_module": "test_oam_address_outputs", + "test_case": "test_oam_address_v4_zero_or_one", "result": "PASS", "error": "", "requirements": [ { - "id": "R-348813", - "text": "The VNF's Heat Orchestration Template's ZIP file **MUST NOT** include\na binary image file.", + "id": "R-18683", + "text": "If a VNF has one IPv4 OAM Management IP Address and the\nIP Address needs to be inventoried in ONAP's A&AI\ndatabase, an output parameter **MUST** be declared in only one of the\nVNF's Heat Orchestration Templates and the parameter **MUST** be named\n``oam_management_v4_address``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_non_server_name", - "test_case": "test_non_server_name", - "result": "FAIL", - "error": " Improper name property for non-OS::Nova::Server resources. int_unprotected_private_network's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}. int_unprotected_private_subnet's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}. int_protected_private_network's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}. int_protected_private_subnet's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}\n", + "test_module": "test_oam_address_outputs", + "test_case": "test_oam_address_v6_zero_or_one", + "result": "PASS", + "error": "", "requirements": [ { - "id": "R-85734", - "text": "If a VNF's Heat Orchestration Template contains the property ``name``\nfor a non ``OS::Nova::Server`` resource, the intrinsic function\n``str_replace`` **MUST** be used in conjunction with the ONAP\nsupplied metadata parameter ``vnf_name`` to generate a unique value.\nAdditional data **MAY** be used in the ``str_replace`` construct\nto generate a unique value.", + "id": "R-94669", + "text": "If a VNF has one IPv6 OAM Management IP Address and the\nIP Address needs to be inventoried in ONAP's A&AI\ndatabase, an output parameter **MUST** be declared in only one of the\nVNF's Heat Orchestration Templates and the parameter **MUST** be named\n``oam_management_v6_address``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_non_server_name", - "test_case": "test_non_server_name_unique", + "test_module": "test_heat_parameter_section", + "test_case": "test_parameter_names", "result": "PASS", "error": "", "requirements": [ { - "id": "R-85734", - "text": "If a VNF's Heat Orchestration Template contains the property ``name``\nfor a non ``OS::Nova::Server`` resource, the intrinsic function\n``str_replace`` **MUST** be used in conjunction with the ONAP\nsupplied metadata parameter ``vnf_name`` to generate a unique value.\nAdditional data **MAY** be used in the ``str_replace`` construct\nto generate a unique value.", + "id": "R-25877", + "text": "A VNF's Heat Orchestration Template's parameter name\n(i.e., <param name>) **MUST** contain only alphanumeric\ncharacters and underscores ('_').", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nova_server_name_parameters_start_at_0", - "test_case": "test_nova_server_name_parameter_starts_at", + "test_module": "test_heat_template_structure", + "test_case": "test_parameter_type", "result": "PASS", "error": "", "requirements": [ { - "id": "R-54171", - "text": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``string``,\nthe parameter name **MUST** follow the naming convention\n\n* ``{vm-type}_name_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at\nzero in a VNF's Heat Orchestration Template and **MUST** increment by one.", + "id": "R-11441", + "text": "A VNF's Heat Orchestration Template's parameter type **MUST** be one of\nthe following values:\n\n* ``string``\n* ``number``\n* ``json``\n* ``comma_delimited_list``\n* ``boolean``", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nova_server_resource_id", - "test_case": "test_nova_server_resource_id", + "test_module": "test_nested_parameters", + "test_case": "test_port_aap_ip_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-29751", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` Resource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_server_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` is the index", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nova_servers_environment_context", - "test_case": "test_environment_context", + "test_module": "test_port_connected_to_multiple_servers", + "test_case": "test_port_connected_to_multiple_servers", "result": "PASS", "error": "", "requirements": [ { - "id": "R-20308", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``environment_context``\nparameter **MUST** be declared as ``environment_context`` and the\nparameter type **MUST** be defined as type: ``string``.", + "id": "R-92635", + "text": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nova_servers_resource_ids", - "test_case": "test_nova_servers_valid_resource_ids", + "test_module": "test_nested_parameters", + "test_case": "test_port_fip_ip_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-40499", - "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``flavor`` even if more than one ``{vm-type}`` shares the same flavor.", - "keyword": "MUST" - }, - { - "id": "R-57282", - "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``image`` even if more than one ``{vm-type}`` shares the same image.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nova_servers_vm_types", - "test_case": "test_vm_type_consistent_on_nova_servers", + "test_module": "test_nested_parameters", + "test_case": "test_port_fip_subnet_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-57282", - "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``image`` even if more than one ``{vm-type}`` shares the same image.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nova_servers_vm_types", - "test_case": "test_vm_type_network_role_collision", + "test_module": "test_nested_parameters", + "test_case": "test_port_network_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-48067", - "text": "A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST NOT** be a\nsubstring\nof ``{network-role}``.", - "keyword": "MUST NOT" - }, - { - "id": "R-00977", - "text": "A VNF's Heat Orchestration Template's ``{network-role}``\n**MUST NOT** be a substring of ``{vm-type}``.", + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nova_servers_vm_types", - "test_case": "test_nova_server_flavor_parameter", + "test_module": "test_port_resource_ids", + "test_case": "test_port_resource_ids", "result": "PASS", "error": "", "requirements": [ { - "id": "R-50436", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``flavor`` parameter **MUST** be declared as type: ``string``.", + "id": "R-20453", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an external network Resource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port_index}`` references the instance of the port on the ``{vm-type}``\n attached to ``{network-role}`` network. The\n ``{port_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new port is defined on the instance of the ``{vm-type}`` attached to\n ``{network-role}`` network.", "keyword": "MUST" }, { - "id": "R-45188", - "text": "The VNF's Heat Orchestration Template's Resource 'OS::Nova::Server' property\n``flavor`` parameter name **MUST** follow the naming convention\n``{vm-type}_flavor_name``.", + "id": "R-26351", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an internal network Resource ID **MUST**\nuse the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port_index}`` references the instance of the port on the ``{vm-type}``\n attached to ``{network-role}`` network. The\n ``{port_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new port is defined on the instance of the ``{vm-type}`` attached to\n ``{network-role}`` network.", "keyword": "MUST" }, { - "id": "R-40499", - "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``flavor`` even if more than one ``{vm-type}`` shares the same flavor.", + "id": "R-26506", + "text": "A VNF's Heat Orchestration Template's ``{network-role}`` **MUST** contain\nonly alphanumeric characters and/or underscores '_' and\n\n* **MUST NOT** contain any of the following strings: ``_int`` or ``int_``\n or ``_int_``\n* **MUST NOT** end in the string: ``_v6``\n* **MUST NOT** contain the strings ``_#_``, where ``#`` is a number\n* **MUST NOT** end in the string: ``_#``, where ``#`` is a number", + "keyword": "MUST NOT" + }, + { + "id": "R-681859", + "text": "A VNF's Heat Orchestration Template's ``OS::Neutron::Port`` resource's\n\n* Resource ID (defined in R-20453)\n* property ``network`` parameter name (defined in R-62983 and\n R-86182)\n* property ``fixed_ips``, map property ``ip_address`` parameter name\n (defined in R-40971, R-04697, R-71577, R-23503, R-78380, R-85235,\n R-27818, and R-29765)\n* property ``fixed_ips``, map property ``subnet`` parameter name\n (defined in R-62802, R-15287, R-84123, R-76160)\n* property ``allowed_address_pairs`` parameter name (defined in\n R-41492 and R-83418)\n\n**MUST** contain the identical ``{network-role}``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nova_servers_vm_types", - "test_case": "test_nova_server_name_parameter", + "test_module": "test_server_and_port_vm_indices_match", + "test_case": "test_server_and_port_vmtype_indices_match", "result": "PASS", "error": "", "requirements": [ { - "id": "R-51430", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``name`` parameter **MUST** be declared as either type ``string``\nor type ``comma_delimited_list``.", - "keyword": "MUST" - }, - { - "id": "R-54171", - "text": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``string``,\nthe parameter name **MUST** follow the naming convention\n\n* ``{vm-type}_name_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at\nzero in a VNF's Heat Orchestration Template and **MUST** increment by one.", - "keyword": "MUST" - }, - { - "id": "R-87817", - "text": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``comma_delimited_list``,\nthe parameter name **MUST** follow the naming convention\n``{vm-type}_names``.", + "id": "R-304011", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's\n\n* Resource ID (defined in R-29751)\n* property ``image`` parameter name (defined in R-58670)\n* property ``flavor`` parameter name (defined in R-45188)\n* property ``name`` parameter name (defined in R-54171 & R-87817)\n* property ``networks`` map property ``port`` value which is a\n ``OS::Neutron::Port`` Resource ID (defined in R-20453)\n referenced using the intrinsic function ``get_attr``\n\n**MUST** contain the identical ``{vm-type}``\nand **MUST** follow the naming conventions defined\nin R-58670, R-45188, R-54171, R-87817, and R-29751. And the ``{index}`` in\nthe ``OS::Nova::Server`` Resource ID (defined in R-29751) **MUST** match\nthe ``{vm-type_index}`` defined in\nthe ``OS::Nova::Server`` property ``networks`` map property ``port``\nreferenced ``OS::Neutron::Port`` Resource ID (defined in R-20453).", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nova_servers_vm_types", - "test_case": "test_nova_server_image_parameter", + "test_module": "test_nested_parameters", + "test_case": "test_server_flavor_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-71152", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``image`` parameter **MUST** be declared as type: ``string``.", - "keyword": "MUST" - }, - { - "id": "R-57282", - "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``image`` even if more than one ``{vm-type}`` shares the same image.", - "keyword": "MUST" - }, - { - "id": "R-58670", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``image`` parameter name **MUST** follow the naming convention\n``{vm-type}_image_name``.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nova_servers_vm_types_use_get_param", - "test_case": "test_vm_type_assignments_on_nova_servers_only_use_get_param", + "test_module": "test_nested_parameters", + "test_case": "test_server_image_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-901331", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``image`` value **MUST** be be obtained via a ``get_param``.", - "keyword": "MUST" - }, - { - "id": "R-481670", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``flavor`` value **MUST** be be obtained via a ``get_param``.", - "keyword": "MUST" - }, - { - "id": "R-663631", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` value **MUST** be be obtained via a ``get_param``.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_nova_servers_workload_context", - "test_case": "test_workload_context", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_environment_context_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-74978", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``workload_context``\nparameter **MUST**\nbe declared as ``workload_context`` and the parameter **MUST**\nbe defined as type: ``string``.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_oam_address_outputs", - "test_case": "test_oam_address_v4_zero_or_one", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_vf_module_id_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-18683", - "text": "If a VNF has one IPv4 OAM Management IP Address and the\nIP Address needs to be inventoried in ONAP's A&AI\ndatabase, an output parameter **MUST** be declared in only one of the\nVNF's Heat Orchestration Templates and the parameter **MUST** be named\n``oam_management_v4_address``.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_oam_address_outputs", - "test_case": "test_oam_address_v6_zero_or_one", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_vf_module_index_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-94669", - "text": "If a VNF has one IPv6 OAM Management IP Address and the\nIP Address needs to be inventoried in ONAP's A&AI\ndatabase, an output parameter **MUST** be declared in only one of the\nVNF's Heat Orchestration Templates and the parameter **MUST** be named\n``oam_management_v6_address``.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_port_connected_to_multiple_servers", - "test_case": "test_port_connected_to_multiple_servers", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_vf_module_name_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-92635", - "text": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_port_resource_ids", - "test_case": "test_port_resource_ids", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_vm_role_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-20453", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an external network Resource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port-index}`` is the instance of the port on the vm-type\n attached to the network of ``{network-role}``", - "keyword": "MUST" - }, - { - "id": "R-26351", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an internal network Resource ID **MUST**\nuse the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port-index}`` is the instance of the port on the vm-type\n attached to the network of ``{network-role}``", - "keyword": "MUST" - }, - { - "id": "R-26506", - "text": "A VNF's Heat Orchestration Template's ``{network-role}`` **MUST** contain\nonly alphanumeric characters and/or underscores '_' and\n**MUST NOT** contain any of the following strings:\n``_int`` or ``int_`` or ``_int_``.", - "keyword": "MUST" - }, - { - "id": "R-681859", - "text": "A VNF's Heat Orchestration Template's ``OS::Neutron::Port`` resource's\n\n* Resource ID (defined in R-20453)\n* property ``network`` parameter name (defined in R-62983 and\n R-86182)\n* property ``fixed_ips``, map property ``ip_address`` parameter name\n (defined in R-40971, R-04697, R-71577, R-23503, R-78380, R-85235,\n R-27818, and R-29765)\n* property ``fixed_ips``, map property ``subnet`` parameter name\n (defined in R-62802, R-15287, R-84123, R-76160)\n* property ``allowed_address_pairs`` parameter name (defined in\n R-41492 and R-83418)\n\n**MUST** contain the identical ``{network-role}``.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_vnf_id_parameter_has_no_constraints", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_vnf_id_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-55218", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property\n``metadata`` key/value pair ``vnf_id`` parameter ``vnf_id`` **MUST NOT**\nhave parameter constraints defined.", + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_vf_module_id_parameter_has_no_constraints", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_vnf_name_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-98374", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` key/value pair ``vf_module_id`` parameter ``vf_module_id``\n**MUST NOT**\nhave parameter constraints defined.", + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_vnf_name_parameter_has_no_constraints", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_workload_context_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-44318", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vnf_name``\nparameter ``vnf_name`` **MUST NOT**\nhave parameter constraints defined.", + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_workload_context_parameter_has_no_constraints", - "result": "SKIP", + "test_module": "test_nested_parameters", + "test_case": "test_server_name_parameter_name_doesnt_change_in_nested_template", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-34055", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``workload_context``\nparameter ``workload_context`` **MUST NOT**\nhave parameter constraints defined.", + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_environment_context_parameter_has_no_constraints", - "result": "SKIP", + "test_module": "test_servers_have_required_metadata", + "test_case": "test_servers_have_required_metadata", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-56183", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata``key/value pair ``environment_context``\nparameter ``environment_context`` **MUST NOT**\nhave parameter constraints defined.", - "keyword": "MUST NOT" + "id": "R-37437", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MUST**\ncontain the key/value pair ``vnf_id``\nand the value **MUST** be obtained via a ``get_param``.", + "keyword": "MUST" + }, + { + "id": "R-71493", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` **MUST**\ncontain the key/value pair ``vf_module_id``\nand the value MUST be obtained via a ``get_param``.", + "keyword": "MUST" + }, + { + "id": "R-72483", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` **MUST** contain the key/value pair ``vnf_name`` and the\nvalue **MUST** be obtained via a ``get_param``.", + "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_vf_module_name_parameter_has_no_constraints", - "result": "SKIP", + "test_module": "test_servers_metadata_use_get_param", + "test_case": "test_servers_vf_module_id_metadata_use_get_param", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-15480", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vf_module_name`` parameter ``vf_module_name``\n**MUST NOT** have parameter constraints defined.", - "keyword": "MUST NOT" + "id": "R-71493", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` **MUST**\ncontain the key/value pair ``vf_module_id``\nand the value MUST be obtained via a ``get_param``.", + "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_vm_role_parameter_has_no_constraints", - "result": "SKIP", + "test_module": "test_servers_metadata_use_get_param", + "test_case": "test_servers_vf_module_index_metadata_use_get_param", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-67597", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` parameter ``vm_role``\n**MUST NOT** have parameter constraints defined.", - "keyword": "MUST NOT" + "id": "R-50816", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata``\nkey/value pair ``vf_module_index``\nvalue **MUST** be obtained via a ``get_param``.", + "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_vf_module_index_parameter_has_no_constraints", - "result": "SKIP", + "test_module": "test_servers_metadata_use_get_param", + "test_case": "test_servers_vf_module_name_metadata_use_get_param", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-09811", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vf_module_index`` **MUST NOT**\nhave parameter constraints defined.", - "keyword": "MUST NOT" + "id": "R-68023", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vf_module_name``\nvalue **MUST**\nbe obtained via a ``get_param``.", + "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_resource_ids_alphanumeric_only", - "test_case": "test_alphanumeric_resource_ids_only", + "test_module": "test_servers_metadata_use_get_param", + "test_case": "test_servers_vnf_id_metadata_use_get_param", "result": "PASS", "error": "", "requirements": [ { - "id": "R-75141", - "text": "A VNF's Heat Orchestration Template's resource name\n(i.e., <resource ID>) **MUST** only contain alphanumeric\ncharacters and underscores ('_').", + "id": "R-37437", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MUST**\ncontain the key/value pair ``vnf_id``\nand the value **MUST** be obtained via a ``get_param``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_resource_indices", - "test_case": "test_indices_start_at_0_increment", + "test_module": "test_servers_metadata_use_get_param", + "test_case": "test_servers_vnf_name_metadata_use_get_param", "result": "PASS", "error": "", "requirements": [ { - "id": "R-11690", - "text": "When a VNF's Heat Orchestration Template's Resource ID contains an\n``{index}``, the ``{index}`` is a numeric value that **MUST** start at\nzero and **MUST** increment by one.\n\nAs stated in R-16447,\n*a VNF's <resource ID> MUST be unique across all Heat\nOrchestration Templates and all HEAT Orchestration Template\nNested YAML files that are used to create the VNF*. While the ``{index}``\nwill start at zero in the VNF, the ``{index}`` may not start at zero\nin a given Heat Orchestration Template or HEAT Orchestration Template\nNested YAML file.", + "id": "R-72483", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` **MUST** contain the key/value pair ``vnf_name`` and the\nvalue **MUST** be obtained via a ``get_param``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_server_and_port_vm_indices_match", - "test_case": "test_server_and_port_vmtype_indices_match", - "result": "PASS", + "test_module": "test_software_config_resource_id", + "test_case": "test_software_config_vm_type", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-304011", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's\n\n* Resource ID (defined in R-29751)\n* property ``image`` parameter name (defined in R-58670)\n* property ``flavor`` parameter name (defined in R-45188)\n* property ``name`` parameter name (defined in R-54171 & R-87817)\n* property port referenced OS::Neutron::Port Resource ID\n (defined in R-20453)\n\n**MUST** contain the identical ``{vm-type}``\nand **MUST** follow the naming conventions defined\nin R-58670, R-45188, R-54171, R-87817, and R-29751. And the ``{index}`` in\nthe ``OS::Nova::Server`` Resource ID (defined in R-29751) **MUST** match\nthe ``{vm-type_index}`` defined in\nthe ``OS::Nova::Server`` property ``port``\nreferenced ``OS::Neutron::Port`` Resource ID (defined in R-20453).", + "id": "R-08975", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::SoftwareConfig``\nResource ID **MUST** contain the ``{vm-type}``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_server_parameters", - "test_case": "test_availability_zone_parameter_type", + "test_module": "test_unique_resources_across_all_templates", + "test_case": "test_unique_resources_across_all_yaml_files", "result": "PASS", "error": "", "requirements": [ { - "id": "R-23311", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Nova::Server`` property\n``availability_zone`` parameter **MUST** be declared as type: ``string``.", + "id": "R-16447", + "text": "A VNF's <resource ID> **MUST** be unique across all Heat\nOrchestration Templates and all HEAT Orchestration Template\nNested YAML files that are used to create the VNF.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_server_parameters", - "test_case": "test_vnf_id_parameter_type_and_parameter_name", + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_vf_module_id_parameter_has_no_constraints", "result": "PASS", "error": "", "requirements": [ { - "id": "R-07507", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property\n``metadata`` key/value pair ``vnf_id`` parameter\n**MUST** be declared as ``vnf_id`` and the parameter **MUST**\nbe defined as type: ``string``.", - "keyword": "MUST" + "id": "R-98374", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` key/value pair ``vf_module_id`` parameter ``vf_module_id``\n**MUST NOT**\nhave parameter constraints defined.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], "test_module": "test_server_parameters", "test_case": "test_vf_module_id_parameter_type_and_parameter_name", @@ -2245,23 +2425,55 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" + ], + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_vf_module_index_parameter_has_no_constraints", + "result": "SKIP", + "error": "", + "requirements": [ + { + "id": "R-09811", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vf_module_index`` **MUST NOT**\nhave parameter constraints defined.", + "keyword": "MUST NOT" + } + ] + }, + { + "files": [ + "../vvp/base_vfw.yaml" ], "test_module": "test_server_parameters", - "test_case": "test_vnf_name_parameter_type_and_parameter_name", + "test_case": "test_vf_module_index_parameter_type_and_parameter_name", "result": "PASS", "error": "", "requirements": [ { - "id": "R-62428", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vnf_name`` parameter **MUST**\nbe declared as ``vnf_name`` and the parameter **MUST** be defined as\ntype: ``string``.", + "id": "R-54340", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vf_module_index`` parameter **MUST**\nbe declared as ``vf_module_index`` and the parameter **MUST** be\ndefined as type: ``number``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" + ], + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_vf_module_name_parameter_has_no_constraints", + "result": "SKIP", + "error": "", + "requirements": [ + { + "id": "R-15480", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vf_module_name`` parameter ``vf_module_name``\n**MUST NOT** have parameter constraints defined.", + "keyword": "MUST NOT" + } + ] + }, + { + "files": [ + "../vvp/base_vfw.yaml" ], "test_module": "test_server_parameters", "test_case": "test_vf_module_name_parameter_type_and_parameter_name", @@ -2277,285 +2489,306 @@ }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_server_parameters", - "test_case": "test_vf_module_index_parameter_type_and_parameter_name", - "result": "PASS", + "test_module": "test_vm_class_has_unique_type", + "test_case": "test_vm_class_has_unique_type", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-54340", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vf_module_index`` parameter **MUST**\nbe declared as ``vf_module_index`` and the parameter **MUST** be\ndefined as type: ``number``.", + "id": "R-01455", + "text": "When a VNF's Heat Orchestration Template creates a Virtual Machine\n(i.e., ``OS::Nova::Server``),\neach \"class\" of VMs **MUST** be assigned a VNF unique\n``{vm-type}``; where \"class\" defines VMs that\n**MUST** have the following identical characteristics:\n\n 1.) ``OS::Nova::Server`` resource property ``flavor`` value\n\n 2.) ``OS::Nova::Server`` resource property ``image`` value\n\n 3.) Cinder Volume attachments\n\n - Each VM in the \"class\" **MUST** have the identical Cinder Volume\n configuration\n\n 4.) Network attachments and IP address requirements\n\n - Each VM in the \"class\" **MUST** have the identical number of\n ports connecting to the identical networks and requiring the identical\n IP address configuration.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_servers_have_required_metadata", - "test_case": "test_servers_have_required_metadata", - "result": "PASS", + "test_module": "test_vm_role_value", + "test_case": "test_vm_role_from_env_file", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-37437", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MUST**\ncontain the key/value pair ``vnf_id``\nand the value **MUST** be obtained via a ``get_param``.", - "keyword": "MUST" - }, - { - "id": "R-71493", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` **MUST**\ncontain the key/value pair ``vf_module_id``\nand the value MUST be obtained via a ``get_param``.", - "keyword": "MUST" - }, - { - "id": "R-72483", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` **MUST** contain the key/value pair ``vnf_name`` and the\nvalue **MUST** be obtained via a ``get_param``.", + "id": "R-86476", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` value **MUST**\nonly contain alphanumeric characters and underscores (i.e., '_').", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_servers_metadata_use_get_param", - "test_case": "test_servers_vnf_id_metadata_use_get_param", + "test_module": "test_vm_role_value", + "test_case": "test_vm_role_hardcoded", "result": "PASS", "error": "", "requirements": [ { - "id": "R-37437", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MUST**\ncontain the key/value pair ``vnf_id``\nand the value **MUST** be obtained via a ``get_param``.", + "id": "R-86476", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` value **MUST**\nonly contain alphanumeric characters and underscores (i.e., '_').", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_servers_metadata_use_get_param", - "test_case": "test_servers_vf_module_id_metadata_use_get_param", - "result": "PASS", + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_vm_role_parameter_has_no_constraints", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-71493", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` **MUST**\ncontain the key/value pair ``vf_module_id``\nand the value MUST be obtained via a ``get_param``.", - "keyword": "MUST" + "id": "R-67597", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` parameter ``vm_role``\n**MUST NOT** have parameter constraints defined.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_servers_metadata_use_get_param", - "test_case": "test_servers_vnf_name_metadata_use_get_param", + "test_module": "test_nova_servers_vm_types_use_get_param", + "test_case": "test_vm_type_assignments_on_nova_servers_only_use_get_param", "result": "PASS", "error": "", "requirements": [ { - "id": "R-72483", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` **MUST** contain the key/value pair ``vnf_name`` and the\nvalue **MUST** be obtained via a ``get_param``.", + "id": "R-901331", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``image`` value **MUST** be be obtained via a ``get_param``.", + "keyword": "MUST" + }, + { + "id": "R-481670", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``flavor`` value **MUST** be be obtained via a ``get_param``.", + "keyword": "MUST" + }, + { + "id": "R-663631", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` value **MUST** be be obtained via a ``get_param``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_servers_metadata_use_get_param", - "test_case": "test_servers_vf_module_name_metadata_use_get_param", + "test_module": "test_vm_type_case", + "test_case": "test_vm_type_case", "result": "PASS", "error": "", "requirements": [ { - "id": "R-68023", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` **SHOULD**\ncontain the key/value pair ``vf_module_name`` and the value **MUST**\nbe obtained via a ``get_param``.", + "id": "R-32394", + "text": "A VNF's Heat Orchestration Template's use of ``{vm-type}`` in all Resource\nproperty parameter names **MUST** be the same case.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_servers_metadata_use_get_param", - "test_case": "test_servers_vf_module_index_metadata_use_get_param", + "test_module": "test_nova_servers_vm_types", + "test_case": "test_vm_type_consistent_on_nova_servers", "result": "PASS", "error": "", "requirements": [ { - "id": "R-50816", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MAY**\ncontain the key/value pair ``vf_module_index``\nand the value **MUST** be obtained via a ``get_param``.", + "id": "R-57282", + "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``image`` even if more than one ``{vm-type}`` shares the same image.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_software_config_resource_id", - "test_case": "test_software_config_vm_type", - "result": "SKIP", + "test_module": "test_nova_servers_vm_types", + "test_case": "test_vm_type_network_role_collision", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-08975", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::SoftwareConfig``\nResource ID **MUST** contain the ``{vm-type}``.", - "keyword": "MUST" + "id": "R-48067", + "text": "A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST NOT** be a\nsubstring\nof ``{network-role}``.", + "keyword": "MUST NOT" + }, + { + "id": "R-00977", + "text": "A VNF's Heat Orchestration Template's ``{network-role}``\n**MUST NOT** be a substring of ``{vm-type}``.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_unique_name_str_replace_use_req_params", - "test_case": "test_unique_name_str_replace_use_req_params", - "result": "FAIL", - "error": " Resource(int_unprotected_private_network) does not use str_replace and the vnf_name parameter to set the name property, Resource(int_unprotected_private_subnet) does not use str_replace and the vnf_name parameter to set the name property, Resource(int_protected_private_network) does not use str_replace and the vnf_name parameter to set the name property, Resource(int_protected_private_subnet) does not use str_replace and the vnf_name parameter to set the name property\n", + "test_module": "test_vm_type_resource_id", + "test_case": "test_vm_type_resource_id", + "result": "PASS", + "error": "", "requirements": [ { - "id": "R-85734", - "text": "If a VNF's Heat Orchestration Template contains the property ``name``\nfor a non ``OS::Nova::Server`` resource, the intrinsic function\n``str_replace`` **MUST** be used in conjunction with the ONAP\nsupplied metadata parameter ``vnf_name`` to generate a unique value.\nAdditional data **MAY** be used in the ``str_replace`` construct\nto generate a unique value.", + "id": "R-46839", + "text": "A VNF's Heat Orchestration Template's use of ``{vm-type}``\nin all Resource IDs **MUST** be the same case.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_unique_resources_across_all_templates", - "test_case": "test_unique_resources_across_all_yaml_files", + "test_module": "test_vm_type_syntax", + "test_case": "test_vm_type_syntax", "result": "PASS", "error": "", "requirements": [ { - "id": "R-16447", - "text": "A VNF's <resource ID> **MUST** be unique across all Heat\nOrchestration Templates and all HEAT Orchestration Template\nNested YAML files that are used to create the VNF.", - "keyword": "MUST" + "id": "R-98407", + "text": "A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST** contain only\nalphanumeric characters and/or underscores '_' and **MUST NOT**\ncontain any of the following strings:\n``_int`` or ``int_`` or ``_int_``.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_vm_class_has_unique_type", - "test_case": "test_vm_class_has_unique_type", - "result": "SKIP", + "test_module": "test_nested_parameters", + "test_case": "test_vmi_aap_parameter_name_doesnt_change_in_nested_template", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-01455", - "text": "When a VNF's Heat Orchestration Template creates a Virtual Machine\n(i.e., ``OS::Nova::Server``),\neach \"class\" of VMs **MUST** be assigned a VNF unique\n``{vm-type}``; where \"class\" defines VMs that\n**MUST** have the following identical characteristics:\n\n 1.) ``OS::Nova::Server`` resource property ``flavor`` value\n\n 2.) ``OS::Nova::Server`` resource property ``image`` value\n\n 3.) Cinder Volume attachments\n\n - Each VM in the \"class\" **MUST** have the identical Cinder Volume\n configuration\n\n 4.) Network attachments and IP address requirements\n\n - Each VM in the \"class\" **MUST** have the identical number of\n ports connecting to the identical networks and requiring the identical\n IP address configuration.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_vm_role_value", - "test_case": "test_vm_role_hardcoded", + "test_module": "test_nested_parameters", + "test_case": "test_vmi_net_ref_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-86476", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` value **MUST**\nonly contain alphanumeric characters and underscores (i.e., '_').", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_vm_role_value", - "test_case": "test_vm_role_from_env_file", - "result": "SKIP", + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_vnf_id_parameter_has_no_constraints", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-86476", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` value **MUST**\nonly contain alphanumeric characters and underscores (i.e., '_').", - "keyword": "MUST" + "id": "R-55218", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property\n``metadata`` key/value pair ``vnf_id`` parameter ``vnf_id`` **MUST NOT**\nhave parameter constraints defined.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_vm_type_case", - "test_case": "test_vm_type_case", + "test_module": "test_server_parameters", + "test_case": "test_vnf_id_parameter_type_and_parameter_name", "result": "PASS", "error": "", "requirements": [ { - "id": "R-32394", - "text": "A VNF's Heat Orchestration Template's use of ``{vm-type}`` in all Resource\nproperty parameter names **MUST** be the same case.", + "id": "R-07507", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property\n``metadata`` key/value pair ``vnf_id`` parameter\n**MUST** be declared as ``vnf_id`` and the parameter **MUST**\nbe defined as type: ``string``.", "keyword": "MUST" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_vm_type_resource_id", - "test_case": "test_vm_type_resource_id", + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_vnf_name_parameter_has_no_constraints", "result": "PASS", "error": "", "requirements": [ { - "id": "R-46839", - "text": "A VNF's Heat Orchestration Template's use of ``{vm-type}``\nin all Resource IDs **MUST** be the same case.", - "keyword": "MUST" + "id": "R-44318", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vnf_name``\nparameter ``vnf_name`` **MUST NOT**\nhave parameter constraints defined.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vfw.yaml" + "../vvp/base_vfw.yaml" ], - "test_module": "test_vm_type_syntax", - "test_case": "test_vm_type_syntax", + "test_module": "test_server_parameters", + "test_case": "test_vnf_name_parameter_type_and_parameter_name", "result": "PASS", "error": "", "requirements": [ { - "id": "R-98407", - "text": "A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST** contain only\nalphanumeric characters and/or underscores '_' and **MUST NOT**\ncontain any of the following strings:\n``_int`` or ``int_`` or ``_int_``.", - "keyword": "MUST NOT" + "id": "R-62428", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vnf_name`` parameter **MUST**\nbe declared as ``vnf_name`` and the parameter **MUST** be defined as\ntype: ``string``.", + "keyword": "MUST" } ] }, { "files": [ - "." + "../vvp/base_vfw.yaml" ], - "test_module": "test_volume_module_naming", - "test_case": "test_detected_volume_module_follows_naming_convention", + "test_module": "test_nova_servers_workload_context", + "test_case": "test_workload_context", "result": "PASS", "error": "", "requirements": [ { - "id": "R-589037", - "text": "A VNF Heat Orchestration Template's Cinder Volume Module resources section\n**MUST** only be defined using one of the following:\n\n* one of more ``OS::Cinder::Volume`` resources\n* one or more ``OS::Heat::ResourceGroup`` resources that call a nested YAML\n file that contains only ``OS::Cinder::Volume`` resources\n* a resource that calls a nested YAML file (static nesting) that contains\n only ``OS::Cinder::Volume`` resources", + "id": "R-74978", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``workload_context``\nparameter **MUST**\nbe declared as ``workload_context`` and the parameter **MUST**\nbe defined as type: ``string``.", "keyword": "MUST" } ] + }, + { + "files": [ + "../vvp/base_vfw.yaml" + ], + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_workload_context_parameter_has_no_constraints", + "result": "SKIP", + "error": "", + "requirements": [ + { + "id": "R-34055", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``workload_context``\nparameter ``workload_context`` **MUST NOT**\nhave parameter constraints defined.", + "keyword": "MUST NOT" + } + ] } ], "requirements": [ @@ -2568,7 +2801,7 @@ }, { "id": "R-00068", - "text": "The xNF Package **MUST** include documentation which includes\na description of parameters that can be monitored for the xNF\nand event records (status, fault, flow, session, call, control\nplane, etc.) generated by the xNF after instantiation.", + "text": "The VNF or PNF Documentation Package **MUST** include\na description of parameters that can be monitored for the VNF or PNF\nand event records (status, fault, flow, session, call, control\nplane, etc.) generated by the VNF or PNF after instantiation.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2582,7 +2815,7 @@ }, { "id": "R-00156", - "text": "The xNF Package **MUST** include documentation describing xNF\nManagement APIs, which must include information and tools for\nONAP to monitor the health of the xNF (conditions that require\nhealing and/or scaling responses).", + "text": "The VNF or PNF Documentation Package **MUST** describe the VNF or PNF\nManagement APIs, which must include information and tools for\nONAP to monitor the health of the VNF or PNF (conditions that require\nhealing and/or scaling responses).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2610,7 +2843,7 @@ }, { "id": "R-01033", - "text": "The xNF **MAY** use another option which is expected to include SFTP\nfor asynchronous bulk files, such as bulk files that contain large volumes\nof data collected over a long time interval or data collected across many\nxNFs. (Preferred is to reorganize the data into more frequent or more focused\ndata sets, and deliver these by REST or TCP as appropriate.)", + "text": "The VNF or PNF **MAY** use another option which is expected to include SFTP\nfor asynchronous bulk files, such as bulk files that contain large volumes\nof data collected over a long time interval or data collected across many\nVNFs or PNFs. (Preferred is to reorganize the data into more frequent or more focused\ndata sets, and deliver these by REST or TCP as appropriate.)", "keyword": "MAY", "result": "PASS", "errors": [] @@ -2624,35 +2857,35 @@ }, { "id": "R-01123", - "text": "The VNF package Manifest file **MUST** contain: VNF package meta-data, a\nlist of all artifacts (both internal and external) entry's including\ntheir respected URI's, an algorithm to calculate a digest and a digest\nresult calculated on the content of each artifacts, as specified in\nETSI GS NFV-SOL004. The VNF Package MUST include VNF Identification\nData to uniquely identify the resource for a given VNF provider. The\nidentification data must include: an identifier for the VNF, the name\nof the VNF as was given by the VNF provider, VNF description, VNF\nprovider, and version.", + "text": "The VNF or PNF package Manifest file **MUST** contain: VNF or PNF\npackage meta-data, a list of all artifacts (both internal and\nexternal) entry's including their respected URI's, as specified\nin ETSI GS NFV-SOL 004", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-01334", - "text": "The xNF **MUST** conform to the NETCONF RFC 5717,\n\"Partial Lock Remote Procedure Call\".", + "text": "The VNF or PNF **MUST** conform to the NETCONF RFC 5717,\n\"Partial Lock Remote Procedure Call\".", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-01359", - "text": "A VNF's Heat Orchestration Template that contains an ``OS::Nova:Server``\nResource **MAY** define a parameter for the property\n``availability_zone`` that is not utilized in any ``OS::Nova::Server``\nresources in the Heat Orchestration Template.", + "text": "A VNF's Heat Orchestration Template that contains an ``OS::Nova:Server``\nresource **MAY** define a parameter for the property\n``availability_zone`` that is not utilized in any ``OS::Nova::Server``\nresources in the Heat Orchestration Template.", "keyword": "MAY", "result": "PASS", "errors": [] }, { "id": "R-01382", - "text": "The xNF **MUST** allow the entire configuration of the xNF to be\nretrieved via NETCONF's <get-config> and <edit-config>, independently\nof whether it was configured via NETCONF or other mechanisms.", + "text": "The VNF or PNF **MUST** allow the entire configuration of the VNF or PNF to be\nretrieved via NETCONF's <get-config> and <edit-config>, independently\nof whether it was configured via NETCONF or other mechanisms.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-01427", - "text": "The xNF **MUST** support the provisioning of security and authentication\nparameters (HTTP username and password) in order to be able to authenticate\nwith DCAE (in ONAP).\n\nNote: In R3, a username and password are used with the DCAE VES Event\nListener which are used for HTTP Basic Authentication.\n\nNote: The configuration management and provisioning software are specific\nto a vendor architecture.", + "text": "If the VNF or PNF is using Basic Authentication, then the VNF or\nPNF **MUST** support the provisioning of security and authentication\nparameters (HTTP username and password) in order to be able to\nauthenticate with DCAE VES Event Listener.\n\nNote: The configuration management and provisioning software\nare specific to a vendor architecture.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2666,14 +2899,14 @@ }, { "id": "R-01478", - "text": "The xNF Package **MUST** include documentation describing all\nparameters that are available to monitor the xNF after instantiation\n(includes all counters, OIDs, PM data, KPIs, etc.) that must be\ncollected for reporting purposes.", + "text": "The VNF or PNF Documentation Package **MUST** describe all\nparameters that are available to monitor the VNF or PNF after instantiation\n(includes all counters, OIDs, PM data, KPIs, etc.) that must be\ncollected for reporting purposes.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-01556", - "text": "The xNF Package **MUST** include documentation describing the\nfault, performance, capacity events/alarms and other event records\nthat are made available by the xNF.", + "text": "The VNF or PNF Documentation Package **MUST** describe the\nfault, performance, capacity events/alarms and other event records\nthat are made available by the VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2714,22 +2947,29 @@ "errors": [] }, { + "id": "R-025941", + "text": "The VNF or PNF PROVIDER **MUST** provide FM Meta Data to support the\nanalysis of fault events delivered to DCAE. The Meta Data must be\nincluded in the VES Registration YAML file with each fault event\nsupported by that NF at onboarding time and the Meta Data must follow\nthe VES Event Listener and VES Event Registration Specifications.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-02597", - "text": "The xNF **MUST** implement the protocol operation:\n``lock(target)`` - Lock the configuration data store target.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``lock(target)`` - Lock the configuration data store target.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-02616", - "text": "The xNF **MUST** permit locking at the finest granularity\nif a xNF needs to lock an object for configuration to avoid blocking\nsimultaneous configuration operations on unrelated objects (e.g., BGP\nconfiguration should not be locked out if an interface is being\nconfigured or entire Interface configuration should not be locked out\nif a non-overlapping parameter on the interface is being configured).", + "text": "The VNF or PNF **MUST** permit locking at the finest granularity\nif a VNF or PNF needs to lock an object for configuration to avoid blocking\nsimultaneous configuration operations on unrelated objects (e.g., BGP\nconfiguration should not be locked out if an interface is being\nconfigured or entire Interface configuration should not be locked out\nif a non-overlapping parameter on the interface is being configured).", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-02651", - "text": "The xNF **SHOULD** use available backup capabilities to save a\ncopy of configuration files before implementing changes to support\noperations such as backing out of software upgrades, configuration\nchanges or other work as this will help backing out of configuration\nchanges when needed.", + "text": "The VNF or PNF **SHOULD** use available backup capabilities to save a\ncopy of configuration files before implementing changes to support\noperations such as backing out of software upgrades, configuration\nchanges or other work as this will help backing out of configuration\nchanges when needed.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -2750,14 +2990,14 @@ }, { "id": "R-03070", - "text": "The xNF **MUST**, by ONAP Policy, provide the ONAP addresses\nas data destinations for each xNF, and may be changed by Policy while\nthe xNF is in operation. We expect the xNF to be capable of redirecting\ntraffic to changed destinations with no loss of data, for example from\none REST URL to another, or from one TCP host and port to another.", + "text": "The VNF or PNF **MUST**, by ONAP Policy, provide the ONAP addresses\nas data destinations for each VNF or PNF, and may be changed by Policy while\nthe VNF or PNF is in operation. We expect the VNF or PNF to be capable of redirecting\ntraffic to changed destinations with no loss of data, for example from\none REST URL to another, or from one TCP host and port to another.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-03251", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::CinderVolume``\n**MAY** be defined in a Cinder Volume Module.", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume``\n**MAY** be defined in a Cinder Volume Module.", "keyword": "MAY", "result": "PASS", "errors": [] @@ -2771,7 +3011,7 @@ }, { "id": "R-03465", - "text": "The xNF **MUST** release locks to prevent permanent lock-outs\nwhen the corresponding <partial-unlock> operation succeeds.", + "text": "The VNF or PNF **MUST** release locks to prevent permanent lock-outs\nwhen the corresponding <partial-unlock> operation succeeds.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2799,14 +3039,14 @@ }, { "id": "R-04158", - "text": "The xNF **MUST** conform to the NETCONF RFC 4742,\n\"Using the NETCONF Configuration Protocol over Secure Shell (SSH)\".", + "text": "The VNF or PNF **MUST** conform to the NETCONF RFC 4742,\n\"Using the NETCONF Configuration Protocol over Secure Shell (SSH)\".", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-04298", - "text": "The xNF provider **MUST** provide their testing scripts to\nsupport testing.", + "text": "The VNF provider **MUST** provide their testing scripts to\nsupport testing.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2904,14 +3144,14 @@ }, { "id": "R-06924", - "text": "The xNF **MUST** deliver asynchronous data as data becomes\navailable, or according to the configured frequency.", + "text": "The VNF or PNF **MUST** deliver asynchronous data as data becomes\navailable, or according to the configured frequency.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-07251", - "text": "The xNF **MUST** support APPC/SDN-C ``ResumeTraffic`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``ResumeTraffic`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2932,7 +3172,7 @@ }, { "id": "R-07545", - "text": "The xNF **MUST** support all operations, administration and\nmanagement (OAM) functions available from the supplier for xNFs using\nthe supplied YANG code and associated NETCONF servers.", + "text": "The VNF or PNF **MUST** support all operations, administration and\nmanagement (OAM) functions available from the supplier for VNFs or PNFs\nusing the supplied YANG code and associated NETCONF servers.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2946,14 +3186,14 @@ }, { "id": "R-08134", - "text": "The xNF **MUST** conform to the NETCONF RFC 6241,\n\"NETCONF Configuration Protocol\".", + "text": "The VNF or PNF **MUST** conform to the NETCONF RFC 6241,\n\"NETCONF Configuration Protocol\".", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-08312", - "text": "The xNF **MAY** use another option which is expected to include REST\ndelivery of binary encoded data sets.", + "text": "The VNF or PNF **MAY** use another option which is expected to include REST\ndelivery of binary encoded data sets.", "keyword": "MAY", "result": "PASS", "errors": [] @@ -2994,59 +3234,311 @@ "errors": [] }, { + "id": "R-100000", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n**MUST** be declared as either type ``string`` or type\n``comma_delimited_list``.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100010", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the ONAP definition, see Requirement R-57424),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100020", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_{network-role}_ip_{index}``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100030", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_ips``\n\n where\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the external\n network", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100040", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_{network-role}_ips``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100050", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network\n(per the\nONAP definition, see Requirement R-57424),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100060", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_{network-role}_v6_ip_{index}``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100070", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100080", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_{network-role}_v6_ips``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100090", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is\ndefined as a ``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100100", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_int_{network-role}_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100110", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100120", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_int_{network-role}_int_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100130", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100140", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_int_{network-role}_v6_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100150", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100160", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_v6_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100170", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp``\nproperty ``instance_ip_address``\nparameter associated with an external network, i.e.,\n\n * ``{vm-type}_{network-role}_ip_{index}``\n * ``{vm-type}_{network-role}_v6_ip_{index}``\n * ``{vm-type}_{network-role}_ips``\n * ``{vm-type}_{network-role}_v6_ips``\n\n\n**MUST NOT** be enumerated in the Heat Orchestration\nTemplate's Environment File. ONAP provides the IP address\nassignments at orchestration time.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100180", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp``\nproperty ``instance_ip_address``\nparameter associated with an internal network, i.e.,\n\n * ``{vm-type}_int_{network-role}_ip_{index}``\n * ``{vm-type}_int_{network-role}_v6_ip_{index}``\n * ``{vm-type}_int_{network-role}_ips``\n * ``{vm-type}_int_{network-role}_v6_ips``\n\n\n**MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and IP addresses **MUST** be\nassigned.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100190", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid``\nparameter\n**MUST** be declared type ``string``.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100200", + "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv4 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv4 subnet is to be specified\nusing the property ``subnet_uuid``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100210", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``subnet_uuid``\nparameter\n``{network-role}_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100220", + "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv6 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv6 subnet is to be specified\nusing the property ``subnet_uuid``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_v6_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100230", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``subnet_uuid``\nparameter\n``{network-role}_v6_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100240", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::ContrailV2::InstanceIp`` in an Incremental Module is\n assigning an IP address\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``subnet_uuid``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100250", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``subnet_uuid``\nparameter\n``int_{network-role}_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100260", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::ContrailV2::InstanceIp`` in an Incremental Module is\n attaching\n to an internal network (per the ONAP definition,\n see Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``subnet_uuid``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100270", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``subnet_uuid``\nparameter\n``int_{network-role}_v6_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100280", + "text": "If a VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface``\nis attaching to an external network (per the\nONAP definition, see Requirement R-57424), the\nmap property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameter\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100310", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an external\nnetwork (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 Virtual IP (VIP)\nis required to be supported by the ONAP data model,\nthe map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nThe ONAP data model can only support one IPv4 VIP address.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100330", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an external\nnetwork (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 Virtual IP (VIP)\nis required to be supported by the ONAP data model,\nthe map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nThe ONAP data model can only support one IPv6 VIP address.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100350", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an\nexternal network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv4 VIP address and/or IPv6 VIP address\nis **not** supported by the ONAP data model,\nthe map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\n* Parameter name **MAY** use any naming convention. That is, there is no\n ONAP mandatory parameter naming convention.\n* Parameter **MAY** be declared as type ``string`` or type\n``comma_delimited_list``.\n\nAnd the ``OS::ContrailV2::VirtualMachineInterface`` resource\n**MUST** contain resource-level ``metadata`` (not property-level).\n\nAnd the ``metadata`` format **MUST** must contain the\nkey value ``aap_exempt`` with a list of all map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameters **not** supported by the ONAP data model.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100360", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 Virtual IP (VIP)\naddress is assigned using the map property,\n``virtual_machine_interface_allowed_address_pairs,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n, the parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file.\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100370", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 Virtual IP (VIP)\naddress is assigned\nusing the map property,\n``virtual_machine_interface_allowed_address_pairs,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n, the parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100380", + "text": "If a VNF requires the use of an SSH key created by OpenStack, the VNF\nHeat Orchestration Template **SHOULD** create the ``OS::Nova::Keypair``\nin the base module, and expose the public key as an output value.\n\nThis allows re-use of the key by ONAP when triggering scale out, recovery,\nor other day 1 operations.", + "keyword": "SHOULD", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100400", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty metadata **SHOULD** contain the key/value pair ``vf_module_name``.", + "keyword": "SHOULD", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100410", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MAY**\ncontain the key/value pair ``vf_module_index``.", + "keyword": "MAY", + "result": "PASS", + "errors": [] + }, + { "id": "R-10087", - "text": "The VNF package **MUST** contain all standard artifacts as specified in\nETSI GS NFV-SOL004 including Manifest file, VNFD (or Main TOSCA/YAML\nbased Service Template) and other optional artifacts. CSAR Manifest\nfile as per SOL004 - for example ROOT\\\\ **MainServiceTemplate.mf**", + "text": "The VNF or PNF CSAR package **MUST** include all artifacts required by\nETSI GS NFV-SOL004 including Manifest file, VNFD or PNFD (or Main\nTOSCA/YAML based Service Template) and other optional artifacts.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-10129", - "text": "The xNF **SHOULD** conform its YANG model to RFC 7223,\n\"A YANG Data Model for Interface Management\".", + "text": "The VNF or PNF **SHOULD** conform its YANG model to RFC 7223,\n\"A YANG Data Model for Interface Management\".", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-10173", - "text": "The xNF **MUST** allow another NETCONF session to be able to\ninitiate the release of the lock by killing the session owning the lock,\nusing the <kill-session> operation to guard against hung NETCONF sessions.", + "text": "The VNF or PNF **MUST** allow another NETCONF session to be able to\ninitiate the release of the lock by killing the session owning the lock,\nusing the <kill-session> operation to guard against hung NETCONF sessions.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-10353", - "text": "The xNF **MUST** conform its YANG model to RFC 6244,\n\"An Architecture for Network Management Using NETCONF and YANG\".", + "text": "The VNF or PNF **MUST** conform its YANG model to RFC 6244,\n\"An Architecture for Network Management Using NETCONF and YANG\".", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-106240", - "text": "The following VES Events **MUST** be supported by the PNF: pnfRegistration\nVES Event, HVol VES Event, and Fault VES Event. These are onboarded via\nhe SDC Design Studio.\n\nNote: these VES Events are emitted from the PNF to support PNF Plug and\nPlay, High Volume Measurements, and Fault events respectively.", - "keyword": "MUST", + "text": "The following VES Events **SHOULD** be supported by the PNF: pnfRegistration\nVES Event, HVol VES Event, and Fault VES Event. These are onboarded via\nhe SDC Design Studio.\n\nNote: these VES Events are emitted from the PNF to support PNF Plug and\nPlay, High Volume Measurements, and Fault events respectively.", + "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-10716", - "text": "The xNF **MUST** support parallel and simultaneous\nconfiguration of separate objects within itself.", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { - "id": "R-10754", - "text": "If a VNF has two or more ports that\nattach to an external network that require a Virtual IP Address (VIP),\nand the VNF requires ONAP automation to assign the IP address,\nall the Virtual Machines using the VIP address **MUST**\nbe instantiated in the same Base Module Heat Orchestration Template\nor in the same Incremental Module Heat Orchestration Template.", + "text": "The VNF or PNF **MUST** support parallel and simultaneous\nconfiguration of separate objects within itself.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-10834", - "text": "If a VNF's Heat Orchestration Template resource attribute\n``property:`` uses a nested ``get_param``, the nested\n``get_param`` **MUST** reference an index.\n\nThat is, to obtain a property value, two ``get_param`` intrinsic\nfunctions are used. The second ``get_param`` must be used\nto obtain an index value used to reference a parameter value in\na parameter defined as ``type: comma_delimited_list``. For\nexample:\n\n* ``name: {get_param: [ name, get_param: index ] }``", - "keyword": "MUST", - "result": "SKIP", + "text": "A VNF's Heat Orchestration Template resource attribute ``property:``\n**MUST NOT** use more than two levels of nested ``get_param`` intrinsic\nfunctions when deriving a property value. SDC does not support nested\n``get_param`` with recursive lists (i.e., a list inside list).\nThe second ``get_param`` in a nested lookup must directly derive its value\nwithout further calls to ``get_param`` functions.\n\n* Example of valid nesting:\n\n * ``name: {get_param: [ {vm-type}_names, {get_param : index } ] }``\n\n* Examples of invalid nesting. SDC will not support these examples since\n there is an array inside array.\n\n * ``name: {get_param: [ {vm-type}_names, { get_param: [ indexlist, 0 ] } ] }``\n * ``name: {get_param: [ {vm-type}_names, { get_param: [ indexlist1, { get_param: indexlist2 } ] } ] }``", + "keyword": "MUST NOT", + "result": "PASS", "errors": [] }, { @@ -3072,14 +3564,14 @@ }, { "id": "R-11235", - "text": "The xNF **MUST** implement the protocol operation:\n``kill-session(session``- Force the termination of **session**.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``kill-session(session``- Force the termination of **session**.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-11240", - "text": "The xNF **MUST** respond with content encoded in JSON, as\ndescribed in the RESTCONF specification. This way the encoding of a\nsynchronous communication will be consistent with Avro.", + "text": "The VNF or PNF **MUST** respond with content encoded in JSON, as\ndescribed in the RESTCONF specification. This way the encoding of a\nsynchronous communication will be consistent with Avro.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3093,7 +3585,7 @@ }, { "id": "R-11499", - "text": "The xNF **MUST** fully support the XPath 1.0 specification\nfor filtered retrieval of configuration and other database contents.\nThe 'type' attribute within the <filter> parameter for <get> and\n<get-config> operations may be set to 'xpath'. The 'select' attribute\n(which contains the XPath expression) will also be supported by the\nserver. A server may support partial XPath retrieval filtering, but\nit cannot advertise the ``:xpath`` capability unless the entire XPath\n1.0 specification is supported.", + "text": "The VNF or PNF **MUST** fully support the XPath 1.0 specification\nfor filtered retrieval of configuration and other database contents.\nThe 'type' attribute within the <filter> parameter for <get> and\n<get-config> operations may be set to 'xpath'. The 'select' attribute\n(which contains the XPath expression) will also be supported by the\nserver. A server may support partial XPath retrieval filtering, but\nit cannot advertise the ``:xpath`` capability unless the entire XPath\n1.0 specification is supported.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3121,7 +3613,7 @@ }, { "id": "R-120182", - "text": "The xNF provider **MUST** indicate specific conditions that may arise, and\nrecommend actions that may be taken at specific thresholds, or if specific\nconditions repeat within a specified time interval, using the semantics and\nsyntax described by the :doc:`VES Event Registration specification <../../../../vnfsdk/model.git/docs/files/VESEventRegistration_3_0>`.", + "text": "The VNF or PNF provider **MUST** indicate specific conditions that may arise, and\nrecommend actions that may be taken at specific thresholds, or if specific\nconditions repeat within a specified time interval, using the semantics and\nsyntax described by the :ref:`VES Event Registration specification <ves_event_registration_3_2>`.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3135,14 +3627,14 @@ }, { "id": "R-12271", - "text": "The xNF **SHOULD** conform its YANG model to RFC 7223,\n\"IANA Interface Type YANG Module\".", + "text": "The VNF or PNF **SHOULD** conform its YANG model to RFC 7223,\n\"IANA Interface Type YANG Module\".", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-123044", - "text": "The xNF Provider **MAY** require that specific events, identified by their\n``eventName``, require that certain fields, which are optional in the common\nevent format, must be present when they are published.", + "text": "The VNF or PNF Provider **MAY** require that specific events, identified by their\n``eventName``, require that certain fields, which are optional in the common\nevent format, must be present when they are published.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3163,14 +3655,14 @@ }, { "id": "R-12678", - "text": "The xNF Package **MUST** include documentation which includes a\ndescription of runtime lifecycle events and related actions (e.g.,\ncontrol responses, tests) which can be performed for the xNF.", + "text": "The VNF or PNF Documentation Package **MUST** include a\ndescription of runtime lifecycle events and related actions (e.g.,\ncontrol responses, tests) which can be performed for the VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-12706", - "text": "The xNF **MUST** support APPC/SDN-C ``QuiesceTraffic`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``QuiesceTraffic`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3183,6 +3675,13 @@ "errors": [] }, { + "id": "R-130206", + "text": "If the VNF or PNF CSAR Package utilizes Option 1 for package security, then\nthe complete CSAR file **MUST** contain a Digest (a.k.a. hash) for each of\nthe components of the VNF or PNF package. The table of hashes is included\nin the package manifest file, which is signed with the VNF or PNF provider\nprivate key. In addition, the VNF or PNF provider MUST include a signing\ncertificate that includes the VNF or PNF provider public key, following a\nTOSCA pre-defined naming convention and located either at the root of the\narchive or in a predefined location specified by the TOSCA.meta file with\nthe corresponding entry named \"ETSI-Entry-Certificate\".", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-13151", "text": "The VNF **SHOULD** disable the paging of the data requiring\nencryption, if possible, where the encryption of non-transient data is\nrequired on a device for which the operating system performs paging to\nvirtual memory. If not possible to disable the paging of the data\nrequiring encryption, the virtual memory should be encrypted.", "keyword": "SHOULD", @@ -3212,7 +3711,7 @@ }, { "id": "R-13390", - "text": "The xNF provider **MUST** provide cookbooks to be loaded\non the appropriate Chef Server.", + "text": "The VNF or PNF provider **MUST** provide cookbooks to be loaded\non the appropriate Chef Server.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3233,7 +3732,7 @@ }, { "id": "R-13800", - "text": "The xNF **MUST** conform to the NETCONF RFC 5277,\n\"NETCONF Event Notification\".", + "text": "The VNF or PNF **MUST** conform to the NETCONF RFC 5277,\n\"NETCONF Event Notification\".", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3247,14 +3746,21 @@ }, { "id": "R-14447", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate``\nResource ID **MAY** use the naming convention\n\n* ``{vm-type}_RST_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``RST`` signifies that it is the Resource Service Template\n* ``{index}`` is the index", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate``\nResource ID **MAY** use the naming convention\n\n* ``{vm-type}_RST_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``RST`` signifies that it is the Resource Service Template\n* ``{index}`` is the index.\n The ``{index}`` starts at zero and increments by one\n (as described in R-11690).", "keyword": "MAY", "result": "PASS", "errors": [] }, { + "id": "R-146092", + "text": "If one or more non-MANO artifact(s) is included in the VNF or PNF TOSCA CSAR\npackage, the Manifest file in this CSAR package **MUST** contain: non-MANO\nartifact set which MAY contain following ONAP public tag.\n\n - onap_ves_events: contains VES registration files\n\n - onap_pm_dictionary: contains the PM dictionary files\n\n - onap_yang_modules: contains Yang module files for configurations\n\n - onap_ansible_playbooks: contains any ansible_playbooks\n\n - onap_others: contains any other non_MANO artifacts, e.g. informational\n documents", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-146931", - "text": "The xNF **MUST** report exactly one Measurement event per period\nper source name.", + "text": "The VNF or PNF **MUST** report exactly one Measurement event per period\nper source name.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3317,19 +3823,12 @@ }, { "id": "R-15885", - "text": "The xNF **MUST** Upon completion of the chef-client run,\nPOST back on the callback URL, a JSON object as described in Table\nA2 if the chef-client run list includes a cookbook/recipe that is\ncallback capable. Failure to POST on the Callback Url should not be\nconsidered a critical error. That is, if the chef-client successfully\ncompletes the xNF action, it should reflect this status on the Chef\nServer regardless of whether the Callback succeeded or not.", + "text": "The VNF or PNF **MUST** Upon completion of the chef-client run,\nPOST back on the callback URL, a JSON object as described in Table\nA2 if the chef-client run list includes a cookbook/recipe that is\ncallback capable. Failure to POST on the Callback Url should not be\nconsidered a critical error. That is, if the chef-client successfully\ncompletes the VNF or PNF action, it should reflect this status on the Chef\nServer regardless of whether the Callback succeeded or not.", "keyword": "MUST", "result": "PASS", "errors": [] }, { - "id": "R-159016", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nECOMP definition, see Requirement R-57424),\nand an IPv4 and/or IPv6 Virtual IP (VIP)\naddress is assigned via ECOMP automation\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``, the\nparameter **MUST NOT** be declared as ``type: comma_deliited_list``.", - "keyword": "MUST NOT", - "result": "PASS", - "errors": [] - }, - { "id": "R-16039", "text": "The VNF **SHOULD** test for adherence to the defined\nresiliency rating recommendation at each layer, during each\ndelivery cycle so that the resiliency rating is measured and\nfeedback is provided where software resiliency requirements are\nnot met.", "keyword": "SHOULD", @@ -3338,7 +3837,7 @@ }, { "id": "R-16065", - "text": "The xNF provider **MUST** provide configurable parameters\n(if unable to conform to YANG model) including xNF attributes/parameters\nand valid values, dynamic attributes and cross parameter dependencies\n(e.g., customer provisioning data).", + "text": "The VNF or PNF provider **MUST** provide configurable parameters\n(if unable to conform to YANG model) including VNF or PNF attributes/parameters\nand valid values, dynamic attributes and cross parameter dependencies\n(e.g., customer provisioning data).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3352,7 +3851,7 @@ }, { "id": "R-16437", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate``\nResource ID **MUST** contain the ``{vm-type}``.", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::ServiceTemplate``\nResource ID **MUST** contain the ``{vm-type}``.", "keyword": "MUST", "result": "SKIP", "errors": [] @@ -3380,14 +3879,14 @@ }, { "id": "R-16777", - "text": "The xNF provider **MUST** provide a JSON file for each\nsupported action for the xNF. The JSON file must contain key value\npairs with all relevant values populated with sample data that illustrates\nits usage. The fields and their description are defined in Table B1\nin the Appendix.", + "text": "The VNF or PNF provider **MUST** provide a JSON file for each\nsupported action for the VNF or PNF. The JSON file must contain key value\npairs with all relevant values populated with sample data that illustrates\nits usage. The fields and their description are defined in Table B1\nin the Appendix.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-16875", - "text": "The xNF Package **MUST** include documentation which must include\na unique identification string for the specific xNF, a description of\nthe problem that caused the error, and steps or procedures to perform\nRoot Cause Analysis and resolve the issue.", + "text": "The VNF or PNF Documentation Package **MUST** include documentation which must\ninclude a unique identification string for the specific VNF or PNF, a description\nof the problem that caused the error, and steps or procedures to perform\nRoot Cause Analysis and resolve the issue.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3421,6 +3920,13 @@ "errors": [] }, { + "id": "R-177937", + "text": "The PNFD provided by a PNF vendor\u00a0**MUST**\u00a0comply with the following\nCapabilities Types as specified in ETSI NFV-SOL001 standard:\n\n - tosca.datatypes.nfv.VirtualLinkable", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-17852", "text": "The VNFD **MAY** include TOSCA/YAML definitions that are not part of\nNFV Profile. If provided, these definitions MUST comply with TOSCA\nSimple Profile in YAML v.1.2.", "keyword": "MAY", @@ -3429,7 +3935,7 @@ }, { "id": "R-18001", - "text": "If the VNF's ports connected to a unique internal network\nand the port's IP addresses are statically assigned IP Addresses,\nthe IPv4 Addresses **MAY** be from different subnets and the\nIPv6 Addresses **MAY** be from different subnets.", + "text": "If the VNF's ports connected to a unique internal network\nand the port's IP addresses are statically assigned IP addresses,\nthe IPv4 addresses **MAY** be from different subnets and the\nIPv6 addresses **MAY** be from different subnets.", "keyword": "MAY", "result": "PASS", "errors": [] @@ -3450,7 +3956,7 @@ }, { "id": "R-18525", - "text": "The xNF provider **MUST** provide a JSON file for each\nsupported action for the xNF. The JSON file must contain key value\npairs with all relevant values populated with sample data that illustrates\nits usage. The fields and their description are defined in Tables A1\nand A2 in the Appendix.\n\nNote: Chef support in ONAP is not currently available and planned for 4Q 2017.", + "text": "The VNF or PNF provider **MUST** provide a JSON file for each\nsupported action for the VNF or PNF. The JSON file must contain key value\npairs with all relevant values populated with sample data that illustrates\nits usage. The fields and their description are defined in Tables A1\nand A2 in the Appendix.\n\nNote: Chef support in ONAP is not currently available and planned for 4Q 2017.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3471,7 +3977,7 @@ }, { "id": "R-18733", - "text": "The xNF **MUST** implement the protocol operation:\n``discard-changes()`` - Revert the candidate configuration\ndata store to the running configuration.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``discard-changes()`` - Revert the candidate configuration\ndata store to the running configuration.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3492,14 +3998,14 @@ }, { "id": "R-19366", - "text": "The xNF **MUST** support APPC ``ConfigModify`` command.", + "text": "The VNF or PNF **MUST** support APPC ``ConfigModify`` command.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-19624", - "text": "The xNF, when leveraging JSON for events, **MUST** encode and serialize\ncontent delivered to ONAP using JSON (RFC 7159) plain text format.\nHigh-volume data is to be encoded and serialized using\n`Avro <http://avro.apache.org/>`_, where the Avro [#7.4.1]_ data\nformat are described using JSON.", + "text": "The VNF or PNF, when leveraging JSON for events, **MUST** encode and serialize\ncontent delivered to ONAP using JSON (RFC 7159) plain text format.\nHigh-volume data is to be encoded and serialized using\n`Avro <http://avro.apache.org/>`_, where the Avro data\nformat are described using JSON.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3520,7 +4026,7 @@ }, { "id": "R-19922", - "text": "The xNF **MUST** support APPC/SDN-C ``UpgradePrecheck`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``UpgradePrecheck`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3555,14 +4061,14 @@ }, { "id": "R-20353", - "text": "The xNF **MUST** implement both ``:candidate`` and\n``:writable-running`` capabilities. When both ``:candidate`` and\n``:writable-running`` are provided then two locks should be supported.", + "text": "The VNF or PNF **MUST** implement both ``:candidate`` and\n``:writable-running`` capabilities. When both ``:candidate`` and\n``:writable-running`` are provided then two locks should be supported.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-20453", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an external network Resource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port-index}`` is the instance of the port on the vm-type\n attached to the network of ``{network-role}``", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an external network Resource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port_index}`` references the instance of the port on the ``{vm-type}``\n attached to ``{network-role}`` network. The\n ``{port_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new port is defined on the instance of the ``{vm-type}`` attached to\n ``{network-role}`` network.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3576,7 +4082,7 @@ }, { "id": "R-20741", - "text": "The xNF **MUST** support APPC/SDN-C ``Configure`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``Configure`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3639,7 +4145,7 @@ }, { "id": "R-21819", - "text": "The VNF **MUST** provide functionality that enables the Operator to comply\nwith requests for information from law enforcement and government agencies.", + "text": "VNFs that are subject to regulatory requirements **MUST** provide\nfunctionality that enables the Operator to comply with ETSI TC LI\nrequirements, and, optionally, other relevant national equivalents.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3652,8 +4158,8 @@ "errors": [] }, { - "id": "R-22286", - "text": "The VNF **MUST** support Integration functionality via\nAPI/Syslog/SNMP to other functional modules in the network (e.g.,\nPCRF, PCEF) that enable dynamic security control by blocking the\nmalicious traffic or malicious end users.", + "id": "R-221914", + "text": "The VNF or PNF package **MUST** contain a a human-readable change log text\nfile. The Change Log file keeps a history describing any changes in the VNF\nor PNF package. The Change Log file is kept up to date continuously from\nthe creation of the CSAR package.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3667,7 +4173,7 @@ }, { "id": "R-22346", - "text": "The xNF package MUST provide :doc:`VES Event Registration <../../../../vnfsdk/model.git/docs/files/VESEventRegistration_3_0>`\nfor all VES events provided by that xNF.", + "text": "The VNF or PNF package **MUST** provide :ref:`VES Event Registration <ves_event_registration_3_2>`\nfor all VES events provided by that VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3695,21 +4201,21 @@ }, { "id": "R-22680", - "text": "The xNF Package **MUST** include documentation that describes\nany requirements for the monitoring component of tools for Network\nCloud automation and management to provide these records to components\nof the xNF.", + "text": "The VNF or PNF Documentation Package **MUST** describe\nany requirements for the monitoring component of tools for Network\nCloud automation and management to provide these records to components\nof the VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-22688", - "text": "If a VNF's port is connected to an internal network and the port is\ncreated in an Incremental Module and the internal network is created\nin the Base Module then the UUID of the internal network **MUST** be\nexposed as a parameter in the ``outputs:`` section of the Base Module\nand the port resource **MUST** use a ``get_param`` to obtain the network\nUUID.", + "text": "When a VNF's Heat Orchestration Template creates an internal network\n(per the ONAP definition, see Requirements R-52425 and R-46461\nand R-35666) and the internal network needs to be shared between modules\nwithin a VNF, the internal network **MUST** be created either in the\n\n* the base module\n* a nested YAML file invoked by the base module\n\nand the base module **MUST** contain an output parameter that provides\neither the network UUID or network name.\n\n* If the network UUID value is used to reference the network, the output\n parameter name in the base module **MUST** follow the naming convention\n ``int_{network-role}_net_id``\n* If the network name in is used to reference the network, the output\n parameter name in the base template **MUST** follow the naming convention\n ``int_{network-role}_net_name``\n\n``{network-role}`` **MUST** be the network-role of the internal network\ncreated in the Base Module.\n\nThe Base Module Output Parameter MUST be declared in the ``parameters:``\nsection of the Incremental Module(s) where the ``OS::Neutron::Port``\nresource(s) is attaching to the internal network.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-22700", - "text": "The xNF **MUST** conform its YANG model to RFC 6470,\n\"NETCONF Base Notifications\".", + "text": "The VNF or PNF **MUST** conform its YANG model to RFC 6470,\n\"NETCONF Base Notifications\".", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3723,14 +4229,14 @@ }, { "id": "R-22888", - "text": "The xNF provider **MUST** provide documentation for the xNF\nPolicy Description to manage the xNF runtime lifecycle. The document\nmust include a description of how the policies (conditions and actions)\nare implemented in the xNF.", + "text": "The VNF or PNF Documentation Package **MUST** provide the VNF or PNF\nPolicy Description to manage the VNF or PNF runtime lifecycle. The document\nmust include a description of how the policies (conditions and actions)\nare implemented in the VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-22946", - "text": "The xNF **SHOULD** conform its YANG model to RFC 6536,\n\"NETCONF Access Control Model\".", + "text": "The VNF or PNF **SHOULD** conform its YANG model to RFC 6536,\n\"NETCONF Access Control Model\".", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -3758,7 +4264,7 @@ }, { "id": "R-23311", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Nova::Server`` property\n``availability_zone`` parameter **MUST** be declared as type: ``string``.", + "text": "The VNF's Heat Orchestration Template's base module or incremental module\nresource ``OS::Nova::Server`` property\n``availability_zone`` parameter **MUST** be declared as type: ``string``.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3814,14 +4320,14 @@ }, { "id": "R-24189", - "text": "The xNF provider **MUST** deliver a new set of playbooks that includes\nall updated and unchanged playbooks for any new revision to an existing\nset of playbooks.", + "text": "The VNF or PNF provider **MUST** deliver a new set of playbooks that\nincludes all updated and unchanged playbooks for any new revision to an\nexisting set of playbooks.", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-24269", - "text": "The xNF **SHOULD** conform its YANG model to RFC 7407,\n\"A YANG Data Model for SNMP Configuration\", if Netconf used to\nconfigure SNMP engine.", + "text": "The VNF or PNF **SHOULD** conform its YANG model to RFC 7407,\n\"A YANG Data Model for SNMP Configuration\", if Netconf used to\nconfigure SNMP engine.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -3835,7 +4341,14 @@ }, { "id": "R-24482", - "text": "The xNF **MUST** provide Ansible playbooks that are designed to run using\nan inventory hosts file in a supported format; with site group that shall\nbe used to add site specific configurations to the target xNF VM(s) as\nneeded.", + "text": "The VNF or PNF **MUST** provide Ansible playbooks that are designed to run\nusing an inventory hosts file in a supported format; with site group that\nshall be used to add site specific configurations to the target VNF or PNF\nVM(s) as needed.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-24632", + "text": "The PNF Descriptor (PNFD) provided by PNF vendor **MUST** comply with\nTOSCA/YAML based Service template for PNF descriptor specified in ETSI\nNFV-SOL001.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3849,7 +4362,7 @@ }, { "id": "R-24997", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Keypair`` applies to\none ``{vm-type}`` Resource ID **SHOULD** use the naming convention\n\n* ``{vm-type}_keypair_{index}``\n\nwhere\n\n* ``{network-role}`` is the network-role\n* ``{index}`` is the ``{index}`` of the keypair", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Keypair`` applies to\none ``{vm-type}`` Resource ID **SHOULD** use the naming convention\n\n* ``{vm-type}_keypair_{index}``\n\nwhere\n\n* ``{network-role}`` is the network-role\n* ``{index}`` is the ``{index}`` of the keypair.\n The ``{index}`` starts at zero and increments by one\n (as described in R-11690).", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -3863,7 +4376,7 @@ }, { "id": "R-25238", - "text": "The xNF PACKAGE **MUST** validated YANG code using the open\nsource pyang [#7.3.1]_ program using the following commands:\n\n.. code-block:: text\n\n $ pyang --verbose --strict <YANG-file-name(s)> $ echo $!", + "text": "The VNF or PNF PACKAGE **MUST** validated YANG code using the open\nsource pyang [#7.3.1]_ program using the following commands:\n\n.. code-block:: text\n\n $ pyang --verbose --strict <YANG-file-name(s)> $ echo $!", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3897,6 +4410,13 @@ "errors": [] }, { + "id": "R-256790", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``availability_zone`` parameter name **MAY** change when\npast into a nested YAML file.", + "keyword": "MAY", + "result": "PASS", + "errors": [] + }, + { "id": "R-25720", "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Net``\nResource ID **MUST** use the naming convention\n\n* ``int_{network-role}_network``\n\nVNF Heat Orchestration Templates can only create internal networks.\nThere is no ``{index}`` after ``{network-role}`` because ``{network-role}``\n**MUST** be unique in the scope of the VNF's\nHeat Orchestration Template.", "keyword": "MUST", @@ -3905,7 +4425,7 @@ }, { "id": "R-257367", - "text": "The xNF, when leveraging Google Protocol Buffers for events, **MUST**\nserialize the events using native Google Protocol Buffers (GPB) according\nto the following guidelines:\n\n * The keys are represented as integers pointing to the system resources\n for the xNF being monitored\n * The values correspond to integers or strings that identify the\n operational state of the VNF resource, such a statistics counters and\n the state of an xNF resource.\n * The required Google Protocol Buffers (GPB) metadata is provided in the\n form of .proto files.", + "text": "The VNF or PNF, when leveraging Google Protocol Buffers for events, **MUST**\nserialize the events using native Google Protocol Buffers (GPB) according\nto the following guidelines:\n\n * The keys are represented as integers pointing to the system resources\n for the VNF or PNF being monitored\n * The values correspond to integers or strings that identify the\n operational state of the VNF resource, such a statistics counters and\n the state of an VNF or PNF resource.\n * The required Google Protocol Buffers (GPB) metadata is provided in the\n form of .proto files.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3919,8 +4439,8 @@ }, { "id": "R-258686", - "text": "The VNF application processes **MUST NOT** run as root.", - "keyword": "MUST NOT", + "text": "The VNF application processes **SHOULD NOT** run as root. If a VNF\napplication process must run as root, the technical reason must\nbe documented.", + "keyword": "SHOULD NOT", "result": "PASS", "errors": [] }, @@ -3933,7 +4453,7 @@ }, { "id": "R-26115", - "text": "The xNF **MUST** follow the data model upgrade rules defined\nin [RFC6020] section 10. All deviations from section 10 rules shall\nbe handled by a built-in automatic upgrade mechanism.", + "text": "The VNF or PNF **MUST** follow the data model update rules defined in\n[RFC6020] section 10 for YANG 1.0 modules, and [RFC7950] section 11\nfor YANG 1.1 modules. All deviations from the aforementioned update\nrules shall be handled by a built-in automatic upgrade mechanism.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3947,7 +4467,7 @@ }, { "id": "R-26351", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an internal network Resource ID **MUST**\nuse the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port-index}`` is the instance of the port on the vm-type\n attached to the network of ``{network-role}``", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an internal network Resource ID **MUST**\nuse the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port_index}`` references the instance of the port on the ``{vm-type}``\n attached to ``{network-role}`` network. The\n ``{port_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new port is defined on the instance of the ``{vm-type}`` attached to\n ``{network-role}`` network.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3961,35 +4481,28 @@ }, { "id": "R-26506", - "text": "A VNF's Heat Orchestration Template's ``{network-role}`` **MUST** contain\nonly alphanumeric characters and/or underscores '_' and\n**MUST NOT** contain any of the following strings:\n``_int`` or ``int_`` or ``_int_``.", - "keyword": "MUST", + "text": "A VNF's Heat Orchestration Template's ``{network-role}`` **MUST** contain\nonly alphanumeric characters and/or underscores '_' and\n\n* **MUST NOT** contain any of the following strings: ``_int`` or ``int_``\n or ``_int_``\n* **MUST NOT** end in the string: ``_v6``\n* **MUST NOT** contain the strings ``_#_``, where ``#`` is a number\n* **MUST NOT** end in the string: ``_#``, where ``#`` is a number", + "keyword": "MUST NOT", "result": "PASS", "errors": [] }, { "id": "R-26508", - "text": "The xNF **MUST** support a NETCONF server that can be mounted on\nOpenDaylight (client) and perform the operations of: modify, update,\nchange, rollback configurations using each configuration data element,\nquery each state (non-configuration) data element, execute each YANG\nRPC, and receive data through each notification statement.", + "text": "The VNF or PNF **MUST** support a NETCONF server that can be mounted on\nOpenDaylight (client) and perform the operations of: modify, update,\nchange, rollback configurations using each configuration data element,\nquery each state (non-configuration) data element, execute each YANG\nRPC, and receive data through each notification statement.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-26567", - "text": "The xNF Package **MUST** include a run list of\nroles/cookbooks/recipes, for each supported xNF action, that will\nperform the desired xNF action in its entirety as specified by ONAP\n(see Section 7.c, APPC/SDN-C APIs and Behavior, for list of xNF\nactions and requirements), when triggered by a chef-client run list\nin JSON file.", + "text": "The VNF or PNF Package **MUST** include a run list of\nroles/cookbooks/recipes, for each supported VNF or PNF action, that will\nperform the desired VNF or PNF action in its entirety as specified by ONAP\n(see Section 7.c, APPC/SDN-C APIs and Behavior, for list of VNF or PNF\nactions and requirements), when triggered by a chef-client run list\nin JSON file.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-26881", - "text": "The xNF provider **MUST** provide the binaries and images\nneeded to instantiate the xNF (xNF and VNFC images).", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { - "id": "R-26885", - "text": "The VNF provider **MUST** provide the binaries and images needed to\ninstantiate the VNF (VNF and VNFC images) either as:\n\n - Local artifact in CSAR: ROOT\\\\Artifacts\\\\ **VNF_Image.bin**\n\n - externally referred (by URI) artifact in Manifest file (also may be\n referred by VNF Descriptor)\n\nNote: Currently, ONAP doesn't have the capability of Image management,\nwe upload the image into VIM/VNFM manually.", + "text": "The VNF provider **MUST** provide the binaries and images\nneeded to instantiate the VNF (VNF and VNFC images).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4010,14 +4523,14 @@ }, { "id": "R-27310", - "text": "The xNF Package **MUST** include all relevant Chef artifacts\n(roles/cookbooks/recipes) required to execute xNF actions requested by\nONAP for loading on appropriate Chef Server.", + "text": "The VNF or PNF Package **MUST** include all relevant Chef artifacts\n(roles/cookbooks/recipes) required to execute VNF or PNF actions requested\nby ONAP for loading on appropriate Chef Server.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-27469", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is creating a *Reserve Port* with an IPv4 address Resource ID\n**SHOULD** use the naming convention\n\n* ``reserve_port_{vm-type}_{network-role}_floating_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{index}`` is the instance of the IPv4 *Reserve Port*\n for the vm-type attached to the network of ``{network-role}``", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is creating a *Reserve Port* with an IPv4 address Resource ID\n**SHOULD** use the naming convention\n\n* ``reserve_port_{vm-type}_{network-role}_floating_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{index}`` is the instance of the IPv4 *Reserve Port*\n for the vm-type attached to the network of ``{network-role}``.\n The ``{index}`` starts at zero and increments by one\n (as described in R-11690).", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -4030,13 +4543,6 @@ "errors": [] }, { - "id": "R-27711", - "text": "The xNF provider **MUST** provide an XML file that contains a\nlist of xNF error codes, descriptions of the error, and possible\ncauses/corrective action.", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { "id": "R-27818", "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", "keyword": "MUST", @@ -4093,15 +4599,8 @@ "errors": [] }, { - "id": "R-28545", - "text": "The xNF **MUST** conform its YANG model to RFC 6060,\n\"YANG - A Data Modeling Language for the Network Configuration\nProtocol (NETCONF)\".", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { "id": "R-28756", - "text": "The xNF **MUST** support ``:partial-lock`` and\n``:partial-unlock`` capabilities, defined in RFC 5717. This\nallows multiple independent clients to each write to a different\npart of the <running> configuration at the same time.", + "text": "The VNF or PNF **MUST** support ``:partial-lock`` and\n``:partial-unlock`` capabilities, defined in RFC 5717. This\nallows multiple independent clients to each write to a different\npart of the <running> configuration at the same time.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4122,21 +4621,28 @@ }, { "id": "R-29324", - "text": "The xNF **SHOULD** implement the protocol operation:\n``copy-config(target, source)`` - Copy the content of the\nconfiguration data store source to the configuration data store target.", + "text": "The VNF or PNF **SHOULD** implement the protocol operation:\n``copy-config(target, source)`` - Copy the content of the\nconfiguration data store source to the configuration data store target.", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { + "id": "R-293901", + "text": "The VNF or PNF CSAR PACKAGE with TOSCA-Metadata **MUST** include following\nadditional keywords pointing to TOSCA files:\n\n - ETSI-Entry-Manifest\n\n - ETSI-Entry-Change-Log\n\nNote: For a CSAR containing a TOSCA-Metadata directory, which includes\nthe TOSCA.meta metadata file. The TOSCA.meta metadata file includes block_0\nwith the Entry-Definitions keyword pointing to a TOSCA definitions YAML\nfile used as entry for parsing the contents of the overall CSAR archive.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-29488", - "text": "The xNF **MUST** implement the protocol operation:\n``get-config(source, filter`` - Retrieve a (filtered subset of\na) configuration from the configuration data store source.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``get-config(source, filter`` - Retrieve a (filtered subset of\na) configuration from the configuration data store source.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-29495", - "text": "The xNF **MUST** support locking if a common object is\nbeing manipulated by two simultaneous NETCONF configuration operations\non the same xNF within the context of the same writable running data\nstore (e.g., if an interface parameter is being configured then it\nshould be locked out for configuration by a simultaneous configuration\noperation on that same interface parameter).", + "text": "The VNF or PNF **MUST** support locking if a common object is\nbeing manipulated by two simultaneous NETCONF configuration operations\non the same VNF or PNF within the context of the same writable running data\nstore (e.g., if an interface parameter is being configured then it\nshould be locked out for configuration by a simultaneous configuration\noperation on that same interface parameter).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4150,7 +4656,7 @@ }, { "id": "R-29751", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` Resource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_server_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` is the index", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nResource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_server_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` is the index.\n The ``{index}`` **MUST** starts at zero and increment by one\n as described in R-11690.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4192,8 +4698,8 @@ }, { "id": "R-30278", - "text": "The xNF provider **MUST** provide a Resource/Device YANG model\nas a foundation for creating the YANG model for configuration. This will\ninclude xNF attributes/parameters and valid values/attributes configurable\nby policy.", - "keyword": "MUST", + "text": "The VNF or PNF provider **SHOULD** provide a Resource/Device YANG model\nas a foundation for creating the YANG model for configuration.", + "keyword": "SHOULD", "result": "PASS", "errors": [] }, @@ -4213,7 +4719,7 @@ }, { "id": "R-304011", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's\n\n* Resource ID (defined in R-29751)\n* property ``image`` parameter name (defined in R-58670)\n* property ``flavor`` parameter name (defined in R-45188)\n* property ``name`` parameter name (defined in R-54171 & R-87817)\n* property port referenced OS::Neutron::Port Resource ID\n (defined in R-20453)\n\n**MUST** contain the identical ``{vm-type}``\nand **MUST** follow the naming conventions defined\nin R-58670, R-45188, R-54171, R-87817, and R-29751. And the ``{index}`` in\nthe ``OS::Nova::Server`` Resource ID (defined in R-29751) **MUST** match\nthe ``{vm-type_index}`` defined in\nthe ``OS::Nova::Server`` property ``port``\nreferenced ``OS::Neutron::Port`` Resource ID (defined in R-20453).", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's\n\n* Resource ID (defined in R-29751)\n* property ``image`` parameter name (defined in R-58670)\n* property ``flavor`` parameter name (defined in R-45188)\n* property ``name`` parameter name (defined in R-54171 & R-87817)\n* property ``networks`` map property ``port`` value which is a\n ``OS::Neutron::Port`` Resource ID (defined in R-20453)\n referenced using the intrinsic function ``get_attr``\n\n**MUST** contain the identical ``{vm-type}``\nand **MUST** follow the naming conventions defined\nin R-58670, R-45188, R-54171, R-87817, and R-29751. And the ``{index}`` in\nthe ``OS::Nova::Server`` Resource ID (defined in R-29751) **MUST** match\nthe ``{vm-type_index}`` defined in\nthe ``OS::Nova::Server`` property ``networks`` map property ``port``\nreferenced ``OS::Neutron::Port`` Resource ID (defined in R-20453).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4227,7 +4733,7 @@ }, { "id": "R-30654", - "text": "The xNF Package **MUST** have appropriate cookbooks that are\ndesigned to automatically 'rollback' to the original state in case of\nany errors for actions that change state of the xNF (e.g., configure).", + "text": "The VNF or PNF Package **MUST** have appropriate cookbooks that are\ndesigned to automatically 'rollback' to the original state in case of\nany errors for actions that change state of the VNF or PNF (e.g.,\nconfigure).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4269,7 +4775,7 @@ }, { "id": "R-31809", - "text": "The xNF **MUST** support the HealthCheck RPC. The HealthCheck\nRPC executes a xNF Provider-defined xNF HealthCheck over the scope of\nthe entire xNF (e.g., if there are multiple VNFCs, then run a health check,\nas appropriate, for all VNFCs). It returns a 200 OK if the test completes.\nA JSON object is returned indicating state (healthy, unhealthy), scope\nidentifier, time-stamp and one or more blocks containing info and fault\ninformation. If the xNF is unable to run the HealthCheck, return a\nstandard http error code and message.", + "text": "The VNF or PNF **MUST** support the HealthCheck RPC. The HealthCheck\nRPC executes a VNF or PNF Provider-defined VNF or PNF HealthCheck over the\nscope of the entire VNF or PNF (e.g., if there are multiple VNFCs, then\nrun a health check, as appropriate, for all VNFCs). It returns a 200 OK if\nthe test completes. A JSON object is returned indicating state (healthy,\nunhealthy), scope identifier, time-stamp and one or more blocks containing\ninfo and fault information. If the VNF or PNF is unable to run the\nHealthCheck, return a standard http error code and message.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4290,7 +4796,7 @@ }, { "id": "R-32217", - "text": "The xNF **MUST** have routable management IP addresses or FQDNs that\nare reachable via the Ansible Server for the endpoints (VMs) of a\nxNF that playbooks will target. ONAP will initiate requests to the\nAnsible Server for invocation of playbooks against these end\npoints [#7.3.3]_.", + "text": "The VNF or PNF **MUST** have routable management IP addresses or FQDNs that\nare reachable via the Ansible Server for the endpoints (VMs) of a\nVNF or PNF that playbooks will target. ONAP will initiate requests to the\nAnsible Server for invocation of playbooks against these end\npoints [#7.3.3]_.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4332,14 +4838,14 @@ }, { "id": "R-328086", - "text": "The xNF **MUST**, if serving as a distribution point or anchor point for\nsteering point from source to destination, support the ONAP Controller's\n``DistributeTraffic`` command.", + "text": "The VNF or PNF **MUST**, if serving as a distribution point or anchor point for\nsteering point from source to destination, support the ONAP Controller's\n``DistributeTraffic`` command.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-32981", - "text": "The xNF **MUST** support APPC ``ConfigBackup`` command.", + "text": "The VNF or PNF **MUST** support APPC ``ConfigBackup`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4353,14 +4859,14 @@ }, { "id": "R-332680", - "text": "The xNF **SHOULD** deliver all syslog messages to the VES Collector per the\nspecifications in Monitoring and Management chapter.", + "text": "The VNF or PNF **SHOULD** deliver all syslog messages to the VES Collector per the\nspecifications in Monitoring and Management chapter.", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-33280", - "text": "The xNF **MUST NOT** use any instance specific parameters\nin a playbook.", + "text": "The VNF or PNF **MUST NOT** use any instance specific parameters\nin a playbook.", "keyword": "MUST NOT", "result": "PASS", "errors": [] @@ -4374,7 +4880,7 @@ }, { "id": "R-33694", - "text": "The xNF Package **MUST** include documentation to when applicable,\nprovide calculators needed to convert raw data into appropriate reporting\nartifacts.", + "text": "The VNF or PNF Package **MUST** include documentation to when applicable,\nprovide calculators needed to convert raw data into appropriate reporting\nartifacts.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4387,22 +4893,29 @@ "errors": [] }, { + "id": "R-33878", + "text": "The VNF or PNF **MUST** support one of the following authentication\nmethods for authenticating HTTPS connections to the DCAE VES Event\nListener:\n\n- The preferred method is Certificate Authentication\n\n- The non-preferred option is Basic Authentication.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-33904", - "text": "The xNF Package **MUST** include documentation for each KPI, provide\nlower and upper limits.", + "text": "The VNF or PNF Package **MUST** include documentation for each KPI, provide\nlower and upper limits.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-33946", - "text": "The xNF **MUST** conform to the NETCONF RFC 4741,\n\"NETCONF Configuration Protocol\".", + "text": "The VNF or PNF **MUST** conform to the NETCONF RFC 4741,\n\"NETCONF Configuration Protocol\".", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-33955", - "text": "The xNF **SHOULD** conform its YANG model to RFC 6991,\n\"Common YANG Data Types\".", + "text": "The VNF or PNF **SHOULD** conform its YANG model to RFC 6991,\n\"Common YANG Data Types\".", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -4444,7 +4957,7 @@ }, { "id": "R-34660", - "text": "The xNF **MUST** use the RESTCONF/NETCONF framework used by\nthe ONAP configuration subsystem for synchronous communication.", + "text": "The VNF or PNF **MUST** use the RESTCONF/NETCONF framework used by\nthe ONAP configuration subsystem for synchronous communication.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4458,7 +4971,7 @@ }, { "id": "R-34957", - "text": "The VNF **MUST** provide a method of metrics gathering for each\nlayer's performance to identify/document variances in the allocations so\nthey can be addressed.", + "text": "The VNF **MUST** provide a method of metrics gathering for each\nlayer's performance to identify variances in the allocations so\nthey can be addressed.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4472,7 +4985,7 @@ }, { "id": "R-35401", - "text": "The xNF **MUST** support SSH and allow SSH access by the\nAnsible server to the endpoint VM(s) and comply with the Network\nCloud Service Provider guidelines for authentication and access.", + "text": "The VNF or PNF **MUST** support SSH and allow SSH access by the\nAnsible server to the endpoint VM(s) and comply with the Network\nCloud Service Provider guidelines for authentication and access.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4493,21 +5006,21 @@ }, { "id": "R-35666", - "text": "If a VNF has an internal network, the VNF Heat Orchestration Template\n**MUST** include the heat resources to create the internal network.", + "text": "If a VNF has an internal network, the VNF Heat Orchestration Template\n**MUST** include the heat resources to create the internal network.\n\nA VNF's Internal Network is created using Neutron Heat Resources\n(i.e., ``OS::Neutron::Net``, ``OS::Neutron::Subnet``) and/or\nContrail Heat Resources (i.e., ``OS::ContrailV2::VirtualNetwork``,\n``ContrailV2::NetworkIpam``).", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-35735", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 Virtual IP (VIP)\naddress is assigned via ONAP automation\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as type ``string``.", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv6 VIP is required to be supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nAs noted in the introduction to this section, the ONAP data model\ncan only support one IPv6 VIP address.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-35851", - "text": "The xNF Package **MUST** include xNF topology that describes\nbasic network and application connectivity internal and external to the\nxNF including Link type, KPIs, Bandwidth, latency, jitter, QoS (if\napplicable) for each interface.", + "text": "The VNF HEAT Package\u00a0**MUST**\u00a0include VNF topology that describes basic\nnetwork and application connectivity internal and external to the VNF\nincluding Link type, KPIs, Bandwidth, latency, jitter, QoS (if applicable)\nfor each interface.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4521,14 +5034,14 @@ }, { "id": "R-35960", - "text": "The xNF Package **MUST** include documentation which must include\nall events, severity level (e.g., informational, warning, error) and\ndescriptions including causes/fixes if applicable for the event.", + "text": "The VNF or PNF Package **MUST** include documentation which must include\nall events, severity level (e.g., informational, warning, error) and\ndescriptions including causes/fixes if applicable for the event.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-36280", - "text": "The xNF provider **MUST** provide documentation describing\nxNF Functional Capabilities that are utilized to operationalize the\nxNF and compose complex services.", + "text": "The VNF or PNF Documentation Package **MUST** describe the\nVNF or PNF Functional Capabilities that are utilized to operationalize the\nVNF or PNF and compose complex services.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4619,7 +5132,7 @@ }, { "id": "R-37929", - "text": "The xNF **MUST** accept all necessary instance specific\ndata from the environment or node object attributes for the xNF\nin roles/cookbooks/recipes invoked for a xNF action.", + "text": "The VNF or PNF **MUST** accept all necessary instance specific\ndata from the environment or node object attributes for the VNF or PNF\nin roles/cookbooks/recipes invoked for a VNF or PNF action.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4640,7 +5153,7 @@ }, { "id": "R-384337", - "text": "The VNF documentation **MUST** contain a list of the files within the VNF\npackage that are static during the VNF's runtime.", + "text": "The VNF Documentation Package **MUST** contain a list of the files within the VNF\npackage that are static during the VNF's runtime.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4703,7 +5216,7 @@ }, { "id": "R-40293", - "text": "The xNF **MUST** make available playbooks that conform\nto the ONAP requirement.", + "text": "The VNF or PNF **MUST** make available playbooks that conform\nto the ONAP requirement.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4738,14 +5251,14 @@ }, { "id": "R-40820", - "text": "The VNF provider MUST enumerate all of the open source licenses\ntheir VNF(s) incorporate. CSAR License directory as per ETSI SOL004.\n\nfor example ROOT\\\\Licenses\\\\ **License_term.txt**", + "text": "The VNF or PNF TOSCA PACKAGE **MUST** enumerate all of the open source\nlicenses their VNF(s) incorporate. CSAR License directory as per ETSI\nSOL004.\n\nfor example ROOT\\\\Licenses\\\\ **License_term.txt**", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-40827", - "text": "The xNF provider **MUST** enumerate all of the open\nsource licenses their xNF(s) incorporate.", + "text": "The VNF or PNF provider **MUST** enumerate all of the open\nsource licenses their VNF or PNF(s) incorporate.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4787,14 +5300,21 @@ }, { "id": "R-41430", - "text": "The xNF **MUST** support APPC/SDN-C ``HealthCheck`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``HealthCheck`` command.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-41492", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 Virtual IP (VIP)\naddress is assigned via ONAP automation\nusing the property ``allowed_address_pairs``\nmap property ``ip_address`` and\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as type ``string``.", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv4 VIP is required to be supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nAs noted in the introduction to this section, the ONAP data model\ncan only support one IPv4 VIP address.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-41493", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv4 VIP address and/or IPv6 VIP address\nis **not** supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\n\n* Parameter name **MAY** use any naming convention. That is, there is no\n ONAP mandatory parameter naming convention.\n* Parameter **MAY** be declared as type ``string`` or type\n``comma_delimited_list``.\n\nAnd the ``OS::Neutron::Port`` resource **MUST** contain\nresource-level ``metadata`` (not property-level).\n\nAnd the ``metadata`` format **MUST** must contain the\nkey value ``aap_exempt`` with a list of all\n``allowed_address_pairs`` map property ``ip_address`` parameters\n**not** supported by the ONAP data model.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4808,7 +5328,7 @@ }, { "id": "R-41829", - "text": "The xNF **MUST** be able to specify the granularity of the\nlock via a restricted or full XPath expression.", + "text": "The VNF or PNF **MUST** be able to specify the granularity of the\nlock via a restricted or full XPath expression.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4821,13 +5341,6 @@ "errors": [] }, { - "id": "R-41956", - "text": "If a VNF requires ONAP to assign a Virtual IP (VIP) Address to\nports connected an external network, the port\n**MUST NOT** have more than one IPv6 VIP address.", - "keyword": "MUST NOT", - "result": "PASS", - "errors": [] - }, - { "id": "R-41994", "text": "The VNF **MUST** support the use of X.509 certificates issued from any\nCertificate Authority (CA) that is compliant with RFC5280, e.g., a public\nCA such as DigiCert or Let's Encrypt, or an RFC5280 compliant Operator\nCA.\n\nNote: The VNF provider cannot require the use of self-signed certificates\nin an Operator's run time environment.", "keyword": "MUST", @@ -4836,14 +5349,14 @@ }, { "id": "R-42018", - "text": "The xNF Package **MUST** include documentation which must include\nall events (fault, measurement for xNF Scaling, Syslogs, State Change\nand Mobile Flow), that need to be collected at each VM, VNFC (defined in `VNF Guidelines <https://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines/vnf_guidelines.html>`__ ) and for the overall xNF.", + "text": "The VNF or PNF Package **MUST** include documentation which must include\nall events (fault, measurement for VNF or PNF Scaling, Syslogs, State Change\nand Mobile Flow), that need to be collected at each VM, VNFC (defined in `VNF Guidelines <https://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines.html>`__ ) and for the overall VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-42140", - "text": "The xNF **MUST** respond to data requests from ONAP as soon\nas those requests are received, as a synchronous response.", + "text": "The VNF or PNF **MUST** respond to data requests from ONAP as soon\nas those requests are received, as a synchronous response.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4857,7 +5370,7 @@ }, { "id": "R-42366", - "text": "The xNF **MUST** support secure connections and transports such as\nTransport Layer Security (TLS) protocol\n[`RFC5246 <https://tools.ietf.org/html/rfc5246>`_] and should adhere to\nthe best current practices outlined in\n`RFC7525 <https://tools.ietf.org/html/rfc7525>`_.", + "text": "The VNF or PNF **MUST** support secure connections and transports such as\nTransport Layer Security (TLS) protocol\n[`RFC5246 <https://tools.ietf.org/html/rfc5246>`_] and should adhere to\nthe best current practices outlined in\n`RFC7525 <https://tools.ietf.org/html/rfc7525>`_.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4878,14 +5391,14 @@ }, { "id": "R-43253", - "text": "The xNF **MUST** use playbooks designed to allow Ansible\nServer to infer failure or success based on the \"PLAY_RECAP\" capability.\n\n**Note**: There are cases where playbooks need to interpret results\nof a task and then determine success or failure and return result\naccordingly (failure for failed tasks).", + "text": "The VNF or PNF **MUST** use playbooks designed to allow Ansible\nServer to infer failure or success based on the \"PLAY_RECAP\" capability.\n\n**Note**: There are cases where playbooks need to interpret results\nof a task and then determine success or failure and return result\naccordingly (failure for failed tasks).", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-43327", - "text": "The xNF **SHOULD** use `Modeling JSON text with YANG\n<https://tools.ietf.org/html/rfc7951>`_, If YANG models need to be\ntranslated to and from JSON{RFC7951]. YANG configuration and content can\nbe represented via JSON, consistent with Avro, as described in \"Encoding\nand Serialization\" section.", + "text": "The VNF or PNF **SHOULD** use `Modeling JSON text with YANG\n<https://tools.ietf.org/html/rfc7951>`_, If YANG models need to be\ntranslated to and from JSON{RFC7951]. YANG configuration and content can\nbe represented via JSON, consistent with Avro, as described in \"Encoding\nand Serialization\" section.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -4899,7 +5412,14 @@ }, { "id": "R-43353", - "text": "The xNF **MUST** return control from Ansible Playbooks only after all\ntasks performed by playbook are fully complete, signaling that the\nplaybook completed all tasks. When starting services, return control\nonly after all services are up. This is critical for workflows where\nthe next steps are dependent on prior tasks being fully completed.", + "text": "The VNF or PNF **MUST** return control from Ansible Playbooks only after\nall tasks performed by playbook are fully complete, signaling that the\nplaybook completed all tasks. When starting services, return control\nonly after all services are up. This is critical for workflows where\nthe next steps are dependent on prior tasks being fully completed.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-43387", + "text": "If the VNF or PNF is using Certificate Authentication, the\nVNF or PNF **MUST** support mutual TLS authentication and the Subject\nName in the end-entity certificate MUST be used according to\n`RFC5280 <https://tools.ietf.org/html/rfc5280>`_.\n\nNote: In mutual TLS authentication, the client (VNF or PNF) must\nauthenticate the server (DCAE) certificate and must provide its own\nX.509v3 end-entity certificate to the server for authentication.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4927,7 +5447,7 @@ }, { "id": "R-43958", - "text": "The xNF Package **MUST** include documentation describing\nthe tests that were conducted by the xNF provider and the test results.", + "text": "The VNF Documentation Package **MUST** describe\nthe tests that were conducted by the VNF provider and the test results.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4941,21 +5461,21 @@ }, { "id": "R-44013", - "text": "The xNF **MUST** populate an attribute, defined as node\n['PushJobOutput'] with the desired output on all nodes in the push job\nthat execute chef-client run if the xNF action requires the output of a\nchef-client run be made available (e.g., get running configuration).", + "text": "The VNF or PNF **MUST** populate an attribute, defined as node\n['PushJobOutput'] with the desired output on all nodes in the push job\nthat execute chef-client run if the VNF or PNF action requires the output\nof a chef-client run be made available (e.g., get running configuration).", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-440220", - "text": "The xNF **SHOULD** support File transferring protocol, such as FTPES or SFTP,\nwhen supporting the event-driven bulk transfer of monitoring data.", + "text": "The VNF or PNF **SHOULD** support File transferring protocol, such as FTPES or SFTP,\nwhen supporting the event-driven bulk transfer of monitoring data.", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-44125", - "text": "The xNF provider **MUST** agree to the process that can\nbe met by Service Provider reporting infrastructure. The Contract\nshall define the reporting process and the available reporting tools.", + "text": "The VNF or PNF provider **MUST** agree to the process that can\nbe met by Service Provider reporting infrastructure. The Contract\nshall define the reporting process and the available reporting tools.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4969,14 +5489,14 @@ }, { "id": "R-44281", - "text": "The xNF **MUST** implement the protocol operation:\n``edit-config(target, default-operation, test-option, error-option,\nconfig)`` - Edit the target configuration data store by merging,\nreplacing, creating, or deleting new config elements.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``edit-config(target, default-operation, test-option, error-option,\nconfig)`` - Edit the target configuration data store by merging,\nreplacing, creating, or deleting new config elements.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-44290", - "text": "The xNF **MUST** control access to ONAP and to xNFs, and creation\nof connections, through secure credentials, log-on and exchange mechanisms.", + "text": "The VNF or PNF **MUST** control access to ONAP and to VNFs or PNFs, and creation\nof connections, through secure credentials, log-on and exchange mechanisms.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4990,7 +5510,7 @@ }, { "id": "R-44569", - "text": "The xNF provider **MUST NOT** require additional\ninfrastructure such as a xNF provider license server for xNF provider\nfunctions and metrics.", + "text": "The VNF or PNF provider **MUST NOT** require additional\ninfrastructure such as a VNF or PNF provider license server for VNF or PNF provider\nfunctions and metrics.", "keyword": "MUST NOT", "result": "PASS", "errors": [] @@ -5018,7 +5538,7 @@ }, { "id": "R-45197", - "text": "The xNF **MUST** define the \"from=\" clause to provide the list of IP\naddresses of the Ansible Servers in the Cluster, separated by coma, to\nrestrict use of the SSH key pair to elements that are part of the Ansible\nCluster owner of the issued and assigned mechanized user ID.", + "text": "The VNF or PNF **MUST** define the \"from=\" clause to provide the list of IP\naddresses of the Ansible Servers in the Cluster, separated by coma, to\nrestrict use of the SSH key pair to elements that are part of the Ansible\nCluster owner of the issued and assigned mechanized user ID.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5039,7 +5559,7 @@ }, { "id": "R-45856", - "text": "The xNF **MUST** support APPC/SDN-C ``UpgradePostCheck`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``UpgradePostCheck`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5053,21 +5573,21 @@ }, { "id": "R-46119", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::CinderVolume``\n**MAY** be defined in a Base Module.", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume``\n**MAY** be defined in a Base Module.", "keyword": "MAY", "result": "PASS", "errors": [] }, { "id": "R-46128", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv6 Address on a port attached to an external network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type\n attached to the network of {network-role}\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` is the index of the IPv6 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv6 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an external network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` references the instance of the IPv6 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv6 address is configured on the\n virtual machine interface.", "keyword": "MUST", "result": "SKIP", "errors": [] }, { "id": "R-46290", - "text": "The xNF **MUST** respond to an ONAP request to deliver granular\ndata on device or subsystem status or performance, referencing the YANG\nconfiguration model for the xNF by returning the requested data elements.", + "text": "The VNF or PNF **MUST** respond to an ONAP request to deliver granular\ndata on device or subsystem status or performance, referencing the YANG\nconfiguration model for the VNF or PNF by returning the requested data elements.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5095,7 +5615,7 @@ }, { "id": "R-46567", - "text": "The xNF Package **MUST** include configuration scripts\nfor boot sequence and configuration.", + "text": "The VNF or PNF Package **MUST** include configuration scripts\nfor boot sequence and configuration.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5151,7 +5671,7 @@ }, { "id": "R-47068", - "text": "The xNF **MAY** expose a single endpoint that is\nresponsible for all functionality.", + "text": "The VNF or PNF **MAY** expose a single endpoint that is\nresponsible for all functionality.", "keyword": "MAY", "result": "PASS", "errors": [] @@ -5172,14 +5692,14 @@ }, { "id": "R-47597", - "text": "The xNF **MUST** carry data in motion only over secure connections.", + "text": "The VNF or PNF **MUST** carry data in motion only over secure connections.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-47849", - "text": "The xNF provider **MUST** support the metadata about\nlicenses (and their applicable entitlements) as defined in this\ndocument for xNF software, and any license keys required to authorize\nuse of the xNF software. This metadata will be used to facilitate\nonboarding the xNF into the ONAP environment and automating processes\nfor putting the licenses into use and managing the full lifecycle of\nthe licenses. The details of this license model are described in\nTables C1 to C8 in the Appendix.\n\nNote: License metadata support in ONAP is not currently available\nand planned for 1Q 2018.", + "text": "The VNF or PNF provider **MUST** support the metadata about\nlicenses (and their applicable entitlements) as defined in this\nspecification for VNF or PNF software, and any license keys required to authorize\nuse of the VNF or PNF software. This metadata will be used to facilitate\nonboarding the VNF or PNF into the ONAP environment and automating processes\nfor putting the licenses into use and managing the full lifecycle of\nthe licenses. The details of this license model are described in\nTables C1 to C8 in the Appendix.\n\nNote: License metadata support in ONAP is not currently available\nand planned for 1Q 2018.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5221,7 +5741,7 @@ }, { "id": "R-48247", - "text": "The xNF **MUST** support APPC ``ConfigRestore`` command.", + "text": "The VNF or PNF **MUST** support APPC ``ConfigRestore`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5241,15 +5761,22 @@ "errors": [] }, { + "id": "R-484843", + "text": "The PNFD provided by a PNF vendor\u00a0**MUST**\u00a0comply with the following Data\nTypes as specified in ETSI NFV-SOL001 standard:\n\n - tosca.datatypes.nfv.CpProtocolData\n\n - tosca.datatypes.nfv.AddressData\n\n - tosca.datatypes.nfv.L2AddressData\n\n - tosca.datatypes.nfv.L3AddressData\n\n - tosca.datatypes.nfv.LocationInfo\n\n - tosca.datatypes.nfv.CivicAddressElement", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-48596", - "text": "The xNF Package **MUST** include documentation describing\nthe characteristics for the xNF reliability and high availability.", + "text": "The VNF or PNF Documentation Package **MUST** describe\nthe characteristics for the VNF or PNF reliability and high availability.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-48698", - "text": "The xNF **MUST** utilize information from key value pairs that will be\nprovided by the Ansible Server as \"extra-vars\" during invocation to\nexecute the desired xNF action. The \"extra-vars\" attribute-value pairs\nare passed to the Ansible Server by an APPC/SDN-C as part of the\nRest API request. If the playbook requires files, they must also be\nsupplied using the methodology detailed in the Ansible Server API, unless\nthey are bundled with playbooks, example, generic templates. Any files\ncontaining instance specific info (attribute-value pairs), not obtainable\nfrom any ONAP inventory databases or other sources, referenced and used an\ninput by playbooks, shall be provisioned (and distributed) in advance of\nuse, e.g., xNF instantiation. Recommendation is to avoid these instance\nspecific, manually created in advance of instantiation, files.", + "text": "The VNF or PNF **MUST** utilize information from key value pairs that will\nbe provided by the Ansible Server as \"extra-vars\" during invocation to\nexecute the desired VNF or PNF action. The \"extra-vars\" attribute-value\npairs are passed to the Ansible Server by an APPC/SDN-C as part of the\nRest API request. If the playbook requires files, they must also be\nsupplied using the methodology detailed in the Ansible Server API, unless\nthey are bundled with playbooks, example, generic templates. Any files\ncontaining instance specific info (attribute-value pairs), not obtainable\nfrom any ONAP inventory databases or other sources, referenced and used an\ninput by playbooks, shall be provisioned (and distributed) in advance of\nuse, e.g., VNF or PNF instantiation. Recommendation is to avoid these\ninstance specific, manually created in advance of instantiation, files.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5284,21 +5811,21 @@ }, { "id": "R-49036", - "text": "The xNF **SHOULD** conform its YANG model to RFC 7277,\n\"A YANG Data Model for IP Management\".", + "text": "The VNF or PNF **SHOULD** conform its YANG model to RFC 7277,\n\"A YANG Data Model for IP Management\".", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-49109", - "text": "The VNF **MUST** support HTTP/S using TLS v1.2 or higher\nwith strong cryptographic ciphers.", + "text": "The VNF or PNF **MUST** support HTTPS using TLS v1.2 or higher\nwith strong cryptographic ciphers.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-49145", - "text": "The xNF **MUST** implement ``:confirmed-commit`` If\n``:candidate`` is supported.", + "text": "The VNF or PNF **MUST** implement ``:confirmed-commit`` If\n``:candidate`` is supported.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5319,28 +5846,28 @@ }, { "id": "R-49396", - "text": "The xNF **MUST** support each APPC/SDN-C xNF action\nby invocation of **one** playbook [#7.3.4]_. The playbook will be responsible\nfor executing all necessary tasks (as well as calling other playbooks)\nto complete the request.", + "text": "The VNF or PNF **MUST** support each APPC/SDN-C VNF or PNF action\nby invocation of **one** playbook [#7.3.4]_. The playbook will be\nresponsible for executing all necessary tasks (as well as calling other\nplaybooks) to complete the request.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-49466", - "text": "The xNF **MUST** support APPC/SDN-C ``UpgradeSoftware`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``UpgradeSoftware`` command.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-49751", - "text": "The xNF **MUST** support Ansible playbooks that are compatible with\nAnsible version 2.6 or later.", + "text": "The VNF or PNF **MUST** support Ansible playbooks that are compatible with\nAnsible version 2.6 or later.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-49911", - "text": "The xNF provider **MUST** assign a new point release to the updated\nplaybook set. The functionality of a new playbook set must be tested before\nit is deployed to the production.", + "text": "The VNF or PNF provider **MUST** assign a new point release to the updated\nplaybook set. The functionality of a new playbook set must be tested before\nit is deployed to the production.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -5354,7 +5881,7 @@ }, { "id": "R-50252", - "text": "The xNF **MUST** write to a response file in JSON format that will be\nretrieved and made available by the Ansible Server if, as part of a xNF\naction (e.g., audit), a playbook is required to return any xNF\ninformation/response. The text files must be written in the main playbook\nhome directory, in JSON format. The JSON file must be created for the xNF\nwith the name '<xNF name>_results.txt'. All playbook output results, for\nall xNF VMs, to be provided as a response to the request, must be written\nto this response file.", + "text": "The VNF or PNF **MUST** write to a response file in JSON format that will\nbe retrieved and made available by the Ansible Server if, as part of a VNF\nor PNF action (e.g., audit), a playbook is required to return any VNF or\nPNF information/response. The text files must be written in the main\nplaybook home directory, in JSON format. The JSON file must be created for\nthe VNF or PNF with the name '<VNF or PNF name>_results.txt'. All playbook\noutput results, for all VNF or PNF VMs, to be provided as a response to the\nrequest, must be written to this response file.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5368,14 +5895,21 @@ }, { "id": "R-50468", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` that is attaching to an internal network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` is the instance of the vmi on the vm-type\n attached to the network of ``{network-role}``", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` Resource ID\nthat is attaching to an internal network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.", "keyword": "MUST", "result": "SKIP", "errors": [] }, { + "id": "R-506221", + "text": "The VNF or PNF TOSCA CSAR file **MUST** be a zip file with .csar extension.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-50816", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MAY**\ncontain the key/value pair ``vf_module_index``\nand the value **MUST** be obtained via a ``get_param``.", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata``\nkey/value pair ``vf_module_index``\nvalue **MUST** be obtained via a ``get_param``.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5389,7 +5923,7 @@ }, { "id": "R-51347", - "text": "The VNF package **MUST** be arranged as a CSAR archive as specified in\nTOSCA Simple Profile in YAML 1.2.", + "text": "The VNF or PNF CSAR package **MUST** be arranged as a CSAR archive as\nspecified in TOSCA Simple Profile in YAML 1.2.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5403,7 +5937,7 @@ }, { "id": "R-51442", - "text": "The xNF **SHOULD** use playbooks that are designed to\nautomatically 'rollback' to the original state in case of any errors\nfor actions that change state of the xNF (e.g., configure).\n\n**Note**: In case rollback at the playbook level is not supported or\npossible, the xNF provider shall provide alternative rollback\nmechanism (e.g., for a small xNF the rollback mechanism may rely\non workflow to terminate and re-instantiate VNF VMs and then re-run\nplaybook(s)). Backing up updated files is also recommended to support\nrollback when soft rollback is feasible.", + "text": "The VNF or PNF **SHOULD** use playbooks that are designed to\nautomatically 'rollback' to the original state in case of any errors\nfor actions that change state of the VNF or PNF (e.g., configure).\n\n**Note**: In case rollback at the playbook level is not supported or\npossible, the VNF or PNF provider shall provide alternative rollback\nmechanism (e.g., for a small VNF or PNF the rollback mechanism may rely\non workflow to terminate and re-instantiate VNF VMs and then re-run\nplaybook(s)). Backing up updated files is also recommended to support\nrollback when soft rollback is feasible.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -5417,7 +5951,7 @@ }, { "id": "R-520802", - "text": "The xNF provider **MUST** provide a YAML file formatted in adherence with\nthe :doc:`VES Event Registration specification <../../../../vnfsdk/model.git/docs/files/VESEventRegistration_3_0>`\nthat defines the following information for each event produced by the VNF:\n\n* ``eventName``\n* Required fields\n* Optional fields\n* Any special handling to be performed for that event", + "text": "The VNF or PNF provider **MUST** provide a YAML file formatted in adherence with\nthe :ref:`VES Event Registration specification <ves_event_registration_3_2>`\nthat defines the following information for each event produced by the VNF:\n\n* ``eventName``\n* Required fields\n* Optional fields\n* Any special handling to be performed for that event", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5452,28 +5986,28 @@ }, { "id": "R-528866", - "text": "The VNF **MUST** produce VES events that include the following mandatory\nfields in the common event header.\n\n * ``domain`` - the event domain enumeration\n * ``eventId`` - the event key unique to the event source\n * ``eventName`` - the unique event name\n * ``lastEpochMicrosec`` - the latest unix time (aka epoch time) associated\n with the event\n * ``priority`` - the processing priority enumeration\n * ``reportingEntityName`` - name of the entity reporting the event or\n detecting a problem in another xNF\n * ``sequence`` - the ordering of events communicated by an event source\n * ``sourceName`` - name of the entity experiencing the event issue, which\n may be detected and reported by a separate reporting entity\n * ``startEpochMicrosec`` - the earliest unix time (aka epoch time)\n associated with the event\n * ``version`` - the version of the event header\n * ``vesEventListenerVersion`` - Version of the VES event listener API spec\n that this event is compliant with", + "text": "The VNF **MUST** produce VES events that include the following mandatory\nfields in the common event header.\n\n * ``domain`` - the event domain enumeration\n * ``eventId`` - the event key unique to the event source\n * ``eventName`` - the unique event name\n * ``lastEpochMicrosec`` - the latest unix time (aka epoch time) associated\n with the event\n * ``priority`` - the processing priority enumeration\n * ``reportingEntityName`` - name of the entity reporting the event or\n detecting a problem in another VNF or PNF\n * ``sequence`` - the ordering of events communicated by an event source\n * ``sourceName`` - name of the entity experiencing the event issue, which\n may be detected and reported by a separate reporting entity\n * ``startEpochMicrosec`` - the earliest unix time (aka epoch time)\n associated with the event\n * ``version`` - the version of the event header\n * ``vesEventListenerVersion`` - Version of the VES event listener API spec\n that this event is compliant with", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-53015", - "text": "The xNF **MUST** apply locking based on the sequence of\nNETCONF operations, with the first configuration operation locking\nout all others until completed.", + "text": "The VNF or PNF **MUST** apply locking based on the sequence of\nNETCONF operations, with the first configuration operation locking\nout all others until completed.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-53310", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv4 Address on a port attached to an external network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the {vm-type}\n* ``{network-role}`` is the network-role of the network that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type attached to the network of {network-role}\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` is the index of the IPv4 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv4 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an external network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network that the\n virtual machine interface is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` references the instance of the IPv4 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv4 address is configured on the\n virtual machine interface.", "keyword": "MUST", "result": "SKIP", "errors": [] }, { "id": "R-53317", - "text": "The xNF **MUST** conform its YANG model to RFC 6087,\n\"Guidelines for Authors and Reviewers of YANG Data Model Documents\".", + "text": "The VNF or PNF **MUST** conform its YANG model to RFC 6087,\n\"Guidelines for Authors and Reviewers of YANG Data Model specification\".", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5486,8 +6020,15 @@ "errors": [] }, { + "id": "R-535009", + "text": "The PNFD provided by a PNF vendor\u00a0**MUST**\u00a0comply with the following Node\nTypes as specified in ETSI NFV-SOL001 standard:\n\n - tosca.nodes.nfv.PNF\n\n - tosca.nodes.nfv.PnfExtCp\n\n - tosca.nodes.nfv.Cp", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-53598", - "text": "The xNF Package **MUST** include documentation to, when relevant,\nprovide a threshold crossing alert point for each KPI and describe the\nsignificance of the threshold crossing.", + "text": "The VNF or PNF Documentation Package **MUST**, when relevant,\nprovide a threshold crossing alert point for each KPI and describe the\nsignificance of the threshold crossing.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5508,7 +6049,7 @@ }, { "id": "R-54190", - "text": "The xNF **MUST** release locks to prevent permanent lock-outs\nwhen/if a session applying the lock is terminated (e.g., SSH session\nis terminated).", + "text": "The VNF or PNF **MUST** release locks to prevent permanent lock-outs\nwhen/if a session applying the lock is terminated (e.g., SSH session\nis terminated).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5529,7 +6070,7 @@ }, { "id": "R-54373", - "text": "The xNF **MUST** have Python >= 2.6 on the endpoint VM(s)\nof a xNF on which an Ansible playbook will be executed.", + "text": "The VNF or PNF **MUST** have Python >= 2.6 on the endpoint VM(s)\nof a VNF or PNF on which an Ansible playbook will be executed.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5605,6 +6146,13 @@ "errors": [] }, { + "id": "R-55634", + "text": "If VNF or PNF is using Basic Authentication, then the VNF or PNF\n**MUST** be in compliance with\n`RFC7617 <https://tools.ietf.org/html/rfc7617>`_ for authenticating HTTPS\nconnections to the DCAE VES Event Listener.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-55802", "text": "The VNF Package **MUST** include VM requirements via a Heat\ntemplate that provides the necessary data for scaling/growth VM\nspecifications.\n\nNote: Must comply with the *Heat requirements in 5.b*.", "keyword": "MUST", @@ -5634,7 +6182,7 @@ }, { "id": "R-56385", - "text": "The xNF **MUST** support APPC ``Audit`` command.", + "text": "The VNF or PNF **MUST** support APPC ``Audit`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5669,7 +6217,7 @@ }, { "id": "R-56815", - "text": "The xNF Package **MUST** include documentation describing\nsupported xNF scaling capabilities and capacity limits (e.g., number\nof users, bandwidth, throughput, concurrent calls).", + "text": "The VNF or PNF Documentation Package **MUST** describe\nsupported VNF or PNF scaling capabilities and capacity limits (e.g., number\nof users, bandwidth, throughput, concurrent calls).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5690,7 +6238,14 @@ }, { "id": "R-570134", - "text": "The events produced by the xNF **MUST** must be compliant with the common\nevent format defined in the\n:doc:`VES Event Listener<../../../../vnfsdk/model.git/docs/files/VESEventListener_7_0_1>`\nspecification.", + "text": "The events produced by the VNF or PNF **MUST** must be compliant with the common\nevent format defined in the\n:ref:`VES Event Listener<ves_event_listener_7_1>`\nspecification.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-57019", + "text": "The PNF TOSCA CSAR PACKAGE Manifest file **MUST** start with the PNF\npackage metadata in the form of a name-value pairs. Each pair shall appear\non a different line. The name is specified as following:\n\n - pnfd_provider\n\n - pnfd_name\n\n - pnfd_release_date_time\n\n - pnfd_archive_version", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5724,13 +6279,6 @@ "errors": [] }, { - "id": "R-579051", - "text": "The PNF **MAY** support a HTTP connection to the DCAE VES Event Listener.\n\nNote: HTTP is allowed but not recommended.", - "keyword": "MAY", - "result": "PASS", - "errors": [] - }, - { "id": "R-581188", "text": "A failed authentication attempt **MUST NOT** identify the reason for the\nfailure to the user, only that the authentication failed.", "keyword": "MUST NOT", @@ -5739,14 +6287,14 @@ }, { "id": "R-58301", - "text": "The xNF **SHOULD NOT** use playbooks that make requests to\nCloud resources e.g. Openstack (nova, neutron, glance, heat, etc.);\ntherefore, there is no use for Cloud specific variables like Openstack\nUUIDs in Ansible Playbook related artifacts.\n\n**Rationale**: Flows that require interactions with Cloud services e.g.\nOpenstack shall rely on workflows run by an Orchestrator\n(Change Management) or other capability (such as a control loop or\nOperations GUI) outside Ansible Server which can be executed by a\nAPPC/SDN-C. There are policies, as part of Control Loop\nmodels, that send remediation action requests to an APPC/SDN-C; these\nare triggered as a response to an event or correlated events published\nto Event Bus.", + "text": "The VNF or PNF **SHOULD NOT** use playbooks that make requests to\nCloud resources e.g. Openstack (nova, neutron, glance, heat, etc.);\ntherefore, there is no use for Cloud specific variables like Openstack\nUUIDs in Ansible Playbook related artifacts.\n\n**Rationale**: Flows that require interactions with Cloud services e.g.\nOpenstack shall rely on workflows run by an Orchestrator\n(Change Management) or other capability (such as a control loop or\nOperations GUI) outside Ansible Server which can be executed by a\nAPPC/SDN-C. There are policies, as part of Control Loop\nmodels, that send remediation action requests to an APPC/SDN-C; these\nare triggered as a response to an event or correlated events published\nto Event Bus.", "keyword": "SHOULD NOT", "result": "PASS", "errors": [] }, { "id": "R-58358", - "text": "The xNF **MUST** implement the ``:with-defaults`` capability\n[RFC6243].", + "text": "The VNF or PNF **MUST** implement the ``:with-defaults`` capability\n[RFC6243].", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5781,14 +6329,14 @@ }, { "id": "R-58775", - "text": "The xNF provider **MUST** provide software components that\ncan be packaged with/near the xNF, if needed, to simulate any functions\nor systems that connect to the xNF system under test. This component is\nnecessary only if the existing testing environment does not have the\nnecessary simulators.", + "text": "The VNF provider **MUST** provide software components that\ncan be packaged with/near the VNF, if needed, to simulate any functions\nor systems that connect to the VNF system under test. This component is\nnecessary only if the existing testing environment does not have the\nnecessary simulators.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-589037", - "text": "A VNF Heat Orchestration Template's Cinder Volume Module resources section\n**MUST** only be defined using one of the following:\n\n* one of more ``OS::Cinder::Volume`` resources\n* one or more ``OS::Heat::ResourceGroup`` resources that call a nested YAML\n file that contains only ``OS::Cinder::Volume`` resources\n* a resource that calls a nested YAML file (static nesting) that contains\n only ``OS::Cinder::Volume`` resources", + "text": "A VNF Heat Orchestration Template's Cinder Volume Module ``resources:``\nsection\n**MUST** only be defined using one of the following:\n\n* one of more ``OS::Cinder::Volume`` resources\n* one or more ``OS::Heat::ResourceGroup`` resources that call a nested YAML\n file that contains only ``OS::Cinder::Volume`` resources\n* a resource that calls a nested YAML file (static nesting) that contains\n only ``OS::Cinder::Volume`` resources", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5809,7 +6357,7 @@ }, { "id": "R-59434", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Subnet``\nResource ID **SHOULD** use the naming convention\n\n* ``int_{network-role}_subnet_{index}``\n\nwhere\n\n* ``{network-role}`` is the network-role\n* ``{index}`` is the ``{index}`` of the subnet of the network", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Subnet``\nResource ID **SHOULD** use the naming convention\n\n* ``int_{network-role}_subnet_{index}``\n\nwhere\n\n* ``{network-role}`` is the network-role\n* ``{index}`` is the ``{index}`` of the subnet of the network.\n The ``{index}`` starts at zero and increments by one\n (as described in R-11690).", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -5829,8 +6377,15 @@ "errors": [] }, { + "id": "R-596064", + "text": "The PNFD provided by a PNF vendor **MUST** comply with the following Policy\nTypes as specified in ETSI NFV-SOL001 standard:\n\n - tosca.datatypes.nfv.SecurityGroupRule", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-59610", - "text": "The xNF **MUST** implement the data model discovery and\ndownload as defined in [RFC6022].", + "text": "The VNF or PNF **MUST** implement the data model discovery and\ndownload as defined in [RFC6022].", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5858,14 +6413,14 @@ }, { "id": "R-60106", - "text": "The xNF **MUST** implement the protocol operation:\n``get(filter)`` - Retrieve (a filtered subset of) the running\nconfiguration and device state information. This should include\nthe list of xNF supported schemas.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``get(filter)`` - Retrieve (a filtered subset of) the running\nconfiguration and device state information. This should include\nthe list of VNF or PNF supported schemas.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-60656", - "text": "The xNF **MUST** support sub tree filtering.", + "text": "The VNF or PNF **MUST** support sub tree filtering.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5878,6 +6433,41 @@ "errors": [] }, { + "id": "R-610010", + "text": "A VNF's Heat Orchestration Template's Base Module **MAY** declare zero, one,\nor more than one ``OS::Nova::Server`` resource. A ``OS::Nova::Server``\n**MAY** be created in the base module or a nested yaml file invoked by the\nbase module.", + "keyword": "MAY", + "result": "PASS", + "errors": [] + }, + { + "id": "R-610020", + "text": "If a VNF's Heat Orchestration Template's Base Module contains two or more\n``OS::Nova::Server`` resources (created in the base module itself and/or\nin a nested yaml file invoked by the base module), the ``OS::Nova::Server``\nresources **MAY**\ndefine the same ``{vm-type}`` (as defined in R-01455) or **MAY**\ndefine different ``{vm-type}``.\n\nNote that\n\n- there is no constraint on the number of unique ``{vm-type}`` defined in\n the base module.\n- there is no constraint on the number of ``OS::Nova::Server`` resources\n that define the same ``{vm-type}`` in the base module.\n- if an ``OS::Nova::Server`` is created in a nested yaml file invoked by\n the base module, the nested yaml file **MUST NOT** contain more than one\n ``OS::Nova::Server`` resource (as defined in R-17528).", + "keyword": "MAY", + "result": "PASS", + "errors": [] + }, + { + "id": "R-610030", + "text": "A VNF's Heat Orchestration Template's Incremental Module **MUST**\ndeclare one or more ``OS::Nova::Server`` resources. A ``OS::Nova::Server``\n**MAY** be created in the incremental module or a nested yaml file invoked\nby the incremental module.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-610040", + "text": "If a VNF's Heat Orchestration Template's Incremental Module contains two or\nmore ``OS::Nova::Server`` resources, the ``OS::Nova::Server`` resources\n**MAY** define the same ``{vm-type}`` (as defined in R-01455) or **MAY**\ndefine different ``{vm-type}``.\n\nNote that\n\n- there is no constraint on the number of unique ``{vm-type}`` defined in\n the incremental module.\n- there is no constraint on the number of ``OS::Nova::Server`` resources\n that define the same ``{vm-type}`` in the incremental module.\n- if an ``OS::Nova::Server`` is created in a nested yaml file invoked by\n the incremental module, the nested yaml file **MUST NOT** contain more\n than one ``OS::Nova::Server`` resource (as defined in R-17528).", + "keyword": "MAY", + "result": "PASS", + "errors": [] + }, + { + "id": "R-610050", + "text": "The same ``{vm-type}`` for a VNF's Heat Orchestration Template's\n``OS::Nova::Server`` resource (as defined in R-01455) **MAY** exist in\nthe VNF's Heat Orchestration Template's Base Module (or invoked nested yaml\nfile) and/or one or more of the VNF's Heat Orchestration Template's\nIncremental Modules (or invoked nested yaml file).", + "keyword": "MAY", + "result": "PASS", + "errors": [] + }, + { "id": "R-61354", "text": "The VNF **MUST** provide a mechanism (e.g., access control list) to\npermit and/or restrict access to services on the VNF by source,\ndestination, protocol, and/or port.", "keyword": "MUST", @@ -5886,14 +6476,14 @@ }, { "id": "R-62170", - "text": "The xNF **MUST** over-ride any default values for\nconfigurable parameters that can be set by ONAP in the roles,\ncookbooks and recipes.", + "text": "The VNF or PNF **MUST** over-ride any default values for\nconfigurable parameters that can be set by ONAP in the roles,\ncookbooks and recipes.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-62187", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv4 Address on a port attached to an internal network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type\n attached to the network of ``{network-role}``\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` is the index of the IPv4 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv4 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an internal network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` references the instance of the IPv4 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv4 address is configured on the\n virtual machine interface.", "keyword": "MUST", "result": "SKIP", "errors": [] @@ -5907,7 +6497,7 @@ }, { "id": "R-62468", - "text": "The xNF **MUST** allow all configuration data to be\nedited through a NETCONF <edit-config> operation. Proprietary\nNETCONF RPCs that make configuration changes are not sufficient.", + "text": "The VNF or PNF **MUST** allow all configuration data to be\nedited through a NETCONF <edit-config> operation. Proprietary\nNETCONF RPCs that make configuration changes are not sufficient.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5956,7 +6546,7 @@ }, { "id": "R-63229", - "text": "The xNF **MAY** use another option which is expected to include REST\nfor synchronous data, using RESTCONF (e.g., for xNF state polling).", + "text": "The VNF or PNF **MAY** use another option which is expected to include REST\nfor synchronous data, using RESTCONF (e.g., for VNF or PNF state polling).", "keyword": "MAY", "result": "PASS", "errors": [] @@ -5991,26 +6581,33 @@ }, { "id": "R-63935", - "text": "The xNF **MUST** release locks to prevent permanent lock-outs\nwhen a user configured timer has expired forcing the NETCONF SSH Session\ntermination (i.e., product must expose a configuration knob for a user\nsetting of a lock expiration timer).", + "text": "The VNF or PNF **MUST** release locks to prevent permanent lock-outs\nwhen a user configured timer has expired forcing the NETCONF SSH Session\ntermination (i.e., product must expose a configuration knob for a user\nsetting of a lock expiration timer).", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-63953", - "text": "The xNF **MUST** have the echo command return a zero value\notherwise the validation has failed.", + "text": "The VNF or PNF **MUST** have the echo command return a zero value\notherwise the validation has failed.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-63956", - "text": "If the VNF's ports connected to a unique external network\nand the port's IP addresses are ONAP SDN-C assigned IP Addresses,\nthe IPv4 Addresses **MAY** be from different subnets and the IPv6\nAddresses **MAY** be from different subnets.", + "text": "If the VNF's ports connected to a unique external network\nand the port's IP addresses are ONAP SDN-C assigned IP addresses,\nthe IPv4 addresses **MAY** be from different subnets and the IPv6\naddresses **MAY** be from different subnets.", "keyword": "MAY", "result": "PASS", "errors": [] }, { + "id": "R-64064", + "text": "The PNFD provided by a PNF vendor **MUST** comply with the following\nRelationship Types as specified in ETSI NFV-SOL001 standard:\n\n - tosca.datatypes.nfv.VirtualLinksTo", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-64445", "text": "The VNF **MUST** support the ability of a requestor of the\nservice to determine the version (and therefore capabilities) of the\nservice so that Network Cloud Service Provider can understand the\ncapabilities of the service.", "keyword": "MUST", @@ -6040,7 +6637,7 @@ }, { "id": "R-65486", - "text": "The VNFD **MUST** comply with ETSI GS NFV-SOL001 document endorsing\nthe above mentioned NFV Profile and maintaining the gaps with the\nrequirements specified in ETSI GS NFV-IFA011 standard.", + "text": "The VNFD **MUST** comply with ETSI GS NFV-SOL001 specification endorsing\nthe above mentioned NFV Profile and maintaining the gaps with the\nrequirements specified in ETSI GS NFV-IFA011 standard.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6068,28 +6665,28 @@ }, { "id": "R-65641", - "text": "The xNF **MUST** support APPC/SDN-C ``UpgradeBackOut`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``UpgradeBackOut`` command.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-65755", - "text": "The xNF **SHOULD** support callback URLs to return information\nto ONAP upon completion of the chef-client run for any chef-client run\nassociated with a xNF action.\n\n- As part of the push job, ONAP will provide two parameters in the\n environment of the push job JSON object:\n\n - \"RequestId\" a unique Id to be used to identify the request,\n - \"CallbackUrl\", the URL to post response back.\n\n- If the CallbackUrl field is empty or missing in the push job, then\n the chef-client run need not post the results back via callback.", + "text": "The VNF or PNF **SHOULD** support callback URLs to return information\nto ONAP upon completion of the chef-client run for any chef-client run\nassociated with a VNF or PNF action.\n\n- As part of the push job, ONAP will provide two parameters in the\n environment of the push job JSON object:\n\n - \"RequestId\" a unique Id to be used to identify the request,\n - \"CallbackUrl\", the URL to post response back.\n\n- If the CallbackUrl field is empty or missing in the push job, then\n the chef-client run need not post the results back via callback.", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-659655", - "text": "The xNF **SHOULD** leverage the JSON-driven model, as depicted in Figure 2,\nfor data delivery unless there are specific performance or operational\nconcerns agreed upon by the Service Provider that would warrant using an\nalternate model.", + "text": "The VNF or PNF **SHOULD** leverage the JSON-driven model, as depicted in Figure 2,\nfor data delivery unless there are specific performance or operational\nconcerns agreed upon by the Service Provider that would warrant using an\nalternate model.", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-66070", - "text": "The xNF Package **MUST** include xNF Identification Data to\nuniquely identify the resource for a given xNF provider. The identification\ndata must include: an identifier for the xNF, the name of the xNF as was\ngiven by the xNF provider, xNF description, xNF provider, and version.", + "text": "For HEAT package, the VNF Package **MUST** include VNF Identification Data to\nuniquely identify the resource for a given VNF provider. The identification\ndata must include: an identifier for the VNF, the name of the VNF as was\ngiven by the VNF provider, VNF description, VNF provider, and version.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6103,21 +6700,21 @@ }, { "id": "R-66793", - "text": "The xNF **MUST** guarantee the xNF configuration integrity\nfor all simultaneous configuration operations (e.g., if a change is\nattempted to the BUM filter rate from multiple interfaces on the same\nEVC, then they need to be sequenced in the xNF without locking either\nconfiguration method out).", + "text": "The VNF or PNF **MUST** guarantee the VNF or PNF configuration integrity\nfor all simultaneous configuration operations (e.g., if a change is\nattempted to the BUM filter rate from multiple interfaces on the same\nEVC, then they need to be sequenced in the VNF or PNF without locking either\nconfiguration method out).", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-67114", - "text": "The xNF **MUST** be installed with Chef-Client >= 12.0 and Chef\npush jobs client >= 2.0.", + "text": "The VNF or PNF **MUST** be installed with Chef-Client >= 12.0 and Chef\npush jobs client >= 2.0.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-67124", - "text": "The xNF **MUST** provide Ansible playbooks that are designed to run using\nan inventory hosts file in a supported format; with group names matching\nVNFC 3-character string adding \"vip\" for groups with virtual IP addresses\nshared by multiple VMs as seen in examples provided in Appendix.", + "text": "The VNF or PNF **MUST** provide Ansible playbooks that are designed to run\nusing an inventory hosts file in a supported format; with group names\nmatching VNFC 3-character string adding \"vip\" for groups with virtual IP\naddresses shared by multiple VMs as seen in examples provided in Appendix.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6152,7 +6749,7 @@ }, { "id": "R-67793", - "text": "When a VNF's Heat Orchestration Template's resource is associated\nwith more than one ``{vm-type}`` and/or more than one internal and/or\nexternal network, the Resource ID **MUST** not contain the ``{vm-type}``\nand/or ``{network-role}``/``int_{network-role}``. It also should contain the\nterm ``shared`` and/or contain text that identifies the VNF.", + "text": "When a VNF's Heat Orchestration Template's resource is associated\nwith more than one ``{vm-type}`` and/or more than one internal and/or\nexternal network, the Resource ID **MUST NOT** contain the ``{vm-type}``\nand/or ``{network-role}``/``int_{network-role}``. It also should contain the\nterm ``shared`` and/or contain text that identifies the VNF.", "keyword": "MUST NOT", "result": "PASS", "errors": [] @@ -6173,7 +6770,7 @@ }, { "id": "R-68023", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` **SHOULD**\ncontain the key/value pair ``vf_module_name`` and the value **MUST**\nbe obtained via a ``get_param``.", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vf_module_name``\nvalue **MUST**\nbe obtained via a ``get_param``.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6187,7 +6784,7 @@ }, { "id": "R-68165", - "text": "The xNF **MUST** encrypt any content containing Sensitive Personal\nInformation (SPI) or certain proprietary data, in addition to applying the\nregular procedures for securing access and delivery.", + "text": "The VNF or PNF **MUST** encrypt any content containing Sensitive Personal\nInformation (SPI) or certain proprietary data, in addition to applying the\nregular procedures for securing access and delivery.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6208,14 +6805,14 @@ }, { "id": "R-68200", - "text": "The xNF **MUST** support the ``:url`` value to specify\nprotocol operation source and target parameters. The capability URI\nfor this feature will indicate which schemes (e.g., file, https, sftp)\nthat the server supports within a particular URL value. The 'file'\nscheme allows for editable local configuration databases. The other\nschemes allow for remote storage of configuration databases.", + "text": "The VNF or PNF **MUST** support the ``:url`` value to specify\nprotocol operation source and target parameters. The capability URI\nfor this feature will indicate which schemes (e.g., file, https, sftp)\nthat the server supports within a particular URL value. The 'file'\nscheme allows for editable local configuration databases. The other\nschemes allow for remote storage of configuration databases.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-68520", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is creating a *Reserve Port* with an IPv6 address Resource ID\n**SHOULD** use the naming convention\n\n* ``reserve_port_{vm-type}_{network-role}_floating_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{index}`` is the instance of the IPv6 *Reserve Port*\n for the vm-type attached to the network of ``{network-role}``", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is creating a *Reserve Port* with an IPv6 address Resource ID\n**SHOULD** use the naming convention\n\n* ``reserve_port_{vm-type}_{network-role}_floating_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{index}`` is the instance of the IPv6 *Reserve Port*\n for the vm-type attached to the network of ``{network-role}``.\n The ``{index}`` starts at zero and increments by one\n (as described in R-11690).", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -6229,7 +6826,7 @@ }, { "id": "R-68990", - "text": "The xNF **MUST** support the ``:startup`` capability. It\nwill allow the running configuration to be copied to this special\ndatabase. It can also be locked and unlocked.", + "text": "The VNF or PNF **MUST** support the ``:startup`` capability. It\nwill allow the running configuration to be copied to this special\ndatabase. It can also be locked and unlocked.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6250,7 +6847,7 @@ }, { "id": "R-69565", - "text": "The xNF Package **MUST** include documentation describing xNF\nManagement APIs, which must include information and tools for ONAP to\ndeploy and configure (initially and ongoing) the xNF application(s)\n(e.g., NETCONF APIs) which includes a description of configurable\nparameters for the xNF and whether the parameters can be configured\nafter xNF instantiation.", + "text": "The VNF or PNF Documentation Package **MUST** describe the VNF or PNF\nManagement APIs, which must include information and tools for ONAP to\ndeploy and configure (initially and ongoing) the VNF or PNF application(s)\n(e.g., NETCONF APIs) which includes a description of configurable\nparameters for the VNF or PNF and whether the parameters can be configured\nafter VNF or PNF instantiation.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6292,14 +6889,14 @@ }, { "id": "R-697654", - "text": "The xNF **MAY** leverage the Google Protocol Buffers (GPB) delivery model\ndepicted in Figure 3 to support real-time performance management (PM) data.\nIn this model the VES events are streamed as binary-encoded GBPs over via\nTCP sockets.", + "text": "The VNF or PNF **MAY** leverage the Google Protocol Buffers (GPB) delivery model\ndepicted in Figure 3 to support real-time performance management (PM) data.\nIn this model the VES events are streamed as binary-encoded GBPs over via\nTCP sockets.", "keyword": "MAY", "result": "PASS", "errors": [] }, { "id": "R-69877", - "text": "The xNF Package **MUST** include documentation for each KPI,\nidentify the suggested actions that need to be performed when a\nthreshold crossing alert event is recorded.", + "text": "The VNF or PNF Package **MUST** include documentation for each KPI,\nidentify the suggested actions that need to be performed when a\nthreshold crossing alert event is recorded.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6313,7 +6910,7 @@ }, { "id": "R-70266", - "text": "The xNF **MUST** respond to an ONAP request to deliver the\ncurrent data for any of the record types defined in\n`Event Records - Data Structure Description`_ by returning the requested\nrecord, populated with the current field values. (Currently the defined\nrecord types include fault fields, mobile flow fields, measurements for\nxNF scaling fields, and syslog fields. Other record types will be added\nin the future as they become standardized and are made available.)", + "text": "The VNF or PNF **MUST** respond to an ONAP request to deliver the\ncurrent data for any of the record types defined in\n`Event Records - Data Structure Description`_ by returning the requested\nrecord, populated with the current field values. (Currently the defined\nrecord types include fault fields, mobile flow fields, measurements for\nVNF or PNF scaling fields, and syslog fields. Other record types will be added\nin the future as they become standardized and are made available.)", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6334,7 +6931,7 @@ }, { "id": "R-70496", - "text": "The xNF **MUST** implement the protocol operation:\n``commit(confirmed, confirm-timeout)`` - Commit candidate\nconfiguration data store to the running configuration.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``commit(confirmed, confirm-timeout)`` - Commit candidate\nconfiguration data store to the running configuration.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6348,8 +6945,8 @@ }, { "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", - "keyword": "MUST", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT", "result": "PASS", "errors": [] }, @@ -6397,7 +6994,7 @@ }, { "id": "R-717227", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nECOMP definition, see Requirements R-52425 and R-46461),\nand an IPv4 Virtual IP (VIP)\naddress is assigned using the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file.\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 Virtual IP (VIP)\naddress is assigned using the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file.\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6418,7 +7015,7 @@ }, { "id": "R-72184", - "text": "The xNF **MUST** have routable FQDNs for all the endpoints\n(VMs) of a xNF that contain chef-clients which are used to register\nwith the Chef Server. As part of invoking xNF actions, ONAP will\ntrigger push jobs against FQDNs of endpoints for a xNF, if required.", + "text": "The VNF or PNF **MUST** have routable FQDNs for all the endpoints\n(VMs) of a VNF or PNF that contain chef-clients which are used to register\nwith the Chef Server. As part of invoking VNF or PNF actions, ONAP will\ntrigger push jobs against FQDNs of endpoints for a VNF or PNF, if required.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6460,7 +7057,7 @@ }, { "id": "R-73285", - "text": "The xNF **MUST** must encode, address and deliver the data\nas described in the previous paragraphs.", + "text": "The VNF or PNF **MUST** must encode, address and deliver the data\nas described in the previous paragraphs.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6474,21 +7071,21 @@ }, { "id": "R-73459", - "text": "The xNF **MUST** provide the ability to include a \"from=\" clause in SSH\npublic keys associated with mechanized user IDs created for an Ansible\nServer cluster to use for xNF VM authentication.", + "text": "The VNF or PNF **MUST** provide the ability to include a \"from=\" clause in\nSSH public keys associated with mechanized user IDs created for an Ansible\nServer cluster to use for VNF or PNF VM authentication.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-73468", - "text": "The xNF **MUST** allow the NETCONF server connection\nparameters to be configurable during virtual machine instantiation\nthrough Heat templates where SSH keys, usernames, passwords, SSH\nservice and SSH port numbers are Heat template parameters.", + "text": "The VNF or PNF **MUST** allow the NETCONF server connection\nparameters to be configurable during virtual machine instantiation\nthrough Heat templates where SSH keys, usernames, passwords, SSH\nservice and SSH port numbers are Heat template parameters.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-73560", - "text": "The xNF Package **MUST** include documentation about monitoring\nparameters/counters exposed for virtual resource management and xNF\napplication management.", + "text": "The VNF or PNF Package **MUST** include documentation about monitoring\nparameters/counters exposed for virtual resource management and VNF or PNF\napplication management.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6522,13 +7119,6 @@ "errors": [] }, { - "id": "R-74763", - "text": "The xNF provider **MUST** provide an artifact per xNF that contains\nall of the xNF Event Records supported. The artifact should include\nreference to the specific release of the xNF Event Stream Common Event\nData Model document it is based on. (e.g.,\n`VES Event Listener <https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/VESEventListener.html>`__)", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { "id": "R-74958", "text": "The VNF **MUST** activate security alarms automatically when\nit detects an unsuccessful attempt to gain permissions\nor assume the identity of another user.", "keyword": "MUST", @@ -6565,7 +7155,7 @@ }, { "id": "R-75608", - "text": "The xNF provider **MUST** provide playbooks to be loaded\non the appropriate Ansible Server.", + "text": "The VNF or PNF provider **MUST** provide playbooks to be loaded\non the appropriate Ansible Server.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6586,7 +7176,7 @@ }, { "id": "R-75943", - "text": "The xNF **SHOULD** support the data schema defined in 3GPP TS 32.435, when\nsupporting the event-driven bulk transfer of monitoring data.", + "text": "The VNF or PNF **SHOULD** support the data schema defined in 3GPP TS 32.435, when\nsupporting the event-driven bulk transfer of monitoring data.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -6600,7 +7190,7 @@ }, { "id": "R-76057", - "text": "VNF Heat Orchestration Template's Nested YAML file name **MUST** contain\nonly alphanumeric characters and underscores '_' and\n**MUST NOT** contain the case insensitive word ``base``.", + "text": "VNF Heat Orchestration Template's Nested YAML file name **MUST** contain\nonly alphanumeric characters and underscores '_' and\n**MUST NOT** contain the case insensitive string ``base``.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6614,7 +7204,7 @@ }, { "id": "R-763774", - "text": "The PNF **MUST** support a HTTPS connection to the DCAE VES Event\nListener.", + "text": "The VNF or PNF **MUST** support a HTTPS connection to the DCAE\nVES Event Listener.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6662,13 +7252,6 @@ "errors": [] }, { - "id": "R-77707", - "text": "The xNF provider **MUST** include a Manifest File that\ncontains a list of all the components in the xNF package.", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { "id": "R-78010", "text": "The VNF **MUST** integrate with standard identity and access management\nprotocols such as LDAP, TACACS+, Windows Integrated Authentication\n(Kerberos), SAML federation, or OAuth 2.0.", "keyword": "MUST", @@ -6677,14 +7260,14 @@ }, { "id": "R-78116", - "text": "The xNF **MUST** update status on the Chef Server\nappropriately (e.g., via a fail or raise an exception) if the\nchef-client run encounters any critical errors/failures when\nexecuting a xNF action.", + "text": "The VNF or PNF **MUST** update status on the Chef Server\nappropriately (e.g., via a fail or raise an exception) if the\nchef-client run encounters any critical errors/failures when\nexecuting a VNF or PNF action.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-78282", - "text": "The xNF **MUST** conform to the NETCONF RFC 6242,\n\"Using the Network Configuration Protocol over Secure Shell\".", + "text": "The VNF or PNF **MUST** conform to the NETCONF RFC 6242,\n\"Using the Network Configuration Protocol over Secure Shell\".", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6704,6 +7287,13 @@ "errors": [] }, { + "id": "R-787965", + "text": "If the VNF or PNF CSAR Package utilizes Option 2 for package security, then\nthe complete CSAR file **MUST** be digitally signed with the VNF or PNF\nprovider private key. The VNF or PNF provider delivers one zip file\nconsisting of the CSAR file, a signature file and a certificate file that\nincludes the VNF or PNF provider public key. The certificate may also be\nincluded in the signature container, if the signature format allows that.\nThe VNF or PNF provider creates a zip file consisting of the CSAR file with\n.csar extension, signature and certificate files. The signature and\ncertificate files must be siblings of the CSAR file with extensions .cms\nand .cert respectively.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-79107", "text": "The VNF **MUST**, if not integrated with the Operator's Identity\nand Access Management system, support the ability to disable the\nuserID after a configurable number of consecutive unsuccessful\nauthentication attempts using the same userID.", "keyword": "MUST", @@ -6712,7 +7302,7 @@ }, { "id": "R-79224", - "text": "The xNF **MUST** have the chef-client be preloaded with\nvalidator keys and configuration to register with the designated\nChef Server as part of the installation process.", + "text": "The VNF or PNF **MUST** have the chef-client be preloaded with\nvalidator keys and configuration to register with the designated\nChef Server as part of the installation process.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6726,12 +7316,19 @@ }, { "id": "R-79412", - "text": "The xNF **MAY** use another option which is expected to include TCP\nfor high volume streaming asynchronous data sets and for other high volume\ndata sets. TCP delivery can be used for either JSON or binary encoded data\nsets.", + "text": "The VNF or PNF **MAY** use another option which is expected to include TCP\nfor high volume streaming asynchronous data sets and for other high volume\ndata sets. TCP delivery can be used for either JSON or binary encoded data\nsets.", "keyword": "MAY", "result": "PASS", "errors": [] }, { + "id": "R-795126", + "text": "The VNF TOSCA CSAR package Manifest file **MUST** start with the VNF\npackage metadata in the form of a name-value pairs. Each pair shall appear\non a different line. The name is specified as following:\n\n - vnf_provider_id\n\n - vnf_product_name\n\n - vnf_release_date_time\n\n - vnf_package_version", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-79817", "text": "A VNF's Heat Orchestration Template's parameter defined\nin a non-nested YAML file as\ntype ``comma_delimited_list`` **MAY** have a parameter constraint defined.", "keyword": "MAY", @@ -6740,7 +7337,7 @@ }, { "id": "R-798933", - "text": "The xNF **SHOULD** deliver event records that fall into the event domains\nsupported by VES.", + "text": "The VNF or PNF **SHOULD** deliver event records that fall into the event domains\nsupported by VES.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -6775,12 +7372,19 @@ }, { "id": "R-805572", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nECOMP definition, see Requirements R-52425 and R-46461),\nand an IPv6 Virtual IP (VIP)\naddress is assigned\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 Virtual IP (VIP)\naddress is assigned\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", "keyword": "MUST", "result": "PASS", "errors": [] }, { + "id": "R-807129", + "text": "The VNF or PNF **SHOULD** report the files in FileReady for as long as they are\navailable at VNF or PNF.\n\nNote: Recommended period is at least 24 hours.", + "keyword": "SHOULD", + "result": "PASS", + "errors": [] + }, + { "id": "R-80829", "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n``{network-role}_v6_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", "keyword": "MUST NOT", @@ -6789,7 +7393,7 @@ }, { "id": "R-80898", - "text": "TThe xNF **MUST** support heartbeat via a <get> with null filter.", + "text": "TThe VNF or PNF **MUST** support heartbeat via a <get> with null filter.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6817,7 +7421,7 @@ }, { "id": "R-81339", - "text": "A VNF Heat Orchestration Template's Base Module file name **MUST** include\ncase insensitive 'base' in the filename and\n**MUST** match one of the following four\nformats:\n\n 1.) ``base_<text>.y[a]ml``\n\n 2.) ``<text>_base.y[a]ml``\n\n 3.) ``base.y[a]ml``\n\n 4.) ``<text>_base_<text>``.y[a]ml\n\nwhere ``<text>`` **MUST** contain only alphanumeric characters and\nunderscores '_' and **MUST NOT** contain the case insensitive word ``base``.", + "text": "A VNF Heat Orchestration Template's Base Module file name **MUST** include\ncase insensitive 'base' in the filename and\n**MUST** match one of the following four\nformats:\n\n 1.) ``base_<text>.y[a]ml``\n\n 2.) ``<text>_base.y[a]ml``\n\n 3.) ``base.y[a]ml``\n\n 4.) ``<text>_base_<text>``.y[a]ml\n\nwhere ``<text>`` **MUST** contain only alphanumeric characters and\nunderscores '_' and **MUST NOT** contain the case insensitive string\n``base`` or ``volume``.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6830,6 +7434,13 @@ "errors": [] }, { + "id": "R-816745", + "text": "The VNF or PNF PROVIDER *MUST* provide the Service Provider with\nPM Meta Data (PM Dictionary) to support the analysis of PM events delivered\nto DCAE. The PM Dictionary is to be provided as a separate YAML artifact at\nonboarding and must follow the VES Event Listener Specification and VES\nEvent Registration Specification which contain the format and content\nrequired.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-81725", "text": "A VNF's Incremental Module **MUST** have a corresponding Environment File", "keyword": "MUST", @@ -6838,7 +7449,7 @@ }, { "id": "R-81777", - "text": "The xNF **MUST** be configured with initial address(es) to use\nat deployment time. Subsequently, address(es) may be changed through\nONAP-defined policies delivered from ONAP to the xNF using PUTs to a\nRESTful API, in the same manner that other controls over data reporting\nwill be controlled by policy.", + "text": "The VNF or PNF **MUST** be configured with initial address(es) to use\nat deployment time. Subsequently, address(es) may be changed through\nONAP-defined policies delivered from ONAP to the VNF or PNF using PUTs to a\nRESTful API, in the same manner that other controls over data reporting\nwill be controlled by policy.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6852,7 +7463,7 @@ }, { "id": "R-82018", - "text": "The xNF **MUST** load the Ansible Server SSH public key onto xNF\nVM(s) /root/.ssh/authorized_keys as part of instantiation. Alternative,\nis for Ansible Server SSH public key to be loaded onto xNF VM(s) under\n/home/<Mechanized user ID>/.ssh/authorized_keys as part of instantiation,\nwhen a Mechanized user ID is created during instantiation, and Configure\nand all playbooks are designed to use a mechanized user ID only for\nauthentication (never using root authentication during Configure playbook\nrun). This will allow the Ansible Server to authenticate to perform\npost-instantiation configuration without manual intervention and without\nrequiring specific xNF login IDs and passwords.\n\n*CAUTION*: For xNFs configured using Ansible, to eliminate the need\nfor manual steps, post-instantiation and pre-configuration, to\nupload of SSH public keys, SSH public keys loaded during (heat)\ninstantiation shall be preserved and not removed by (heat) embedded\n(userdata) scripts.", + "text": "The VNF or PNF **MUST** load the Ansible Server SSH public key onto VNF or\nPNF VM(s) /root/.ssh/authorized_keys as part of instantiation. Alternative,\nis for Ansible Server SSH public key to be loaded onto VNF or PNF VM(s)\nunder /home/<Mechanized user ID>/.ssh/authorized_keys as part of\ninstantiation, when a Mechanized user ID is created during instantiation,\nand Configure and all playbooks are designed to use a mechanized user ID\nonly for authentication (never using root authentication during Configure\nplaybook run). This will allow the Ansible Server to authenticate to\nperform post-instantiation configuration without manual intervention and\nwithout requiring specific VNF or PNF login IDs and passwords.\n\n*CAUTION*: For VNFs or PNFs configured using Ansible, to eliminate the need\nfor manual steps, post-instantiation and pre-configuration, to\nupload of SSH public keys, SSH public keys loaded during (heat)\ninstantiation shall be preserved and not removed by (heat) embedded\n(userdata) scripts.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6873,14 +7484,14 @@ }, { "id": "R-821473", - "text": "The xNF MUST produce heartbeat indicators consisting of events containing\nthe common event header only per the VES Listener Specification.", + "text": "The VNF or PNF MUST produce heartbeat indicators consisting of events containing\nthe common event header only per the VES Listener Specification.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-821839", - "text": "The xNF **MUST** deliver event records to ONAP using the common transport\nmechanisms and protocols defined in this document.", + "text": "The VNF or PNF **MUST** deliver event records to ONAP using the common\ntransport mechanisms and protocols defined in this specification.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6893,13 +7504,6 @@ "errors": [] }, { - "id": "R-82481", - "text": "A VNF's Heat Orchestration Template's Resource property parameter that is\nassociated with a unique Virtual Machine type **MUST** include\n``{vm-type}`` as part of the parameter name with two exceptions:\n\n 1.) The Resource ``OS::Nova::Server`` property ``availability_zone``\n parameter **MUST NOT** be prefixed with a common ``{vm-type}`` identifier,\n\n 2.) The Resource ``OS::Nova::Server`` mandatory and optional\n ``metadata`` parameters\n\n * ``vnf_name``\n * ``vnf_id``\n * ``vf_module_id``\n * ``vf_module_name``\n * ``vf_module_index``\n * ``environment_context``\n * ``workload_context``\n\n **MUST NOT** be prefixed with a common ``{vm-type}`` identifier.", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { "id": "R-82551", "text": "When a VNF's Heat Orchestration Template's resource is associated with a\nsingle ``{vm-type}`` and a single internal network, the Resource ID **MUST**\ncontain both the ``{vm-type}`` and the ``int_{network-role}`` and\n\n- the ``{vm-type}`` **MUST** appear before the ``int_{network-role}`` and\n **MUST** be separated by an underscore '_'\n\n - (e.g., ``{vm-type}_int_{network-role}``,\n ``{vm-type}_{index}_int_{network-role}``)\n\n- note that an ``{index}`` value **MAY** separate the\n ``{vm-type}`` and the ``int_{network-role}`` and when this occurs\n underscores **MUST** separate the three values.\n (e.g., ``{vm-type}_{index}_int_{network-role}``).", "keyword": "MUST", @@ -6915,14 +7519,14 @@ }, { "id": "R-82811", - "text": "The xNF **MUST** support APPC ``StartApplication`` command.", + "text": "The VNF or PNF **MUST** support APPC ``StartApplication`` command.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-83146", - "text": "The xNF **MUST** support APPC ``StopApplication`` command.", + "text": "The VNF or PNF **MUST** support APPC ``StopApplication`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6936,14 +7540,7 @@ }, { "id": "R-83412", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``allowed_address_pairs``\nmap property ``ip_address`` parameter\n``{vm-type}_{network-role}_floating_ip``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", - "keyword": "MUST NOT", - "result": "PASS", - "errors": [] - }, - { - "id": "R-83418", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``allowed_address_pairs``\nmap property ``ip_address`` parameter\n``{vm-type}_{network-role}_floating_v6_ip``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "text": "If a VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424), the\nproperty ``allowed_address_pairs``\nmap property ``ip_address`` parameter(s)\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", "keyword": "MUST NOT", "result": "PASS", "errors": [] @@ -6971,14 +7568,14 @@ }, { "id": "R-83790", - "text": "The xNF **MUST** implement the ``:validate`` capability.", + "text": "The VNF or PNF **MUST** implement the ``:validate`` capability.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-83873", - "text": "The xNF **MUST** support ``:rollback-on-error`` value for\nthe <error-option> parameter to the <edit-config> operation. If any\nerror occurs during the requested edit operation, then the target\ndatabase (usually the running configuration) will be left unaffected.\nThis provides an 'all-or-nothing' edit mode for a single <edit-config>\nrequest.", + "text": "The VNF or PNF **MUST** support ``:rollback-on-error`` value for\nthe <error-option> parameter to the <edit-config> operation. If any\nerror occurs during the requested edit operation, then the target\ndatabase (usually the running configuration) will be left unaffected.\nThis provides an 'all-or-nothing' edit mode for a single <edit-config>\nrequest.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6999,7 +7596,7 @@ }, { "id": "R-841740", - "text": "The xNF **SHOULD** support FileReady VES event for event-driven bulk transfer\nof monitoring data.", + "text": "The VNF or PNF **SHOULD** support FileReady VES event for event-driven bulk transfer\nof monitoring data.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -7020,7 +7617,7 @@ }, { "id": "R-84366", - "text": "The xNF Package **MUST** include documentation describing\nxNF Functional APIs that are utilized to build network and\napplication services. This document describes the externally exposed\nfunctional inputs and outputs for the xNF, including interface\nformat and protocols supported.", + "text": "The VNF or PNF Documentation Package **MUST** describe the\nVNF or PNF Functional APIs that are utilized to build network and\napplication services. This document describes the externally exposed\nfunctional inputs and outputs for the VNF or PNF, including interface\nformat and protocols supported.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7055,7 +7652,7 @@ }, { "id": "R-84879", - "text": "The xNF **MUST** have the capability of maintaining a primary\nand backup DNS name (URL) for connecting to ONAP collectors, with the\nability to switch between addresses based on conditions defined by policy\nsuch as time-outs, and buffering to store messages until they can be\ndelivered. At its discretion, the service provider may choose to populate\nonly one collector address for a xNF. In this case, the network will\npromptly resolve connectivity problems caused by a collector or network\nfailure transparently to the xNF.", + "text": "The VNF or PNF **MUST** have the capability of maintaining a primary\nand backup DNS name (URL) for connecting to ONAP collectors, with the\nability to switch between addresses based on conditions defined by policy\nsuch as time-outs, and buffering to store messages until they can be\ndelivered. At its discretion, the service provider may choose to populate\nonly one collector address for a VNF or PNF. In this case, the network will\npromptly resolve connectivity problems caused by a collector or network\nfailure transparently to the VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7083,7 +7680,7 @@ }, { "id": "R-85653", - "text": "The xNF **MUST** provide metrics (e.g., number of sessions,\nnumber of subscribers, number of seats, etc.) to ONAP for tracking\nevery license.", + "text": "The VNF or PNF **MUST** provide metrics (e.g., number of sessions,\nnumber of subscribers, number of seats, etc.) to ONAP for tracking\nevery license.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7094,8 +7691,7 @@ "keyword": "MUST", "result": "FAIL", "errors": [ - " Improper name property for non-OS::Nova::Server resources. int_unprotected_private_network's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}. int_unprotected_private_subnet's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}. int_protected_private_network's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}. int_protected_private_subnet's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}\n", - " Resource(int_unprotected_private_network) does not use str_replace and the vnf_name parameter to set the name property, Resource(int_unprotected_private_subnet) does not use str_replace and the vnf_name parameter to set the name property, Resource(int_protected_private_network) does not use str_replace and the vnf_name parameter to set the name property, Resource(int_protected_private_subnet) does not use str_replace and the vnf_name parameter to set the name property\n" + " Improper name property for non-OS::Nova::Server resources. int_unprotected_private_network's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}. int_unprotected_private_subnet's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}. int_protected_private_network's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}. int_protected_private_subnet's name property's use str_replace does not use have a params that maps to the parameter via {get_param: vnf_name}\n" ] }, { @@ -7114,21 +7710,21 @@ }, { "id": "R-85991", - "text": "The xNF provider **MUST** provide a universal license key\nper xNF to be used as needed by services (i.e., not tied to a VM\ninstance) as the recommended solution. The xNF provider may provide\npools of Unique xNF License Keys, where there is a unique key for\neach xNF instance as an alternate solution. Licensing issues should\nbe resolved without interrupting in-service xNFs.", + "text": "The VNF or PNF provider **MUST** provide a universal license key\nper VNF or PNF to be used as needed by services (i.e., not tied to a VM\ninstance) as the recommended solution. The VNF or PNF provider may provide\npools of Unique VNF or PNF License Keys, where there is a unique key for\neach VNF or PNF instance as an alternate solution. Licensing issues should\nbe resolved without interrupting in-service VNFs or PNFs.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-86182", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand the internal network is created in a\ndifferent Heat Orchestration Template than the ``OS::Neutron::Port``,\nthe ``network`` parameter name **MUST**\n\n * follow the naming convention ``int_{network-role}_net_id`` if the Neutron\n network UUID value is used to reference the network\n * follow the naming convention ``int_{network-role}_net_name`` if the\n OpenStack network name in is used to reference the network.\n\nwhere ``{network-role}`` is the network-role of the internal network and\na ``get_param`` **MUST** be used as the intrinsic function.", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port``\nis in an incremental module and\nis attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nthe ``network`` parameter name **MUST**\n\n * follow the naming convention ``int_{network-role}_net_id`` if the\n network UUID value is used to reference the network\n * follow the naming convention ``int_{network-role}_net_name`` if the\n network name in is used to reference the network.\n\nwhere ``{network-role}`` is the network-role of the internal network and\na ``get_param`` **MUST** be used as the intrinsic function.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-86235", - "text": "The xNF Package **MUST** include documentation about the monitoring\nparameters that must include latencies, success rates, retry rates, load\nand quality (e.g., DPM) for the key transactions/functions supported by\nthe xNF and those that must be exercised by the xNF in order to perform\nits function.", + "text": "The VNF or PNF Package **MUST** include documentation about the monitoring\nparameters that must include latencies, success rates, retry rates, load\nand quality (e.g., DPM) for the key transactions/functions supported by\nthe VNF or PNF and those that must be exercised by the VNF or PNF in order to perform\nits function.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7156,7 +7752,7 @@ }, { "id": "R-86497", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::Cinder::VolumeAttachment``\nResource ID\n**SHOULD**\nuse the naming convention\n\n* ``{vm-type}_volume_attachment_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` starts at zero and increments by one", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::Cinder::VolumeAttachment``\nResource ID\n**SHOULD**\nuse the naming convention\n\n* ``{vm-type}_volume_attachment_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` starts at zero and increments by one (as described in R-11690)", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -7170,7 +7766,7 @@ }, { "id": "R-86586", - "text": "The xNF **MUST** use the YANG configuration models and RESTCONF\n[RFC8040] (https://tools.ietf.org/html/rfc8040).", + "text": "The VNF or PNF **MUST** use the YANG configuration models and RESTCONF\n[RFC8040] (https://tools.ietf.org/html/rfc8040).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7212,7 +7808,7 @@ }, { "id": "R-87004", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::Cinder::Volume``\nResource ID\n**SHOULD**\nuse the naming convention\n\n* ``{vm-type}_volume_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` starts at zero and increments by one", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::Cinder::Volume``\nResource ID\n**SHOULD**\nuse the naming convention\n\n* ``{vm-type}_volume_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` starts at zero and increments by one (as described in R-11690)", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -7233,14 +7829,14 @@ }, { "id": "R-87234", - "text": "The VNF package provided by a VNF vendor **MAY** be either with\nTOSCA-Metadata directory (CSAR Option 1) or without TOSCA-Metadata\ndirectory (CSAR Option 2) as specified in ETSI GS NFV-SOL004. On-boarding\nentity (ONAP SDC) must support both options.\n\n**Note:** SDC supports only the CSAR Option 1 in Casablanca. The Option 2\nwill be considered in future ONAP releases,", - "keyword": "MAY", + "text": "The VNF or PNF package provided by a VNF or PNF vendor **MUST** be with\nTOSCA-Metadata directory (CSAR Option 1) as specified in\nETSI GS NFV-SOL004.\n\n**Note:** SDC supports only the CSAR Option 1 in Dublin. The Option 2\nwill be considered in future ONAP releases.", + "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-87247", - "text": "VNF Heat Orchestration Template's Incremental Module file name\n**MUST** contain only alphanumeric characters and underscores\n'_' and **MUST NOT** contain the case insensitive word ``base``.", + "text": "VNF Heat Orchestration Template's Incremental Module file name\n**MUST** contain only alphanumeric characters and underscores\n'_' and **MUST NOT** contain the case insensitive string ``base``.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7268,14 +7864,14 @@ }, { "id": "R-87563", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv6 Address on a port attached to an internal network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type\n attached to the network of ``{network-role}``\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` is the index of the IPv6 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv6 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an internal network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` references the instance of the IPv6 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv6 address is configured on the\n virtual machine interface.", "keyword": "MUST", "result": "SKIP", "errors": [] }, { "id": "R-87564", - "text": "The xNF **SHOULD** conform its YANG model to RFC 7317,\n\"A YANG Data Model for System Management\".", + "text": "The VNF or PNF **SHOULD** conform its YANG model to RFC 7317,\n\"A YANG Data Model for System Management\".", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -7289,14 +7885,14 @@ }, { "id": "R-88026", - "text": "The xNF **MUST** include a NETCONF server enabling\nruntime configuration and lifecycle management capabilities.", + "text": "The VNF or PNF **MUST** include a NETCONF server enabling\nruntime configuration and lifecycle management capabilities.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-88031", - "text": "The xNF **SHOULD** implement the protocol operation:\n``delete-config(target)`` - Delete the named configuration\ndata store target.", + "text": "The VNF or PNF **SHOULD** implement the protocol operation:\n``delete-config(target)`` - Delete the named configuration\ndata store target.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -7310,7 +7906,7 @@ }, { "id": "R-88482", - "text": "The xNF **SHOULD** use REST using HTTPS delivery of plain\ntext JSON for moderate sized asynchronous data sets, and for high\nvolume data sets when feasible.", + "text": "The VNF or PNF **SHOULD** use REST using HTTPS delivery of plain\ntext JSON for moderate sized asynchronous data sets, and for high\nvolume data sets when feasible.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -7338,7 +7934,7 @@ }, { "id": "R-88899", - "text": "The xNF **MUST** support simultaneous <commit> operations\nwithin the context of this locking requirements framework.", + "text": "The VNF or PNF **MUST** support simultaneous <commit> operations\nwithin the context of this locking requirements framework.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7352,7 +7948,7 @@ }, { "id": "R-894004", - "text": "When the xNF sets up a HTTP or HTTPS connection to the collector, it **MUST**\nprovide a username and password to the DCAE VES Collector for HTTP Basic\nAuthentication.\n\nNote: HTTP Basic Authentication has 4 steps: Request, Authenticate,\nAuthorization with Username/Password Credentials, and Authentication Status\nas per RFC7617 and RFC 2617.", + "text": "If the VNF or PNF is using Basic Authentication, then when the VNF\nor PNF sets up a HTTPS connection to the DCAE VES Event Listener,\nthe VNF or PNF **MUST** provide a username and password to the\nDCAE VES Event Listener in the Authorization header and the VNF\nor PNF MUST support one-way TLS authentication.\n\nNote: In one-way TLS authentication, the client (VNF or PNF)\nmust authentication the server (DCAE) certificate.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7366,7 +7962,7 @@ }, { "id": "R-89571", - "text": "The xNF **MUST** support and provide artifacts for configuration\nmanagement using at least one of the following technologies;\na) Netconf/YANG, b) Chef, or c) Ansible.\n\nNote: The requirements for Netconf/YANG, Chef, and Ansible protocols\nare provided separately and must be supported only if the corresponding\nprotocol option is provided by the xNF providor.", + "text": "The VNF or PNF **MUST** support and provide artifacts for configuration\nmanagement using at least one of the following technologies;\na) Netconf/YANG, b) Chef, or c) Ansible.\n\nNote: The requirements for Netconf/YANG, Chef, and Ansible protocols\nare provided separately and must be supported only if the corresponding\nprotocol option is provided by the VNF or PNF providor.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7387,7 +7983,7 @@ }, { "id": "R-90007", - "text": "The xNF **MUST** implement the protocol operation:\n``close-session()`` - Gracefully close the current session.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``close-session()`` - Gracefully close the current session.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7436,21 +8032,21 @@ }, { "id": "R-90632", - "text": "The xNF Package **MUST** include documentation about KPIs and\nmetrics that need to be collected at each VM for capacity planning\nand performance management purposes.", + "text": "The VNF Package **MUST** include documentation about KPIs and\nmetrics that need to be collected at each VM for capacity planning\nand performance management purposes.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-90748", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::CinderVolume``\n**MAY** be defined in an Incremental Module.", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume``\n**MAY** be defined in an Incremental Module.", "keyword": "MAY", "result": "PASS", "errors": [] }, { "id": "R-908291", - "text": "The XNF **MAY** leverage bulk xNF telemetry transmission mechanism, as\ndepicted in Figure 4, in instances where other transmission methods are not\npractical or advisable.", + "text": "The VNF or PNF **MAY** leverage bulk VNF or PNF telemetry transmission mechanism, as\ndepicted in Figure 4, in instances where other transmission methods are not\npractical or advisable.", "keyword": "MAY", "result": "PASS", "errors": [] @@ -7485,19 +8081,12 @@ }, { "id": "R-91745", - "text": "The xNF **MUST** update the Ansible Server and other entities\nstoring and using the SSH keys for authentication when the SSH\nkeys used by Ansible are regenerated/updated.\n\n**Note**: Ansible Server itself may be used to upload new SSH public\nkeys onto supported xNFs.", + "text": "The VNF or PNF **MUST** update the Ansible Server and other entities\nstoring and using the SSH keys for authentication when the SSH\nkeys used by Ansible are regenerated/updated.\n\n**Note**: Ansible Server itself may be used to upload new SSH public\nkeys onto supported VNFs or PNFs.", "keyword": "MUST", "result": "PASS", "errors": [] }, { - "id": "R-91810", - "text": "If a VNF requires ONAP to assign a Virtual IP (VIP) Address to\nports connected an external network, the port\n**MUST NOT** have more than one IPv4 VIP address.", - "keyword": "MUST NOT", - "result": "PASS", - "errors": [] - }, - { "id": "R-92193", "text": "A VNF's Heat Orchestration Template's parameter\n``{network-role}_net_fqdn``\n**MUST NOT** be enumerated in the VNF's Heat Orchestration Template's\nEnvironment File.", "keyword": "MUST NOT", @@ -7527,7 +8116,7 @@ }, { "id": "R-92866", - "text": "The xNF **MUST** include as part of post-instantiation configuration\ndone by Ansible Playbooks the removal/update of the SSH public key from\n/root/.ssh/authorized_keys, and update of SSH keys loaded through\ninstantiation to support Ansible. This may include creating Mechanized user\nID(s) used by the Ansible Server(s) on VNF VM(s) and uploading and\ninstalling new SSH keys used by the mechanized use ID(s).", + "text": "The VNF or PNF **MUST** include as part of post-instantiation configuration\ndone by Ansible Playbooks the removal/update of the SSH public key from\n/root/.ssh/authorized_keys, and update of SSH keys loaded through\ninstantiation to support Ansible. This may include creating Mechanized user\nID(s) used by the Ansible Server(s) on VNF VM(s) and uploading and\ninstalling new SSH keys used by the mechanized use ID(s).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7554,22 +8143,15 @@ "errors": [] }, { - "id": "R-93177", - "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand the internal network is created in the\nsame Heat Orchestration Template as the ``OS::Neutron::Port``,\nthe ``network`` property value **MUST** obtain the UUID\nof the internal network by using the intrinsic function\n``get_resource``\nand referencing the Resource ID of the internal network.", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { "id": "R-932071", - "text": "The xNF provider **MUST** reach agreement with the Service Provider on\nthe selected methods for encoding, serialization and data delivery\nprior to the on-boarding of the xNF into ONAP SDC Design Studio.", + "text": "The VNF or PNF provider **MUST** reach agreement with the Service Provider on\nthe selected methods for encoding, serialization and data delivery\nprior to the on-boarding of the VNF or PNF into ONAP SDC Design Studio.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-93443", - "text": "The xNF **MUST** define all data models in YANG [RFC6020],\nand the mapping to NETCONF shall follow the rules defined in this RFC.", + "text": "The VNF or PNF **MUST** define all data models in YANG 1.0 [RFC6020] or\nYANG 1.1 [RFC7950]. A combination of YANG 1.0 and YANG 1.1 modules is\nallowed subject to the rules in [RFC7950] section 12. The mapping to\nNETCONF shall follow the rules defined in this RFC.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7590,7 +8172,7 @@ }, { "id": "R-94084", - "text": "The xNF **MUST** support APPC/SDN-C ``ConfigScaleOut`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``ConfigScaleOut`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7611,7 +8193,7 @@ }, { "id": "R-94567", - "text": "The xNF **MUST** provide Ansible playbooks that are designed to run using\nan inventory hosts file in a supported format with only IP addresses or\nIP addresses and VM/xNF names.", + "text": "The VNF or PNF **MUST** provide Ansible playbooks that are designed to run\nusing an inventory hosts file in a supported format with only IP addresses\nor IP addresses and VM/VNF or PNF names.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7667,7 +8249,7 @@ }, { "id": "R-95950", - "text": "The xNF **MUST** provide a NETCONF interface fully defined\nby supplied YANG models for the embedded NETCONF server.", + "text": "The VNF or PNF **MUST** provide a NETCONF interface fully defined\nby supplied YANG models for the embedded NETCONF server.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7681,7 +8263,7 @@ }, { "id": "R-96253", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` that is attaching to an external network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` is the instance of the vmi on the vm-type\n attached to the network of ``{network-role}``", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` Resource ID\nthat is attaching to an external network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.", "keyword": "MUST", "result": "SKIP", "errors": [] @@ -7695,14 +8277,14 @@ }, { "id": "R-96554", - "text": "The xNF **MUST** implement the protocol operation:\n``unlock(target)`` - Unlock the configuration data store target.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``unlock(target)`` - Unlock the configuration data store target.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-96634", - "text": "The xNF provider **MUST** describe scaling capabilities\nto manage scaling characteristics of the xNF.", + "text": "The VNF or PNF Provider\u00a0**MUST**\u00a0provide human readable documentation\n(not in the on-boarding package) to describe scaling capabilities to manage\nscaling characteristics of the VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7730,21 +8312,21 @@ }, { "id": "R-97293", - "text": "The xNF provider **MUST NOT** require audits\nof Service Provider's business.", + "text": "The VNF or PNF provider **MUST NOT** require audits\nof Service Provider's business.", "keyword": "MUST NOT", "result": "PASS", "errors": [] }, { "id": "R-97343", - "text": "The xNF **MUST** support APPC/SDN-C ``UpgradeBackup`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``UpgradeBackup`` command.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-97345", - "text": "The xNF **MUST** permit authentication, using root account, only right\nafter instantiation and until post-instantiation configuration is\ncompleted.", + "text": "The VNF or PNF **MUST** permit authentication, using root account, only\nright after instantiation and until post-instantiation configuration is\ncompleted.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7758,14 +8340,14 @@ }, { "id": "R-97451", - "text": "The xNF **MUST** provide the ability to remove root access once\npost-instantiation configuration (Configure) is completed.", + "text": "The VNF or PNF **MUST** provide the ability to remove root access once\npost-instantiation configuration (Configure) is completed.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-97529", - "text": "The xNF **SHOULD** implement the protocol operation:\n``get-schema(identifier, version, format)`` - Retrieve the YANG schema.", + "text": "The VNF or PNF **SHOULD** implement the protocol operation:\n``get-schema(identifier, version, format)`` - Retrieve the YANG schema.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -7779,7 +8361,7 @@ }, { "id": "R-978752", - "text": "The xNF providers **MUST** provide the Service Provider the following\nartifacts to support the delivery of high-volume xNF telemetry to\nDCAE via GPB over TLS/TCP:\n\n * A valid VES Event .proto definition file, to be used validate and\n decode an event\n * A valid high volume measurement .proto definition file, to be used for\n processing high volume events\n * A supporting PM content metadata file to be used by analytics\n applications to process high volume measurement events", + "text": "The VNF or PNF providers **MUST** provide the Service Provider the following\nartifacts to support the delivery of high-volume VNF or PNF telemetry to\nDCAE via GPB over TLS/TCP:\n\n * A valid VES Event .proto definition file, to be used validate and\n decode an event\n * A valid high volume measurement .proto definition file, to be used for\n processing high volume events\n * A supporting PM content metadata file to be used by analytics\n applications to process high volume measurement events", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7807,7 +8389,7 @@ }, { "id": "R-98191", - "text": "The xNF **MUST** vary the frequency that asynchronous data\nis delivered based on the content and how data may be aggregated or\ngrouped together.\n\n Note:\n\n - For example, alarms and alerts are expected to be delivered as\n soon as they appear. In contrast, other content, such as performance\n measurements, KPIs or reported network signaling may have various\n ways of packaging and delivering content. Some content should be\n streamed immediately; or content may be monitored over a time\n interval, then packaged as collection of records and delivered\n as block; or data may be collected until a package of a certain\n size has been collected; or content may be summarized statistically\n over a time interval, or computed as a KPI, with the summary or KPI\n being delivered.\n - We expect the reporting frequency to be configurable depending on\n the virtual network functions needs for management. For example,\n Service Provider may choose to vary the frequency of collection\n between normal and trouble-shooting scenarios.\n - Decisions about the frequency of data reporting will affect\n the size of delivered data sets, recommended delivery method,\n and how the data will be interpreted by ONAP. These considerations\n should not affect deserialization and decoding of the data, which\n will be guided by the accompanying JSON schema or GPB definition\n files.", + "text": "The VNF or PNF **MUST** vary the frequency that asynchronous data\nis delivered based on the content and how data may be aggregated or\ngrouped together.\n\n Note:\n\n - For example, alarms and alerts are expected to be delivered as\n soon as they appear. In contrast, other content, such as performance\n measurements, KPIs or reported network signaling may have various\n ways of packaging and delivering content. Some content should be\n streamed immediately; or content may be monitored over a time\n interval, then packaged as collection of records and delivered\n as block; or data may be collected until a package of a certain\n size has been collected; or content may be summarized statistically\n over a time interval, or computed as a KPI, with the summary or KPI\n being delivered.\n - We expect the reporting frequency to be configurable depending on\n the virtual network functions needs for management. For example,\n Service Provider may choose to vary the frequency of collection\n between normal and trouble-shooting scenarios.\n - Decisions about the frequency of data reporting will affect\n the size of delivered data sets, recommended delivery method,\n and how the data will be interpreted by ONAP. These considerations\n should not affect deserialization and decoding of the data, which\n will be guided by the accompanying JSON schema or GPB definition\n files.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7820,13 +8402,6 @@ "errors": [] }, { - "id": "R-98391", - "text": "The VNF **MUST**, if not integrated with the Operator's Identity and\nAccess Management system, support Role-Based Access Control to enforce\nleast privilege.", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { "id": "R-98407", "text": "A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST** contain only\nalphanumeric characters and/or underscores '_' and **MUST NOT**\ncontain any of the following strings:\n``_int`` or ``int_`` or ``_int_``.", "keyword": "MUST NOT", @@ -7835,7 +8410,7 @@ }, { "id": "R-98450", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``availability_zone`` parameter name\n**MUST** follow the naming convention\n\n* ``availability_zone_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at zero\nin a VNF's Heat Orchestration Templates and **MUST**\nincrement by one.", + "text": "A VNF's Heat Orchestration Template's base module or incremental module\nresource ``OS::Nova::Server``\nproperty ``availability_zone`` parameter\n**MUST** follow the naming convention\n\n* ``availability_zone_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at zero\nin a VNF's Heat Orchestration Templates and **MUST**\nincrement by one.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7849,7 +8424,7 @@ }, { "id": "R-98617", - "text": "The xNF provider **MUST** provide information regarding any\ndependency (e.g., affinity, anti-affinity) with other xNFs and resources.", + "text": "The VNF Provider **MUST** provide documentation regarding any dependency\n(e.g. affinity, anti-affinity) the VNF has on other VNFs and resources.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7863,7 +8438,7 @@ }, { "id": "R-98911", - "text": "The xNF **MUST NOT** use any instance specific parameters\nfor the xNF in roles/cookbooks/recipes invoked for a xNF action.", + "text": "The VNF or PNF **MUST NOT** use any instance specific parameters\nfor the VNF or PNF in roles/cookbooks/recipes invoked for a VNF or PNF\naction.", "keyword": "MUST NOT", "result": "PASS", "errors": [] @@ -7877,7 +8452,7 @@ }, { "id": "R-99110", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualNetwork`` Resource ID **MUST** use the naming convention\n\n1) ``int_{network-role}_network``\n\nor\n\n2) ``int_{network-role}_RVN`` where RVN represents Resource Virtual\n Network\n\nVNF Heat Orchestration Templates can only create internal networks.\nThere is no ``{index}`` after ``{network-role}`` because ``{network-role}``\n**MUST** be unique in the scope of the VNF's\nHeat Orchestration Template.\n\nNote that option 1 is preferred.", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualNetwork`` Resource ID **MUST** use the naming\nconvention\n\n* ``int_{network-role}_network``\n\nVNF Heat Orchestration Templates can only create internal networks.\nThere is no ``{index}`` after ``{network-role}`` because ``{network-role}``\n**MUST** be unique in the scope of the VNF's\nHeat Orchestration Template.", "keyword": "MUST", "result": "SKIP", "errors": [] @@ -7925,6 +8500,13 @@ "errors": [] }, { + "id": "R-997907", + "text": "The VNF or PNF **SHOULD** support TLS as secure transport for the NETCONF\nprotocol according to [RFC7589].", + "keyword": "SHOULD", + "result": "PASS", + "errors": [] + }, + { "id": "R-99794", "text": "An external network **MUST** have one subnet. An external network\n**MAY** have more than one subnet.", "keyword": "MUST", @@ -7946,4 +8528,4 @@ "errors": [] } ] -}
\ No newline at end of file +} diff --git a/docs/files/vFWCL_vPKG_report.json b/docs/files/vFWCL_vPKG_report.json index 6f0a55e3c..22e9d99fa 100644 --- a/docs/files/vFWCL_vPKG_report.json +++ b/docs/files/vFWCL_vPKG_report.json @@ -1,17 +1,17 @@ { - "version": "dublin", - "template_directory": "/tmp/demo/heat/vFWCL/vPKG", - "timestamp": "2019-04-24T18:36:11.101242", - "checksum": "254188bd71aa942619fa5b1dcd364d35", + "version": "elalto", + "template_directory": "/template", + "timestamp": "2019-10-15T09:21:27.528797", + "checksum": "4f631925b1ebe5aa3bae1501135df92f", "categories": "", "outcome": "PASS", "tests": [ { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.env" ], - "test_module": "test_get_attr_usage", - "test_case": "test_08_validate_get_attr_usage", + "test_module": "test_initial_configuration", + "test_case": "test_00_valid_yaml", "result": "PASS", "error": "", "requirements": [ @@ -24,74 +24,74 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_get_file_only_reference_local_files", - "test_case": "test_get_file_no_url_retrieval", + "test_module": "test_initial_configuration", + "test_case": "test_00_valid_yaml", "result": "PASS", "error": "", "requirements": [ { - "id": "R-41888", - "text": "A VNF's Heat Orchestration Template intrinsic function\n``get_file`` **MUST NOT** utilize URL-based file retrieval.", - "keyword": "MUST NOT" + "id": "R-95303", + "text": "A VNF's Heat Orchestration Template **MUST** be defined using valid YAML.", + "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_get_file_only_reference_local_files", - "test_case": "test_get_file_only_reference_local_files", + "test_module": "test_initial_configuration", + "test_case": "test_02_no_duplicate_keys_in_file", "result": "PASS", "error": "", "requirements": [ { - "id": "R-76718", - "text": "If a VNF's Heat Orchestration Template uses the intrinsic function\n``get_file``, the ``get_file`` target **MUST** be referenced in\nthe Heat Orchestration Template by file name.", + "id": "R-92635", + "text": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.env" + "../vvp/base_vpkg.env" ], "test_module": "test_initial_configuration", - "test_case": "test_00_valid_yaml", + "test_case": "test_02a_no_duplicate_keys_in_env", "result": "PASS", "error": "", "requirements": [ { - "id": "R-95303", - "text": "A VNF's Heat Orchestration Template **MUST** be defined using valid YAML.", + "id": "R-92635", + "text": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_initial_configuration", - "test_case": "test_00_valid_yaml", + "test_case": "test_03_all_referenced_resources_exists", "result": "PASS", "error": "", "requirements": [ { - "id": "R-95303", - "text": "A VNF's Heat Orchestration Template **MUST** be defined using valid YAML.", + "id": "R-92635", + "text": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_initial_configuration", - "test_case": "test_02_no_duplicate_keys_in_file", + "test_case": "test_04_valid_nesting", "result": "PASS", "error": "", "requirements": [ @@ -104,10 +104,10 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_initial_configuration", - "test_case": "test_03_all_referenced_resources_exists", + "test_case": "test_05_all_get_param_have_defined_parameter", "result": "PASS", "error": "", "requirements": [ @@ -120,55 +120,71 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_initial_configuration", - "test_case": "test_04_valid_nesting", + "test_case": "test_06_heat_template_resource_section_has_resources", "result": "PASS", "error": "", "requirements": [ { - "id": "R-92635", - "text": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", + "id": "R-90152", + "text": "A VNF's Heat Orchestration Template's\n``resources:`` section **MUST** contain the declaration of at\nleast one resource.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_initial_configuration", - "test_case": "test_05_all_get_param_have_defined_parameter", + "test_module": "test_get_attr_usage", + "test_case": "test_08_validate_get_attr_usage", "result": "PASS", "error": "", "requirements": [ { - "id": "R-92635", - "text": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", + "id": "R-95303", + "text": "A VNF's Heat Orchestration Template **MUST** be defined using valid YAML.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_initial_configuration", - "test_case": "test_06_heat_template_resource_section_has_resources", + "test_module": "test_get_file_only_reference_local_files", + "test_case": "test_get_file_no_url_retrieval", "result": "PASS", "error": "", "requirements": [ { - "id": "R-90152", - "text": "A VNF's Heat Orchestration Template's\n``resources:`` section **MUST** contain the declaration of at\nleast one resource.", + "id": "R-41888", + "text": "A VNF's Heat Orchestration Template intrinsic function\n``get_file`` **MUST NOT** utilize URL-based file retrieval.", + "keyword": "MUST NOT" + } + ] + }, + { + "files": [ + "../vvp/base_vpkg.yaml" + ], + "test_module": "test_get_file_only_reference_local_files", + "test_case": "test_get_file_only_reference_local_files", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-76718", + "text": "If a VNF's Heat Orchestration Template uses the intrinsic function\n``get_file``, the ``get_file`` target **MUST** be referenced in\nthe Heat Orchestration Template by file name.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_all_parameters_used_in_template", "test_case": "test_all_parameters_used_in_template", @@ -184,70 +200,55 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_allowed_address_pairs_include_vm_type_network_role", - "test_case": "test_external_aap_format", + "test_module": "test_resource_ids_alphanumeric_only", + "test_case": "test_alphanumeric_resource_ids_only", "result": "PASS", "error": "", "requirements": [ { - "id": "R-41492", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 Virtual IP (VIP)\naddress is assigned via ONAP automation\nusing the property ``allowed_address_pairs``\nmap property ``ip_address`` and\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as type ``string``.", - "keyword": "MUST" - }, - { - "id": "R-35735", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 Virtual IP (VIP)\naddress is assigned via ONAP automation\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as type ``string``.", + "id": "R-75141", + "text": "A VNF's Heat Orchestration Template's resource name\n(i.e., <resource ID>) **MUST** only contain alphanumeric\ncharacters and underscores ('_').", "keyword": "MUST" - }, - { - "id": "R-159016", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nECOMP definition, see Requirement R-57424),\nand an IPv4 and/or IPv6 Virtual IP (VIP)\naddress is assigned via ECOMP automation\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``, the\nparameter **MUST NOT** be declared as ``type: comma_deliited_list``.", - "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_allowed_address_pairs_include_vm_type_network_role", - "test_case": "test_internal_aap_format", + "test_module": "test_availability_zone", + "test_case": "test_availability_zone_naming", "result": "PASS", "error": "", "requirements": [ { - "id": "R-717227", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nECOMP definition, see Requirements R-52425 and R-46461),\nand an IPv4 Virtual IP (VIP)\naddress is assigned using the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file.\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", - "keyword": "MUST" - }, - { - "id": "R-805572", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nECOMP definition, see Requirements R-52425 and R-46461),\nand an IPv6 Virtual IP (VIP)\naddress is assigned\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "id": "R-98450", + "text": "A VNF's Heat Orchestration Template's base module or incremental module\nresource ``OS::Nova::Server``\nproperty ``availability_zone`` parameter\n**MUST** follow the naming convention\n\n* ``availability_zone_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at zero\nin a VNF's Heat Orchestration Templates and **MUST**\nincrement by one.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_availability_zone", - "test_case": "test_availability_zone_naming", + "test_module": "test_server_parameters", + "test_case": "test_availability_zone_parameter_type", "result": "PASS", "error": "", "requirements": [ { - "id": "R-98450", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``availability_zone`` parameter name\n**MUST** follow the naming convention\n\n* ``availability_zone_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at zero\nin a VNF's Heat Orchestration Templates and **MUST**\nincrement by one.", + "id": "R-23311", + "text": "The VNF's Heat Orchestration Template's base module or incremental module\nresource ``OS::Nova::Server`` property\n``availability_zone`` parameter **MUST** be declared as type: ``string``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_availability_zone_params_start_at_0", "test_case": "test_availability_zones_start_at_0", @@ -256,14 +257,14 @@ "requirements": [ { "id": "R-98450", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``availability_zone`` parameter name\n**MUST** follow the naming convention\n\n* ``availability_zone_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at zero\nin a VNF's Heat Orchestration Templates and **MUST**\nincrement by one.", + "text": "A VNF's Heat Orchestration Template's base module or incremental module\nresource ``OS::Nova::Server``\nproperty ``availability_zone`` parameter\n**MUST** follow the naming convention\n\n* ``availability_zone_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at zero\nin a VNF's Heat Orchestration Templates and **MUST**\nincrement by one.", "keyword": "MUST" } ] }, { "files": [ - "." + "../vvp/template" ], "test_module": "test_base_template_names", "test_case": "test_base_template_names", @@ -282,24 +283,24 @@ }, { "id": "R-81339", - "text": "A VNF Heat Orchestration Template's Base Module file name **MUST** include\ncase insensitive 'base' in the filename and\n**MUST** match one of the following four\nformats:\n\n 1.) ``base_<text>.y[a]ml``\n\n 2.) ``<text>_base.y[a]ml``\n\n 3.) ``base.y[a]ml``\n\n 4.) ``<text>_base_<text>``.y[a]ml\n\nwhere ``<text>`` **MUST** contain only alphanumeric characters and\nunderscores '_' and **MUST NOT** contain the case insensitive word ``base``.", + "text": "A VNF Heat Orchestration Template's Base Module file name **MUST** include\ncase insensitive 'base' in the filename and\n**MUST** match one of the following four\nformats:\n\n 1.) ``base_<text>.y[a]ml``\n\n 2.) ``<text>_base.y[a]ml``\n\n 3.) ``base.y[a]ml``\n\n 4.) ``<text>_base_<text>``.y[a]ml\n\nwhere ``<text>`` **MUST** contain only alphanumeric characters and\nunderscores '_' and **MUST NOT** contain the case insensitive string\n``base`` or ``volume``.", "keyword": "MUST" }, { "id": "R-87247", - "text": "VNF Heat Orchestration Template's Incremental Module file name\n**MUST** contain only alphanumeric characters and underscores\n'_' and **MUST NOT** contain the case insensitive word ``base``.", + "text": "VNF Heat Orchestration Template's Incremental Module file name\n**MUST** contain only alphanumeric characters and underscores\n'_' and **MUST NOT** contain the case insensitive string ``base``.", "keyword": "MUST" }, { "id": "R-76057", - "text": "VNF Heat Orchestration Template's Nested YAML file name **MUST** contain\nonly alphanumeric characters and underscores '_' and\n**MUST NOT** contain the case insensitive word ``base``.", + "text": "VNF Heat Orchestration Template's Nested YAML file name **MUST** contain\nonly alphanumeric characters and underscores '_' and\n**MUST NOT** contain the case insensitive string ``base``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_cloud_config_resource_id", "test_case": "test_cloud_config", @@ -315,7 +316,69 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" + ], + "test_module": "test_contrail_instance_ip_parameters", + "test_case": "test_contrail_external_instance_ip_address_parameter", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-100000", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n**MUST** be declared as either type ``string`` or type\n``comma_delimited_list``.", + "keyword": "MUST" + }, + { + "id": "R-100010", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the ONAP definition, see Requirement R-57424),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST" + }, + { + "id": "R-100030", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_ips``\n\n where\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the external\n network", + "keyword": "MUST" + }, + { + "id": "R-100050", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network\n(per the\nONAP definition, see Requirement R-57424),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST" + }, + { + "id": "R-100070", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vpkg.yaml" + ], + "test_module": "test_contrail_instance_ip_parameters", + "test_case": "test_contrail_external_instance_subnet_id_parameter", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-100190", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid``\nparameter\n**MUST** be declared type ``string``.", + "keyword": "MUST" + }, + { + "id": "R-100200", + "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv4 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv4 subnet is to be specified\nusing the property ``subnet_uuid``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", + "keyword": "MUST" + }, + { + "id": "R-100220", + "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv6 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv6 subnet is to be specified\nusing the property ``subnet_uuid``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_v6_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vpkg.yaml" ], "test_module": "test_contrail_fqdn", "test_case": "test_contrail_fqdn", @@ -331,7 +394,28 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" + ], + "test_module": "test_contrail_instance_ip_parameters", + "test_case": "test_contrail_incremental_module_internal_subnet_usage", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-100240", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::ContrailV2::InstanceIp`` in an Incremental Module is\n assigning an IP address\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``subnet_uuid``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "keyword": "MUST" + }, + { + "id": "R-100260", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::ContrailV2::InstanceIp`` in an Incremental Module is\n attaching\n to an internal network (per the ONAP definition,\n see Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``subnet_uuid``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vpkg.yaml" ], "test_module": "test_contrail_instance_ip_resource_id", "test_case": "test_contrail_instance_ip_resource_id_external", @@ -340,19 +424,35 @@ "requirements": [ { "id": "R-53310", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv4 Address on a port attached to an external network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the {vm-type}\n* ``{network-role}`` is the network-role of the network that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type attached to the network of {network-role}\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` is the index of the IPv4 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv4 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an external network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network that the\n virtual machine interface is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` references the instance of the IPv4 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv4 address is configured on the\n virtual machine interface.", "keyword": "MUST" }, { "id": "R-46128", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv6 Address on a port attached to an external network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type\n attached to the network of {network-role}\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` is the index of the IPv6 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv6 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an external network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` references the instance of the IPv6 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv6 address is configured on the\n virtual machine interface.", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vpkg.yaml" + ], + "test_module": "test_contrail_vmi_resource_id", + "test_case": "test_contrail_instance_ip_resource_id_external", + "result": "SKIP", + "error": "", + "requirements": [ + { + "id": "R-96253", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` Resource ID\nthat is attaching to an external network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_contrail_instance_ip_resource_id", "test_case": "test_contrail_instance_ip_resource_id_internal", @@ -361,67 +461,202 @@ "requirements": [ { "id": "R-62187", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv4 Address on a port attached to an internal network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type\n attached to the network of ``{network-role}``\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` is the index of the IPv4 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv4 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an internal network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` references the instance of the IPv4 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv4 address is configured on the\n virtual machine interface.", "keyword": "MUST" }, { "id": "R-87563", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv6 Address on a port attached to an internal network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type\n attached to the network of ``{network-role}``\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` is the index of the IPv6 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv6 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an internal network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` references the instance of the IPv6 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv6 address is configured on the\n virtual machine interface.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_contrail_irt_routes", - "test_case": "test_contrail_irt_route_param_format", + "test_module": "test_contrail_vmi_resource_id", + "test_case": "test_contrail_instance_ip_resource_id_internal", "result": "SKIP", "error": "", "requirements": [ { - "id": "R-28222", - "text": "If a VNF's Heat Orchestration Template\n``OS::ContrailV2::InterfaceRouteTable`` resource\n``interface_route_table_routes`` property\n``interface_route_table_routes_route`` map property parameter name\n**MUST** follow the format\n\n* ``{vm-type}_{network-role}_route_prefixes``", + "id": "R-50468", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` Resource ID\nthat is attaching to an internal network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vpkg.yaml" + ], + "test_module": "test_contrail_resource_id", + "test_case": "test_contrail_interfaceroutetable_resource_id", + "result": "SKIP", + "error": "", + "requirements": [ + { + "id": "R-81214", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InterfaceRouteTable``\nResource ID\n**MUST**\ncontain the ``{network-role}``.", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vpkg.yaml" + ], + "test_module": "test_contrail_instance_ip_parameters", + "test_case": "test_contrail_internal_instance_ip_address_parameter", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-100000", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n**MUST** be declared as either type ``string`` or type\n``comma_delimited_list``.", + "keyword": "MUST" + }, + { + "id": "R-100090", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is\ndefined as a ``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST" + }, + { + "id": "R-100110", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "keyword": "MUST" + }, + { + "id": "R-100130", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST" + }, + { + "id": "R-100150", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vpkg.yaml" + ], + "test_module": "test_environment_file_parameters", + "test_case": "test_contrail_internal_instance_ip_does_exist_in_environment_file", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-100100", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_int_{network-role}_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-100120", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_int_{network-role}_int_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-100140", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_int_{network-role}_v6_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-100160", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_v6_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-100180", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp``\nproperty ``instance_ip_address``\nparameter associated with an internal network, i.e.,\n\n * ``{vm-type}_int_{network-role}_ip_{index}``\n * ``{vm-type}_int_{network-role}_v6_ip_{index}``\n * ``{vm-type}_int_{network-role}_ips``\n * ``{vm-type}_int_{network-role}_v6_ips``\n\n\n**MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and IP addresses **MUST** be\nassigned.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" + ], + "test_module": "test_contrail_instance_ip_parameters", + "test_case": "test_contrail_internal_instance_subnet_id_parameter", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-100190", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid``\nparameter\n**MUST** be declared type ``string``.", + "keyword": "MUST" + }, + { + "id": "R-100240", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::ContrailV2::InstanceIp`` in an Incremental Module is\n assigning an IP address\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``subnet_uuid``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "keyword": "MUST" + }, + { + "id": "R-100260", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::ContrailV2::InstanceIp`` in an Incremental Module is\n attaching\n to an internal network (per the ONAP definition,\n see Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``subnet_uuid``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vpkg.yaml" + ], + "test_module": "test_allowed_address_pairs_include_vm_type_network_role", + "test_case": "test_contrail_internal_vmi_aap_parameter", + "result": "PASS", + "error": "", + "requirements": [ + { + "id": "R-100360", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 Virtual IP (VIP)\naddress is assigned using the map property,\n``virtual_machine_interface_allowed_address_pairs,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n, the parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file.\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "keyword": "MUST" + }, + { + "id": "R-100370", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 Virtual IP (VIP)\naddress is assigned\nusing the map property,\n``virtual_machine_interface_allowed_address_pairs,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n, the parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "keyword": "MUST" + } + ] + }, + { + "files": [ + "../vvp/base_vpkg.yaml" ], "test_module": "test_contrail_irt_routes", - "test_case": "test_contrail_irt_route_param_type", + "test_case": "test_contrail_irt_route_param_format", "result": "SKIP", "error": "", "requirements": [ { - "id": "R-19756", - "text": "If a VNF's Heat Orchestration Template\n``OS::ContrailV2::InterfaceRouteTable`` resource\n``interface_route_table_routes`` property\n``interface_route_table_routes_route`` map property parameter\n``{vm-type}_{network-role}_route_prefixes``\n**MUST** be defined as type ``json``.", + "id": "R-28222", + "text": "If a VNF's Heat Orchestration Template\n``OS::ContrailV2::InterfaceRouteTable`` resource\n``interface_route_table_routes`` property\n``interface_route_table_routes_route`` map property parameter name\n**MUST** follow the format\n\n* ``{vm-type}_{network-role}_route_prefixes``", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_contrail_resource_id", - "test_case": "test_contrail_interfaceroutetable_resource_id", + "test_module": "test_contrail_irt_routes", + "test_case": "test_contrail_irt_route_param_type", "result": "SKIP", "error": "", "requirements": [ { - "id": "R-81214", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InterfaceRouteTable``\nResource ID\n**MUST**\ncontain the ``{network-role}``.", + "id": "R-19756", + "text": "If a VNF's Heat Orchestration Template\n``OS::ContrailV2::InterfaceRouteTable`` resource\n``interface_route_table_routes`` property\n``interface_route_table_routes_route`` map property parameter\n``{vm-type}_{network-role}_route_prefixes``\n**MUST** be defined as type ``json``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_contrail_resource_id", "test_case": "test_contrail_networkipam_resource_id", @@ -437,7 +672,7 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_contrail_resource_id", "test_case": "test_contrail_porttuple_resource_id", @@ -453,7 +688,7 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_contrail_resource_id", "test_case": "test_contrail_servicehealthcheck_resource_id", @@ -469,7 +704,7 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_contrail_resource_id", "test_case": "test_contrail_servicetemplate_resource_id", @@ -478,62 +713,46 @@ "requirements": [ { "id": "R-16437", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate``\nResource ID **MUST** contain the ``{vm-type}``.", - "keyword": "MUST" - } - ] - }, - { - "files": [ - "base_vpkg.yaml" - ], - "test_module": "test_contrail_vmi_resource_id", - "test_case": "test_contrail_instance_ip_resource_id_external", - "result": "SKIP", - "error": "", - "requirements": [ - { - "id": "R-96253", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` that is attaching to an external network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` is the instance of the vmi on the vm-type\n attached to the network of ``{network-role}``", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::ServiceTemplate``\nResource ID **MUST** contain the ``{vm-type}``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_contrail_vmi_resource_id", - "test_case": "test_contrail_instance_ip_resource_id_internal", - "result": "SKIP", + "test_module": "test_heat_parameter_section", + "test_case": "test_default_values", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-50468", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` that is attaching to an internal network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` is the instance of the vmi on the vm-type\n attached to the network of ``{network-role}``", + "id": "R-90526", + "text": "A VNF Heat Orchestration Template parameter declaration **MUST NOT**\ncontain the ``default`` attribute.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/template" ], - "test_module": "test_contrail_vn_resource_id", - "test_case": "test_neutron_net_resource_id", - "result": "SKIP", + "test_module": "test_volume_module_naming", + "test_case": "test_detected_volume_module_follows_naming_convention", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-99110", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualNetwork`` Resource ID **MUST** use the naming convention\n\n1) ``int_{network-role}_network``\n\nor\n\n2) ``int_{network-role}_RVN`` where RVN represents Resource Virtual\n Network\n\nVNF Heat Orchestration Templates can only create internal networks.\nThere is no ``{index}`` after ``{network-role}`` because ``{network-role}``\n**MUST** be unique in the scope of the VNF's\nHeat Orchestration Template.\n\nNote that option 1 is preferred.", + "id": "R-589037", + "text": "A VNF Heat Orchestration Template's Cinder Volume Module ``resources:``\nsection\n**MUST** only be defined using one of the following:\n\n* one of more ``OS::Cinder::Volume`` resources\n* one or more ``OS::Heat::ResourceGroup`` resources that call a nested YAML\n file that contains only ``OS::Cinder::Volume`` resources\n* a resource that calls a nested YAML file (static nesting) that contains\n only ``OS::Cinder::Volume`` resources", "keyword": "MUST" } ] }, { "files": [ - "." + "../vvp/template" ], "test_module": "test_env_and_yaml_same_name", "test_case": "test_env_and_yaml_same_name", @@ -559,7 +778,7 @@ }, { "files": [ - "../../../../../private/tmp/VVP-186/ice_validator/env_files0" + "../vvp/env_files0" ], "test_module": "test_env_no_resource_registry", "test_case": "test_env_no_resource_registry", @@ -575,7 +794,7 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_env_parameters_defined_in_template", "test_case": "test_env_params_are_defined_in_template", @@ -591,149 +810,117 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_environment_file_parameters", - "test_case": "test_nova_server_image_parameter_exists_in_environment_file", + "test_module": "test_nova_servers_environment_context", + "test_case": "test_environment_context", "result": "PASS", "error": "", "requirements": [ { - "id": "R-91125", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``image`` parameter **MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and a value **MUST** be assigned.", + "id": "R-20308", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``environment_context``\nparameter **MUST** be declared as ``environment_context`` and the\nparameter type **MUST** be defined as type: ``string``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_environment_file_parameters", - "test_case": "test_nova_server_flavor_parameter_exists_in_environment_file", - "result": "PASS", + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_environment_context_parameter_has_no_constraints", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-69431", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``flavor`` parameter **MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and a value **MUST** be assigned.", - "keyword": "MUST" + "id": "R-56183", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata``key/value pair ``environment_context``\nparameter ``environment_context`` **MUST NOT**\nhave parameter constraints defined.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.env" ], - "test_module": "test_environment_file_parameters", - "test_case": "test_neutron_port_internal_fixedips_ipaddress_parameter_exists_in_environment_file", + "test_module": "test_environment_file_structure", + "test_case": "test_environment_file_contains_required_sections", "result": "PASS", "error": "", "requirements": [ { - "id": "R-28795", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", - "keyword": "MUST" - }, - { - "id": "R-97201", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_v6_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", - "keyword": "MUST" - }, - { - "id": "R-93496", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``fixed_ips``\nmap property ``ip_address``\nparameter associated with an internal network, i.e.,\n\n * ``{vm-type}_int_{network-role}_ip_{index}``\n * ``{vm-type}_int_{network-role}_v6_ip_{index}``\n * ``{vm-type}_int_{network-role}_ips``\n * ``{vm-type}_int_{network-role}_v6_ips``\n\n\n**MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and IP addresses **MUST** be\nassigned.", - "keyword": "MUST" - }, - { - "id": "R-90206", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_int_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", - "keyword": "MUST" - }, - { - "id": "R-98569", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_v6_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", - "keyword": "MUST" - }, - { - "id": "R-93496", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``fixed_ips``\nmap property ``ip_address``\nparameter associated with an internal network, i.e.,\n\n * ``{vm-type}_int_{network-role}_ip_{index}``\n * ``{vm-type}_int_{network-role}_v6_ip_{index}``\n * ``{vm-type}_int_{network-role}_ips``\n * ``{vm-type}_int_{network-role}_v6_ips``\n\n\n**MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and IP addresses **MUST** be\nassigned.", + "id": "R-03324", + "text": "A VNF's Heat Orchestration template's Environment File **MUST**\ncontain the ``parameters:`` section.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_environment_file_parameters", - "test_case": "test_heat_rg_count_parameter_exists_in_environment_file", + "test_module": "test_allowed_address_pairs_include_vm_type_network_role", + "test_case": "test_external_aap_format", "result": "PASS", "error": "", "requirements": [ { - "id": "R-50011", - "text": "A VNF's Heat Orchestration Template's ``OS::Heat::ResourceGroup``\nproperty ``count`` **MUST** be enumerated in the VNF's\nHeat Orchestration Template's Environment File and **MUST** be\nassigned a value.", + "id": "R-41492", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv4 VIP is required to be supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nAs noted in the introduction to this section, the ONAP data model\ncan only support one IPv4 VIP address.", "keyword": "MUST" - } - ] - }, - { - "files": [ - "base_vpkg.env" - ], - "test_module": "test_environment_file_structure", - "test_case": "test_environment_file_contains_required_sections", - "result": "PASS", - "error": "", - "requirements": [ + }, { - "id": "R-03324", - "text": "A VNF's Heat Orchestration template's Environment File **MUST**\ncontain the ``parameters:`` section.", + "id": "R-35735", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv6 VIP is required to be supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nAs noted in the introduction to this section, the ONAP data model\ncan only support one IPv6 VIP address.", + "keyword": "MUST" + }, + { + "id": "R-41493", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv4 VIP address and/or IPv6 VIP address\nis **not** supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\n\n* Parameter name **MAY** use any naming convention. That is, there is no\n ONAP mandatory parameter naming convention.\n* Parameter **MAY** be declared as type ``string`` or type\n``comma_delimited_list``.\n\nAnd the ``OS::Neutron::Port`` resource **MUST** contain\nresource-level ``metadata`` (not property-level).\n\nAnd the ``metadata`` format **MUST** must contain the\nkey value ``aap_exempt`` with a list of all\n``allowed_address_pairs`` map property ``ip_address`` parameters\n**not** supported by the ONAP data model.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_filename_is_vmtype_dot_yaml", - "test_case": "test_filename_is_vmtype_dot_yaml", + "test_module": "test_allowed_address_pairs_include_vm_type_network_role", + "test_case": "test_external_aap_format_contrail", "result": "PASS", "error": "", "requirements": [ { - "id": "R-70276", - "text": "A VNF HEAT's Orchestration Nested Template's YAML file name **MUST NOT**\nbe in the format ``{vm-type}.y[a]ml`` where ``{vm-type}`` is defined\nin the Heat Orchestration Template.", + "id": "R-100280", + "text": "If a VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface``\nis attaching to an external network (per the\nONAP definition, see Requirement R-57424), the\nmap property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameter\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", "keyword": "MUST NOT" - } - ] - }, - { - "files": [ - "." - ], - "test_module": "test_files_in_flat_dir", - "test_case": "test_files_in_flat_dir", - "result": "PASS", - "error": "", - "requirements": [ + }, { - "id": "R-511776", - "text": "When a VNF's Heat Orchestration Template is ready\nto be on-boarded to ONAP,\nall files composing the VNF Heat Orchestration Template\n**MUST** be placed in a flat (i.e., non-hierarchical) directory and\narchived using ZIP. The resulting ZIP file is uploaded into ONAP.", + "id": "R-100310", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an external\nnetwork (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 Virtual IP (VIP)\nis required to be supported by the ONAP data model,\nthe map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nThe ONAP data model can only support one IPv4 VIP address.", "keyword": "MUST" }, { - "id": "R-99646", - "text": "A VNF's YAML files (i.e, Heat Orchestration Template files and\nNested files) **MUST** have a unique name in the scope of the VNF.", + "id": "R-100330", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an external\nnetwork (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 Virtual IP (VIP)\nis required to be supported by the ONAP data model,\nthe map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nThe ONAP data model can only support one IPv6 VIP address.", + "keyword": "MUST" + }, + { + "id": "R-100350", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an\nexternal network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv4 VIP address and/or IPv6 VIP address\nis **not** supported by the ONAP data model,\nthe map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\n* Parameter name **MAY** use any naming convention. That is, there is no\n ONAP mandatory parameter naming convention.\n* Parameter **MAY** be declared as type ``string`` or type\n``comma_delimited_list``.\n\nAnd the ``OS::ContrailV2::VirtualMachineInterface`` resource\n**MUST** contain resource-level ``metadata`` (not property-level).\n\nAnd the ``metadata`` format **MUST** must contain the\nkey value ``aap_exempt`` with a list of all map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameters **not** supported by the ONAP data model.", + "keyword": "MUST NOT" + }, + { + "id": "R-41493", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv4 VIP address and/or IPv6 VIP address\nis **not** supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\n\n* Parameter name **MAY** use any naming convention. That is, there is no\n ONAP mandatory parameter naming convention.\n* Parameter **MAY** be declared as type ``string`` or type\n``comma_delimited_list``.\n\nAnd the ``OS::Neutron::Port`` resource **MUST** contain\nresource-level ``metadata`` (not property-level).\n\nAnd the ``metadata`` format **MUST** must contain the\nkey value ``aap_exempt`` with a list of all\n``allowed_address_pairs`` map property ``ip_address`` parameters\n**not** supported by the ONAP data model.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_fixed_ips_include_vm_type_network_role", "test_case": "test_external_fip_format", @@ -747,7 +934,7 @@ }, { "id": "R-35735", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 Virtual IP (VIP)\naddress is assigned via ONAP automation\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as type ``string``.", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv6 VIP is required to be supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nAs noted in the introduction to this section, the ONAP data model\ncan only support one IPv6 VIP address.", "keyword": "MUST" }, { @@ -774,75 +961,86 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_fixed_ips_include_vm_type_network_role", - "test_case": "test_internal_fip_format", + "test_module": "test_neutron_port_network_attachment", + "test_case": "test_external_network_parameter", "result": "PASS", "error": "", "requirements": [ { - "id": "R-27818", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", - "keyword": "MUST" - }, - { - "id": "R-29765", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "id": "R-62983", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424), the\n``network`` parameter name **MUST**\n\n * follow the naming convention ``{network-role}_net_id`` if the Neutron\n network UUID value is used to reference the network\n * follow the naming convention ``{network-role}_net_name`` if the\n OpenStack network name is used to reference the network.\n\nwhere ``{network-role}`` is the network-role of the external network\nand a ``get_param`` **MUST** be used as the intrinsic function.", "keyword": "MUST" - }, + } + ] + }, + { + "files": [ + "../vvp/base_vpkg.yaml" + ], + "test_module": "test_neutron_port_fixed_ips_subnet", + "test_case": "test_external_subnet_format", + "result": "PASS", + "error": "", + "requirements": [ { - "id": "R-85235", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "id": "R-38236", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n**MUST** be declared type ``string``.", "keyword": "MUST" }, { - "id": "R-78380", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is\ndefined as a ``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "id": "R-62802", + "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` is attaching\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv4 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv4 subnet is to be specified\nusing the property ``fixed_ips``\nmap property ``subnet``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", "keyword": "MUST" }, { - "id": "R-34037", - "text": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n**MUST** be declared as either type ``string`` or type\n``comma_delimited_list``.", + "id": "R-15287", + "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` is attaching\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv6 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv6 subnet is to be specified\nusing the property ``fixed_ips``\nmap property ``subnet``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_v6_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_forbidden_resources", - "test_case": "test_neutron_floating_ip_resource_type", + "test_module": "test_filename_is_vmtype_dot_yaml", + "test_case": "test_filename_is_vmtype_dot_yaml", "result": "PASS", "error": "", "requirements": [ { - "id": "R-05257", - "text": "A VNF's Heat Orchestration Template's **MUST NOT**\ncontain the Resource ``OS::Neutron::FloatingIP``.", + "id": "R-70276", + "text": "A VNF HEAT's Orchestration Nested Template's YAML file name **MUST NOT**\nbe in the format ``{vm-type}.y[a]ml`` where ``{vm-type}`` is defined\nin the Heat Orchestration Template.", "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/template" ], - "test_module": "test_forbidden_resources", - "test_case": "test_neutron_floating_ip_association_resource_type", + "test_module": "test_files_in_flat_dir", + "test_case": "test_files_in_flat_dir", "result": "PASS", "error": "", "requirements": [ { - "id": "R-76449", - "text": "A VNF's Heat Orchestration Template's **MUST NOT**\ncontain the Resource ``OS::Neutron::FloatingIPAssociation``.", - "keyword": "MUST NOT" + "id": "R-511776", + "text": "When a VNF's Heat Orchestration Template is ready\nto be on-boarded to ONAP,\nall files composing the VNF Heat Orchestration Template\n**MUST** be placed in a flat (i.e., non-hierarchical) directory and\narchived using ZIP. The resulting ZIP file is uploaded into ONAP.", + "keyword": "MUST" + }, + { + "id": "R-99646", + "text": "A VNF's YAML files (i.e, Heat Orchestration Template files and\nNested files) **MUST** have a unique name in the scope of the VNF.", + "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_heat_pairs_provided", "test_case": "test_heat_pairs_provided", @@ -898,39 +1096,23 @@ }, { "files": [ - "base_vpkg.yaml" - ], - "test_module": "test_heat_parameter_section", - "test_case": "test_default_values", - "result": "PASS", - "error": "", - "requirements": [ - { - "id": "R-90526", - "text": "A VNF Heat Orchestration Template parameter declaration **MUST NOT**\ncontain the ``default`` attribute.", - "keyword": "MUST" - } - ] - }, - { - "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_heat_parameter_section", - "test_case": "test_parameter_names", + "test_module": "test_environment_file_parameters", + "test_case": "test_heat_rg_count_parameter_exists_in_environment_file", "result": "PASS", "error": "", "requirements": [ { - "id": "R-25877", - "text": "A VNF's Heat Orchestration Template's parameter name\n(i.e., <param name>) **MUST** contain only alphanumeric\ncharacters and underscores ('_').", + "id": "R-50011", + "text": "A VNF's Heat Orchestration Template's ``OS::Heat::ResourceGroup``\nproperty ``count`` **MUST** be enumerated in the VNF's\nHeat Orchestration Template's Environment File and **MUST** be\nassigned a value.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_heat_template_parameters_contain_required_fields", "test_case": "test_heat_template_parameters_contain_required_fields", @@ -951,39 +1133,39 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_heat_template_structure", - "test_case": "test_heat_template_structure_contains_heat_template_version", + "test_case": "test_heat_template_structure_contains_description", "result": "PASS", "error": "", "requirements": [ { - "id": "R-27078", - "text": "A VNF's Heat Orchestration template **MUST** contain the\nsection ``heat_template_version:``.", + "id": "R-39402", + "text": "A VNF's Heat Orchestration Template **MUST** contain the\nsection ``description:``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_heat_template_structure", - "test_case": "test_heat_template_structure_contains_description", + "test_case": "test_heat_template_structure_contains_heat_template_version", "result": "PASS", "error": "", "requirements": [ { - "id": "R-39402", - "text": "A VNF's Heat Orchestration Template **MUST** contain the\nsection ``description:``.", + "id": "R-27078", + "text": "A VNF's Heat Orchestration template **MUST** contain the\nsection ``heat_template_version:``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_heat_template_structure", "test_case": "test_heat_template_structure_contains_parameters", @@ -999,7 +1181,7 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_heat_template_structure", "test_case": "test_heat_template_structure_contains_resources", @@ -1015,1221 +1197,1219 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_heat_template_structure", - "test_case": "test_parameter_type", + "test_module": "test_nested_parameters", + "test_case": "test_iip_instance_ip_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-11441", - "text": "A VNF's Heat Orchestration Template's parameter type **MUST** be one of\nthe following values:\n\n* ``string``\n* ``number``\n* ``json``\n* ``comma_delimited_list``\n* ``boolean``", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_ip_parameters_start_at_0", - "test_case": "test_ips_start_at_0", + "test_module": "test_nested_parameters", + "test_case": "test_iip_subnet_uuid_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-71577", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", - "keyword": "MUST" - }, - { - "id": "R-40971", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_multipart_mime_resource_id", - "test_case": "test_multipart_mime", - "result": "SKIP", + "test_module": "test_incremental_module", + "test_case": "test_incremental_module_has_server", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-30804", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::Heat::MultipartMime``\nResource ID\n**MUST**\ncontain the ``{vm-type}``.", + "id": "R-610030", + "text": "A VNF's Heat Orchestration Template's Incremental Module **MUST**\ndeclare one or more ``OS::Nova::Server`` resources. A ``OS::Nova::Server``\n**MAY** be created in the incremental module or a nested yaml file invoked\nby the incremental module.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameter_args", - "test_case": "test_nested_parameter_args", - "result": "SKIP", + "test_module": "test_resource_indices", + "test_case": "test_indices_start_at_0_increment", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-10834", - "text": "If a VNF's Heat Orchestration Template resource attribute\n``property:`` uses a nested ``get_param``, the nested\n``get_param`` **MUST** reference an index.\n\nThat is, to obtain a property value, two ``get_param`` intrinsic\nfunctions are used. The second ``get_param`` must be used\nto obtain an index value used to reference a parameter value in\na parameter defined as ``type: comma_delimited_list``. For\nexample:\n\n* ``name: {get_param: [ name, get_param: index ] }``", + "id": "R-11690", + "text": "When a VNF's Heat Orchestration Template's Resource ID contains an\n``{index}``, the ``{index}`` is a numeric value that **MUST** start at\nzero and **MUST** increment by one.\n\nAs stated in R-16447,\n*a VNF's <resource ID> MUST be unique across all Heat\nOrchestration Templates and all HEAT Orchestration Template\nNested YAML files that are used to create the VNF*. While the ``{index}``\nwill start at zero in the VNF, the ``{index}`` may not start at zero\nin a given Heat Orchestration Template or HEAT Orchestration Template\nNested YAML file.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_name_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_allowed_address_pairs_include_vm_type_network_role", + "test_case": "test_internal_aap_format", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-717227", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 Virtual IP (VIP)\naddress is assigned using the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file.\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "keyword": "MUST" + }, + { + "id": "R-805572", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 Virtual IP (VIP)\naddress is assigned\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_image_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_fixed_ips_include_vm_type_network_role", + "test_case": "test_internal_fip_format", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-27818", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST" + }, + { + "id": "R-29765", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "keyword": "MUST" + }, + { + "id": "R-85235", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "keyword": "MUST" + }, + { + "id": "R-78380", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is\ndefined as a ``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST" + }, + { + "id": "R-34037", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n**MUST** be declared as either type ``string`` or type\n``comma_delimited_list``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_flavor_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_neutron_port_network_attachment", + "test_case": "test_internal_network_parameters", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-86182", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port``\nis in an incremental module and\nis attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nthe ``network`` parameter name **MUST**\n\n * follow the naming convention ``int_{network-role}_net_id`` if the\n network UUID value is used to reference the network\n * follow the naming convention ``int_{network-role}_net_name`` if the\n network name in is used to reference the network.\n\nwhere ``{network-role}`` is the network-role of the internal network and\na ``get_param`` **MUST** be used as the intrinsic function.", + "keyword": "MUST" + }, + { + "id": "R-22688", + "text": "When a VNF's Heat Orchestration Template creates an internal network\n(per the ONAP definition, see Requirements R-52425 and R-46461\nand R-35666) and the internal network needs to be shared between modules\nwithin a VNF, the internal network **MUST** be created either in the\n\n* the base module\n* a nested YAML file invoked by the base module\n\nand the base module **MUST** contain an output parameter that provides\neither the network UUID or network name.\n\n* If the network UUID value is used to reference the network, the output\n parameter name in the base module **MUST** follow the naming convention\n ``int_{network-role}_net_id``\n* If the network name in is used to reference the network, the output\n parameter name in the base template **MUST** follow the naming convention\n ``int_{network-role}_net_name``\n\n``{network-role}`` **MUST** be the network-role of the internal network\ncreated in the Base Module.\n\nThe Base Module Output Parameter MUST be declared in the ``parameters:``\nsection of the Incremental Module(s) where the ``OS::Neutron::Port``\nresource(s) is attaching to the internal network.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_vnf_id_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_neutron_port_fixed_ips_subnet", + "test_case": "test_internal_subnet_format", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-38236", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n**MUST** be declared type ``string``.", + "keyword": "MUST" + }, + { + "id": "R-84123", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "keyword": "MUST" + }, + { + "id": "R-76160", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see Requirements\n R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_vf_module_id_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_ip_parameters_start_at_0", + "test_case": "test_ips_start_at_0", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-71577", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST" + }, + { + "id": "R-40971", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_vnf_name_parameter_name_doesnt_change_in_nested_template", - "result": "PASS", + "test_module": "test_multipart_mime_resource_id", + "test_case": "test_multipart_mime", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-30804", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::Heat::MultipartMime``\nResource ID\n**MUST**\ncontain the ``{vm-type}``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_vf_module_name_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_nested_parameter_args", + "test_case": "test_nested_parameter_args", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", - "keyword": "MUST" + "id": "R-10834", + "text": "A VNF's Heat Orchestration Template resource attribute ``property:``\n**MUST NOT** use more than two levels of nested ``get_param`` intrinsic\nfunctions when deriving a property value. SDC does not support nested\n``get_param`` with recursive lists (i.e., a list inside list).\nThe second ``get_param`` in a nested lookup must directly derive its value\nwithout further calls to ``get_param`` functions.\n\n* Example of valid nesting:\n\n * ``name: {get_param: [ {vm-type}_names, {get_param : index } ] }``\n\n* Examples of invalid nesting. SDC will not support these examples since\n there is an array inside array.\n\n * ``name: {get_param: [ {vm-type}_names, { get_param: [ indexlist, 0 ] } ] }``\n * ``name: {get_param: [ {vm-type}_names, { get_param: [ indexlist1, { get_param: indexlist2 } ] } ] }``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_vm_role_parameter_name_doesnt_change_in_nested_template", - "result": "PASS", + "test_module": "test_nested_template_parameters", + "test_case": "test_nested_template_parameters", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-11041", + "text": "All parameters defined in a VNFs Nested YAML file\n**MUST** be passed in as properties of the resource calling\nthe nested yaml file.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_vf_module_index_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_nesting_level", + "test_case": "test_nesting_level", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-60011", + "text": "A VNF's Heat Orchestration Template **MUST** have no more than two\nlevels of nesting.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_workload_context_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_nesting_nova_server", + "test_case": "test_nesting_nova_server", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-17528", + "text": "A VNF's Heat Orchestration Template's first level Nested YAML file\n**MUST NOT** contain more than one ``OS::Nova::Server`` resource.\nA VNF's Heat Orchestration Template's second level Nested YAML file\n**MUST NOT** contain an ``OS::Nova::Server`` resource.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_server_metadata_environment_context_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_network_format", + "test_case": "test_network_has_subnet", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-16241", + "text": "A VNF's internal network **MUST** have one subnet.\nA VNF's internal network **MAY** have more than one subnet.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_port_network_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_network_format", + "test_case": "test_network_resource_id_format", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", - "keyword": "MUST" + "id": "R-16968", + "text": "A VNF's Heat Orchestration Templates **MUST NOT** include heat\nresources to create external networks.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_port_fip_ip_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_internal_networks", + "test_case": "test_networks_exist_for_internal_network_params", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-35666", + "text": "If a VNF has an internal network, the VNF Heat Orchestration Template\n**MUST** include the heat resources to create the internal network.\n\nA VNF's Internal Network is created using Neutron Heat Resources\n(i.e., ``OS::Neutron::Net``, ``OS::Neutron::Subnet``) and/or\nContrail Heat Resources (i.e., ``OS::ContrailV2::VirtualNetwork``,\n``ContrailV2::NetworkIpam``).", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_port_fip_subnet_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_forbidden_resources", + "test_case": "test_neutron_floating_ip_association_resource_type", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", - "keyword": "MUST" + "id": "R-76449", + "text": "A VNF's Heat Orchestration Template's **MUST NOT**\ncontain the Resource ``OS::Neutron::FloatingIPAssociation``.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_port_aap_ip_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_forbidden_resources", + "test_case": "test_neutron_floating_ip_resource_type", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", - "keyword": "MUST" + "id": "R-05257", + "text": "A VNF's Heat Orchestration Template's **MUST NOT**\ncontain the Resource ``OS::Neutron::FloatingIP``.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_vmi_net_ref_parameter_name_doesnt_change_in_nested_template", - "result": "PASS", + "test_module": "test_contrail_vn_resource_id", + "test_case": "test_neutron_net_resource_id", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-99110", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualNetwork`` Resource ID **MUST** use the naming\nconvention\n\n* ``int_{network-role}_network``\n\nVNF Heat Orchestration Templates can only create internal networks.\nThere is no ``{index}`` after ``{network-role}`` because ``{network-role}``\n**MUST** be unique in the scope of the VNF's\nHeat Orchestration Template.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_vmi_aap_parameter_name_doesnt_change_in_nested_template", - "result": "PASS", + "test_module": "test_neutron_net_resource_id", + "test_case": "test_neutron_net_resource_id", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-25720", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Net``\nResource ID **MUST** use the naming convention\n\n* ``int_{network-role}_network``\n\nVNF Heat Orchestration Templates can only create internal networks.\nThere is no ``{index}`` after ``{network-role}`` because ``{network-role}``\n**MUST** be unique in the scope of the VNF's\nHeat Orchestration Template.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nested_parameters", - "test_case": "test_iip_instance_ip_parameter_name_doesnt_change_in_nested_template", + "test_module": "test_neutron_port_fixed_ips_subnet", + "test_case": "test_neutron_port_internal_fixed_ips_subnet_in_base", "result": "PASS", "error": "", "requirements": [ { - "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", + "id": "R-84123", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", "keyword": "MUST" - } - ] - }, - { - "files": [ - "base_vpkg.yaml" - ], - "test_module": "test_nested_template_parameters", - "test_case": "test_nested_template_parameters", - "result": "SKIP", - "error": "", - "requirements": [ + }, { - "id": "R-11041", - "text": "All parameters defined in a VNFs Nested YAML file\n**MUST** be passed in as properties of the resource calling\nthe nested yaml file.", + "id": "R-76160", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see Requirements\n R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nesting_level", - "test_case": "test_nesting_level", + "test_module": "test_environment_file_parameters", + "test_case": "test_neutron_port_internal_fixedips_ipaddress_parameter_exists_in_environment_file", "result": "PASS", "error": "", "requirements": [ { - "id": "R-60011", - "text": "A VNF's Heat Orchestration Template **MUST** have no more than two\nlevels of nesting.", + "id": "R-28795", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-97201", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_v6_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-93496", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``fixed_ips``\nmap property ``ip_address``\nparameter associated with an internal network, i.e.,\n\n * ``{vm-type}_int_{network-role}_ip_{index}``\n * ``{vm-type}_int_{network-role}_v6_ip_{index}``\n * ``{vm-type}_int_{network-role}_ips``\n * ``{vm-type}_int_{network-role}_v6_ips``\n\n\n**MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and IP addresses **MUST** be\nassigned.", + "keyword": "MUST" + }, + { + "id": "R-90206", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_int_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-98569", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_v6_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST" + }, + { + "id": "R-93496", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``fixed_ips``\nmap property ``ip_address``\nparameter associated with an internal network, i.e.,\n\n * ``{vm-type}_int_{network-role}_ip_{index}``\n * ``{vm-type}_int_{network-role}_v6_ip_{index}``\n * ``{vm-type}_int_{network-role}_ips``\n * ``{vm-type}_int_{network-role}_v6_ips``\n\n\n**MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and IP addresses **MUST** be\nassigned.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nesting_nova_server", - "test_case": "test_nesting_nova_server", + "test_module": "test_neutron_port_network_parameter", + "test_case": "test_neutron_port_network_param_is_string", "result": "PASS", "error": "", "requirements": [ { - "id": "R-17528", - "text": "A VNF's Heat Orchestration Template's first level Nested YAML file\n**MUST NOT** contain more than one ``OS::Nova::Server`` resource.\nA VNF's Heat Orchestration Template's second level Nested YAML file\n**MUST NOT** contain an ``OS::Nova::Server`` resource.", + "id": "R-18008", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``network`` parameter **MUST** be declared as type: ``string``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_network_format", - "test_case": "test_network_resource_id_format", + "test_module": "test_no_http_resources", + "test_case": "test_no_http_resources", "result": "PASS", "error": "", "requirements": [ { - "id": "R-16968", - "text": "A VNF's Heat Orchestration Templates **MUST NOT** include heat\nresources to create external networks.", + "id": "R-71699", + "text": "A VNF's Heat Orchestration Template's Resource\n**MUST NOT** reference a HTTP-based Nested YAML file.", "keyword": "MUST NOT" }, { - "id": "R-35666", - "text": "If a VNF has an internal network, the VNF Heat Orchestration Template\n**MUST** include the heat resources to create the internal network.", - "keyword": "MUST" + "id": "R-53952", + "text": "A VNF's Heat Orchestration Template's Resource\n**MUST NOT** reference a HTTP-based resource definitions.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/template" ], - "test_module": "test_network_format", - "test_case": "test_network_has_subnet", + "test_module": "test_no_image_files", + "test_case": "test_no_image_files_included", "result": "PASS", "error": "", "requirements": [ { - "id": "R-16241", - "text": "A VNF's internal network **MUST** have one subnet.\nA VNF's internal network **MAY** have more than one subnet.", + "id": "R-348813", + "text": "The VNF's Heat Orchestration Template's ZIP file **MUST NOT** include\na binary image file.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_neutron_net_resource_id", - "test_case": "test_neutron_net_resource_id", - "result": "SKIP", + "test_module": "test_non_server_name", + "test_case": "test_non_server_name", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-25720", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Net``\nResource ID **MUST** use the naming convention\n\n* ``int_{network-role}_network``\n\nVNF Heat Orchestration Templates can only create internal networks.\nThere is no ``{index}`` after ``{network-role}`` because ``{network-role}``\n**MUST** be unique in the scope of the VNF's\nHeat Orchestration Template.", + "id": "R-85734", + "text": "If a VNF's Heat Orchestration Template contains the property ``name``\nfor a non ``OS::Nova::Server`` resource, the intrinsic function\n``str_replace`` **MUST** be used in conjunction with the ONAP\nsupplied metadata parameter ``vnf_name`` to generate a unique value.\nAdditional data **MAY** be used in the ``str_replace`` construct\nto generate a unique value.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_neutron_port_addresses", - "test_case": "test_neutron_port_external_ipaddress", + "test_module": "test_non_server_name", + "test_case": "test_non_server_name_unique", "result": "PASS", "error": "", "requirements": [ { - "id": "R-91810", - "text": "If a VNF requires ONAP to assign a Virtual IP (VIP) Address to\nports connected an external network, the port\n**MUST NOT** have more than one IPv4 VIP address.", - "keyword": "MUST NOT" + "id": "R-85734", + "text": "If a VNF's Heat Orchestration Template contains the property ``name``\nfor a non ``OS::Nova::Server`` resource, the intrinsic function\n``str_replace`` **MUST** be used in conjunction with the ONAP\nsupplied metadata parameter ``vnf_name`` to generate a unique value.\nAdditional data **MAY** be used in the ``str_replace`` construct\nto generate a unique value.", + "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_neutron_port_addresses", - "test_case": "test_neutron_port_external_ipaddress_v6", + "test_module": "test_nova_servers_vm_types", + "test_case": "test_nova_server_flavor_parameter", "result": "PASS", "error": "", "requirements": [ { - "id": "R-41956", - "text": "If a VNF requires ONAP to assign a Virtual IP (VIP) Address to\nports connected an external network, the port\n**MUST NOT** have more than one IPv6 VIP address.", - "keyword": "MUST NOT" + "id": "R-50436", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``flavor`` parameter **MUST** be declared as type: ``string``.", + "keyword": "MUST" + }, + { + "id": "R-45188", + "text": "The VNF's Heat Orchestration Template's Resource 'OS::Nova::Server' property\n``flavor`` parameter name **MUST** follow the naming convention\n``{vm-type}_flavor_name``.", + "keyword": "MUST" + }, + { + "id": "R-40499", + "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``flavor`` even if more than one ``{vm-type}`` shares the same flavor.", + "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_neutron_port_addresses", - "test_case": "test_neutron_port_floating", + "test_module": "test_environment_file_parameters", + "test_case": "test_nova_server_flavor_parameter_exists_in_environment_file", "result": "PASS", "error": "", "requirements": [ { - "id": "R-10754", - "text": "If a VNF has two or more ports that\nattach to an external network that require a Virtual IP Address (VIP),\nand the VNF requires ONAP automation to assign the IP address,\nall the Virtual Machines using the VIP address **MUST**\nbe instantiated in the same Base Module Heat Orchestration Template\nor in the same Incremental Module Heat Orchestration Template.", + "id": "R-69431", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``flavor`` parameter **MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and a value **MUST** be assigned.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_neutron_port_fixed_ips_subnet", - "test_case": "test_internal_subnet_format", + "test_module": "test_nova_servers_vm_types", + "test_case": "test_nova_server_image_parameter", "result": "PASS", "error": "", "requirements": [ { - "id": "R-38236", - "text": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n**MUST** be declared type ``string``.", + "id": "R-71152", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``image`` parameter **MUST** be declared as type: ``string``.", "keyword": "MUST" }, { - "id": "R-84123", - "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "id": "R-57282", + "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``image`` even if more than one ``{vm-type}`` shares the same image.", "keyword": "MUST" }, { - "id": "R-76160", - "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see Requirements\n R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "id": "R-58670", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``image`` parameter name **MUST** follow the naming convention\n``{vm-type}_image_name``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_neutron_port_fixed_ips_subnet", - "test_case": "test_external_subnet_format", + "test_module": "test_environment_file_parameters", + "test_case": "test_nova_server_image_parameter_exists_in_environment_file", "result": "PASS", "error": "", "requirements": [ { - "id": "R-38236", - "text": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n**MUST** be declared type ``string``.", - "keyword": "MUST" - }, - { - "id": "R-62802", - "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` is attaching\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv4 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv4 subnet is to be specified\nusing the property ``fixed_ips``\nmap property ``subnet``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", - "keyword": "MUST" - }, - { - "id": "R-15287", - "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` is attaching\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv6 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv6 subnet is to be specified\nusing the property ``fixed_ips``\nmap property ``subnet``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_v6_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", + "id": "R-91125", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``image`` parameter **MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and a value **MUST** be assigned.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_neutron_port_fixed_ips_subnet", - "test_case": "test_neutron_port_internal_fixed_ips_subnet_in_base", + "test_module": "test_nova_servers_vm_types", + "test_case": "test_nova_server_name_parameter", "result": "PASS", "error": "", "requirements": [ { - "id": "R-84123", - "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "id": "R-51430", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``name`` parameter **MUST** be declared as either type ``string``\nor type ``comma_delimited_list``.", "keyword": "MUST" }, { - "id": "R-76160", - "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see Requirements\n R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", - "keyword": "MUST" - } - ] - }, - { - "files": [ - "base_vpkg.yaml" - ], - "test_module": "test_neutron_port_network_attachment", - "test_case": "test_internal_network_parameters", - "result": "PASS", - "error": "", - "requirements": [ - { - "id": "R-86182", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand the internal network is created in a\ndifferent Heat Orchestration Template than the ``OS::Neutron::Port``,\nthe ``network`` parameter name **MUST**\n\n * follow the naming convention ``int_{network-role}_net_id`` if the Neutron\n network UUID value is used to reference the network\n * follow the naming convention ``int_{network-role}_net_name`` if the\n OpenStack network name in is used to reference the network.\n\nwhere ``{network-role}`` is the network-role of the internal network and\na ``get_param`` **MUST** be used as the intrinsic function.", + "id": "R-54171", + "text": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``string``,\nthe parameter name **MUST** follow the naming convention\n\n* ``{vm-type}_name_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at\nzero in a VNF's Heat Orchestration Template and **MUST** increment by one.", "keyword": "MUST" }, { - "id": "R-22688", - "text": "If a VNF's port is connected to an internal network and the port is\ncreated in an Incremental Module and the internal network is created\nin the Base Module then the UUID of the internal network **MUST** be\nexposed as a parameter in the ``outputs:`` section of the Base Module\nand the port resource **MUST** use a ``get_param`` to obtain the network\nUUID.", + "id": "R-87817", + "text": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``comma_delimited_list``,\nthe parameter name **MUST** follow the naming convention\n``{vm-type}_names``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_neutron_port_network_attachment", - "test_case": "test_external_network_parameter", + "test_module": "test_nova_server_name_parameters_start_at_0", + "test_case": "test_nova_server_name_parameter_starts_at", "result": "PASS", "error": "", "requirements": [ { - "id": "R-62983", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424), the\n``network`` parameter name **MUST**\n\n * follow the naming convention ``{network-role}_net_id`` if the Neutron\n network UUID value is used to reference the network\n * follow the naming convention ``{network-role}_net_name`` if the\n OpenStack network name is used to reference the network.\n\nwhere ``{network-role}`` is the network-role of the external network\nand a ``get_param`` **MUST** be used as the intrinsic function.", + "id": "R-54171", + "text": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``string``,\nthe parameter name **MUST** follow the naming convention\n\n* ``{vm-type}_name_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at\nzero in a VNF's Heat Orchestration Template and **MUST** increment by one.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_neutron_port_network_parameter", - "test_case": "test_neutron_port_network_param_is_string", + "test_module": "test_nova_server_resource_id", + "test_case": "test_nova_server_resource_id", "result": "PASS", "error": "", "requirements": [ { - "id": "R-18008", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``network`` parameter **MUST** be declared as type: ``string``.", + "id": "R-29751", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nResource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_server_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` is the index.\n The ``{index}`` **MUST** starts at zero and increment by one\n as described in R-11690.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_no_http_resources", - "test_case": "test_no_http_resources", + "test_module": "test_nova_servers_resource_ids", + "test_case": "test_nova_servers_valid_resource_ids", "result": "PASS", "error": "", "requirements": [ { - "id": "R-71699", - "text": "A VNF's Heat Orchestration Template's Resource\n**MUST NOT** reference a HTTP-based Nested YAML file.", - "keyword": "MUST NOT" + "id": "R-40499", + "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``flavor`` even if more than one ``{vm-type}`` shares the same flavor.", + "keyword": "MUST" }, { - "id": "R-53952", - "text": "A VNF's Heat Orchestration Template's Resource\n**MUST NOT** reference a HTTP-based resource definitions.", - "keyword": "MUST NOT" + "id": "R-57282", + "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``image`` even if more than one ``{vm-type}`` shares the same image.", + "keyword": "MUST" } ] }, { "files": [ - "." + "../vvp/base_vpkg.yaml" ], - "test_module": "test_no_image_files", - "test_case": "test_no_image_files_included", + "test_module": "test_oam_address_outputs", + "test_case": "test_oam_address_v4_zero_or_one", "result": "PASS", "error": "", "requirements": [ { - "id": "R-348813", - "text": "The VNF's Heat Orchestration Template's ZIP file **MUST NOT** include\na binary image file.", + "id": "R-18683", + "text": "If a VNF has one IPv4 OAM Management IP Address and the\nIP Address needs to be inventoried in ONAP's A&AI\ndatabase, an output parameter **MUST** be declared in only one of the\nVNF's Heat Orchestration Templates and the parameter **MUST** be named\n``oam_management_v4_address``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_non_server_name", - "test_case": "test_non_server_name", + "test_module": "test_oam_address_outputs", + "test_case": "test_oam_address_v6_zero_or_one", "result": "PASS", "error": "", "requirements": [ { - "id": "R-85734", - "text": "If a VNF's Heat Orchestration Template contains the property ``name``\nfor a non ``OS::Nova::Server`` resource, the intrinsic function\n``str_replace`` **MUST** be used in conjunction with the ONAP\nsupplied metadata parameter ``vnf_name`` to generate a unique value.\nAdditional data **MAY** be used in the ``str_replace`` construct\nto generate a unique value.", + "id": "R-94669", + "text": "If a VNF has one IPv6 OAM Management IP Address and the\nIP Address needs to be inventoried in ONAP's A&AI\ndatabase, an output parameter **MUST** be declared in only one of the\nVNF's Heat Orchestration Templates and the parameter **MUST** be named\n``oam_management_v6_address``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_non_server_name", - "test_case": "test_non_server_name_unique", + "test_module": "test_heat_parameter_section", + "test_case": "test_parameter_names", "result": "PASS", "error": "", "requirements": [ { - "id": "R-85734", - "text": "If a VNF's Heat Orchestration Template contains the property ``name``\nfor a non ``OS::Nova::Server`` resource, the intrinsic function\n``str_replace`` **MUST** be used in conjunction with the ONAP\nsupplied metadata parameter ``vnf_name`` to generate a unique value.\nAdditional data **MAY** be used in the ``str_replace`` construct\nto generate a unique value.", + "id": "R-25877", + "text": "A VNF's Heat Orchestration Template's parameter name\n(i.e., <param name>) **MUST** contain only alphanumeric\ncharacters and underscores ('_').", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nova_server_name_parameters_start_at_0", - "test_case": "test_nova_server_name_parameter_starts_at", + "test_module": "test_heat_template_structure", + "test_case": "test_parameter_type", "result": "PASS", "error": "", "requirements": [ { - "id": "R-54171", - "text": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``string``,\nthe parameter name **MUST** follow the naming convention\n\n* ``{vm-type}_name_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at\nzero in a VNF's Heat Orchestration Template and **MUST** increment by one.", + "id": "R-11441", + "text": "A VNF's Heat Orchestration Template's parameter type **MUST** be one of\nthe following values:\n\n* ``string``\n* ``number``\n* ``json``\n* ``comma_delimited_list``\n* ``boolean``", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nova_server_resource_id", - "test_case": "test_nova_server_resource_id", + "test_module": "test_nested_parameters", + "test_case": "test_port_aap_ip_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-29751", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` Resource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_server_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` is the index", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nova_servers_environment_context", - "test_case": "test_environment_context", + "test_module": "test_port_connected_to_multiple_servers", + "test_case": "test_port_connected_to_multiple_servers", "result": "PASS", "error": "", "requirements": [ { - "id": "R-20308", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``environment_context``\nparameter **MUST** be declared as ``environment_context`` and the\nparameter type **MUST** be defined as type: ``string``.", + "id": "R-92635", + "text": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nova_servers_resource_ids", - "test_case": "test_nova_servers_valid_resource_ids", + "test_module": "test_nested_parameters", + "test_case": "test_port_fip_ip_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-40499", - "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``flavor`` even if more than one ``{vm-type}`` shares the same flavor.", - "keyword": "MUST" - }, - { - "id": "R-57282", - "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``image`` even if more than one ``{vm-type}`` shares the same image.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nova_servers_vm_types", - "test_case": "test_vm_type_consistent_on_nova_servers", + "test_module": "test_nested_parameters", + "test_case": "test_port_fip_subnet_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-57282", - "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``image`` even if more than one ``{vm-type}`` shares the same image.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nova_servers_vm_types", - "test_case": "test_vm_type_network_role_collision", + "test_module": "test_nested_parameters", + "test_case": "test_port_network_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-48067", - "text": "A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST NOT** be a\nsubstring\nof ``{network-role}``.", - "keyword": "MUST NOT" - }, - { - "id": "R-00977", - "text": "A VNF's Heat Orchestration Template's ``{network-role}``\n**MUST NOT** be a substring of ``{vm-type}``.", + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nova_servers_vm_types", - "test_case": "test_nova_server_flavor_parameter", + "test_module": "test_port_resource_ids", + "test_case": "test_port_resource_ids", "result": "PASS", "error": "", "requirements": [ { - "id": "R-50436", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``flavor`` parameter **MUST** be declared as type: ``string``.", + "id": "R-20453", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an external network Resource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port_index}`` references the instance of the port on the ``{vm-type}``\n attached to ``{network-role}`` network. The\n ``{port_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new port is defined on the instance of the ``{vm-type}`` attached to\n ``{network-role}`` network.", "keyword": "MUST" }, { - "id": "R-45188", - "text": "The VNF's Heat Orchestration Template's Resource 'OS::Nova::Server' property\n``flavor`` parameter name **MUST** follow the naming convention\n``{vm-type}_flavor_name``.", + "id": "R-26351", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an internal network Resource ID **MUST**\nuse the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port_index}`` references the instance of the port on the ``{vm-type}``\n attached to ``{network-role}`` network. The\n ``{port_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new port is defined on the instance of the ``{vm-type}`` attached to\n ``{network-role}`` network.", "keyword": "MUST" }, { - "id": "R-40499", - "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``flavor`` even if more than one ``{vm-type}`` shares the same flavor.", + "id": "R-26506", + "text": "A VNF's Heat Orchestration Template's ``{network-role}`` **MUST** contain\nonly alphanumeric characters and/or underscores '_' and\n\n* **MUST NOT** contain any of the following strings: ``_int`` or ``int_``\n or ``_int_``\n* **MUST NOT** end in the string: ``_v6``\n* **MUST NOT** contain the strings ``_#_``, where ``#`` is a number\n* **MUST NOT** end in the string: ``_#``, where ``#`` is a number", + "keyword": "MUST NOT" + }, + { + "id": "R-681859", + "text": "A VNF's Heat Orchestration Template's ``OS::Neutron::Port`` resource's\n\n* Resource ID (defined in R-20453)\n* property ``network`` parameter name (defined in R-62983 and\n R-86182)\n* property ``fixed_ips``, map property ``ip_address`` parameter name\n (defined in R-40971, R-04697, R-71577, R-23503, R-78380, R-85235,\n R-27818, and R-29765)\n* property ``fixed_ips``, map property ``subnet`` parameter name\n (defined in R-62802, R-15287, R-84123, R-76160)\n* property ``allowed_address_pairs`` parameter name (defined in\n R-41492 and R-83418)\n\n**MUST** contain the identical ``{network-role}``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nova_servers_vm_types", - "test_case": "test_nova_server_name_parameter", + "test_module": "test_server_and_port_vm_indices_match", + "test_case": "test_server_and_port_vmtype_indices_match", "result": "PASS", "error": "", "requirements": [ { - "id": "R-51430", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``name`` parameter **MUST** be declared as either type ``string``\nor type ``comma_delimited_list``.", - "keyword": "MUST" - }, - { - "id": "R-54171", - "text": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``string``,\nthe parameter name **MUST** follow the naming convention\n\n* ``{vm-type}_name_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at\nzero in a VNF's Heat Orchestration Template and **MUST** increment by one.", - "keyword": "MUST" - }, - { - "id": "R-87817", - "text": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``comma_delimited_list``,\nthe parameter name **MUST** follow the naming convention\n``{vm-type}_names``.", + "id": "R-304011", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's\n\n* Resource ID (defined in R-29751)\n* property ``image`` parameter name (defined in R-58670)\n* property ``flavor`` parameter name (defined in R-45188)\n* property ``name`` parameter name (defined in R-54171 & R-87817)\n* property ``networks`` map property ``port`` value which is a\n ``OS::Neutron::Port`` Resource ID (defined in R-20453)\n referenced using the intrinsic function ``get_attr``\n\n**MUST** contain the identical ``{vm-type}``\nand **MUST** follow the naming conventions defined\nin R-58670, R-45188, R-54171, R-87817, and R-29751. And the ``{index}`` in\nthe ``OS::Nova::Server`` Resource ID (defined in R-29751) **MUST** match\nthe ``{vm-type_index}`` defined in\nthe ``OS::Nova::Server`` property ``networks`` map property ``port``\nreferenced ``OS::Neutron::Port`` Resource ID (defined in R-20453).", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nova_servers_vm_types", - "test_case": "test_nova_server_image_parameter", + "test_module": "test_nested_parameters", + "test_case": "test_server_flavor_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-71152", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``image`` parameter **MUST** be declared as type: ``string``.", - "keyword": "MUST" - }, - { - "id": "R-57282", - "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``image`` even if more than one ``{vm-type}`` shares the same image.", - "keyword": "MUST" - }, - { - "id": "R-58670", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``image`` parameter name **MUST** follow the naming convention\n``{vm-type}_image_name``.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nova_servers_vm_types_use_get_param", - "test_case": "test_vm_type_assignments_on_nova_servers_only_use_get_param", + "test_module": "test_nested_parameters", + "test_case": "test_server_image_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-901331", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``image`` value **MUST** be be obtained via a ``get_param``.", - "keyword": "MUST" - }, - { - "id": "R-481670", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``flavor`` value **MUST** be be obtained via a ``get_param``.", - "keyword": "MUST" - }, - { - "id": "R-663631", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` value **MUST** be be obtained via a ``get_param``.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_nova_servers_workload_context", - "test_case": "test_workload_context", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_environment_context_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-74978", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``workload_context``\nparameter **MUST**\nbe declared as ``workload_context`` and the parameter **MUST**\nbe defined as type: ``string``.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_oam_address_outputs", - "test_case": "test_oam_address_v4_zero_or_one", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_vf_module_id_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-18683", - "text": "If a VNF has one IPv4 OAM Management IP Address and the\nIP Address needs to be inventoried in ONAP's A&AI\ndatabase, an output parameter **MUST** be declared in only one of the\nVNF's Heat Orchestration Templates and the parameter **MUST** be named\n``oam_management_v4_address``.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_oam_address_outputs", - "test_case": "test_oam_address_v6_zero_or_one", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_vf_module_index_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-94669", - "text": "If a VNF has one IPv6 OAM Management IP Address and the\nIP Address needs to be inventoried in ONAP's A&AI\ndatabase, an output parameter **MUST** be declared in only one of the\nVNF's Heat Orchestration Templates and the parameter **MUST** be named\n``oam_management_v6_address``.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_port_connected_to_multiple_servers", - "test_case": "test_port_connected_to_multiple_servers", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_vf_module_name_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-92635", - "text": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_port_resource_ids", - "test_case": "test_port_resource_ids", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_vm_role_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-20453", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an external network Resource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port-index}`` is the instance of the port on the vm-type\n attached to the network of ``{network-role}``", - "keyword": "MUST" - }, - { - "id": "R-26351", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an internal network Resource ID **MUST**\nuse the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port-index}`` is the instance of the port on the vm-type\n attached to the network of ``{network-role}``", - "keyword": "MUST" - }, - { - "id": "R-26506", - "text": "A VNF's Heat Orchestration Template's ``{network-role}`` **MUST** contain\nonly alphanumeric characters and/or underscores '_' and\n**MUST NOT** contain any of the following strings:\n``_int`` or ``int_`` or ``_int_``.", - "keyword": "MUST" - }, - { - "id": "R-681859", - "text": "A VNF's Heat Orchestration Template's ``OS::Neutron::Port`` resource's\n\n* Resource ID (defined in R-20453)\n* property ``network`` parameter name (defined in R-62983 and\n R-86182)\n* property ``fixed_ips``, map property ``ip_address`` parameter name\n (defined in R-40971, R-04697, R-71577, R-23503, R-78380, R-85235,\n R-27818, and R-29765)\n* property ``fixed_ips``, map property ``subnet`` parameter name\n (defined in R-62802, R-15287, R-84123, R-76160)\n* property ``allowed_address_pairs`` parameter name (defined in\n R-41492 and R-83418)\n\n**MUST** contain the identical ``{network-role}``.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_vnf_id_parameter_has_no_constraints", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_vnf_id_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-55218", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property\n``metadata`` key/value pair ``vnf_id`` parameter ``vnf_id`` **MUST NOT**\nhave parameter constraints defined.", + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_vf_module_id_parameter_has_no_constraints", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_vnf_name_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-98374", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` key/value pair ``vf_module_id`` parameter ``vf_module_id``\n**MUST NOT**\nhave parameter constraints defined.", + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_vnf_name_parameter_has_no_constraints", + "test_module": "test_nested_parameters", + "test_case": "test_server_metadata_workload_context_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-44318", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vnf_name``\nparameter ``vnf_name`` **MUST NOT**\nhave parameter constraints defined.", + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_workload_context_parameter_has_no_constraints", - "result": "SKIP", + "test_module": "test_nested_parameters", + "test_case": "test_server_name_parameter_name_doesnt_change_in_nested_template", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-34055", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``workload_context``\nparameter ``workload_context`` **MUST NOT**\nhave parameter constraints defined.", + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_environment_context_parameter_has_no_constraints", - "result": "SKIP", + "test_module": "test_servers_have_required_metadata", + "test_case": "test_servers_have_required_metadata", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-56183", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata``key/value pair ``environment_context``\nparameter ``environment_context`` **MUST NOT**\nhave parameter constraints defined.", - "keyword": "MUST NOT" + "id": "R-37437", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MUST**\ncontain the key/value pair ``vnf_id``\nand the value **MUST** be obtained via a ``get_param``.", + "keyword": "MUST" + }, + { + "id": "R-71493", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` **MUST**\ncontain the key/value pair ``vf_module_id``\nand the value MUST be obtained via a ``get_param``.", + "keyword": "MUST" + }, + { + "id": "R-72483", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` **MUST** contain the key/value pair ``vnf_name`` and the\nvalue **MUST** be obtained via a ``get_param``.", + "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_vf_module_name_parameter_has_no_constraints", - "result": "SKIP", + "test_module": "test_servers_metadata_use_get_param", + "test_case": "test_servers_vf_module_id_metadata_use_get_param", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-15480", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vf_module_name`` parameter ``vf_module_name``\n**MUST NOT** have parameter constraints defined.", - "keyword": "MUST NOT" + "id": "R-71493", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` **MUST**\ncontain the key/value pair ``vf_module_id``\nand the value MUST be obtained via a ``get_param``.", + "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_vm_role_parameter_has_no_constraints", - "result": "SKIP", + "test_module": "test_servers_metadata_use_get_param", + "test_case": "test_servers_vf_module_index_metadata_use_get_param", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-67597", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` parameter ``vm_role``\n**MUST NOT** have parameter constraints defined.", - "keyword": "MUST NOT" + "id": "R-50816", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata``\nkey/value pair ``vf_module_index``\nvalue **MUST** be obtained via a ``get_param``.", + "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_required_parameters_no_constraints", - "test_case": "test_vf_module_index_parameter_has_no_constraints", - "result": "SKIP", + "test_module": "test_servers_metadata_use_get_param", + "test_case": "test_servers_vf_module_name_metadata_use_get_param", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-09811", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vf_module_index`` **MUST NOT**\nhave parameter constraints defined.", - "keyword": "MUST NOT" + "id": "R-68023", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vf_module_name``\nvalue **MUST**\nbe obtained via a ``get_param``.", + "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_resource_ids_alphanumeric_only", - "test_case": "test_alphanumeric_resource_ids_only", + "test_module": "test_servers_metadata_use_get_param", + "test_case": "test_servers_vnf_id_metadata_use_get_param", "result": "PASS", "error": "", "requirements": [ { - "id": "R-75141", - "text": "A VNF's Heat Orchestration Template's resource name\n(i.e., <resource ID>) **MUST** only contain alphanumeric\ncharacters and underscores ('_').", + "id": "R-37437", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MUST**\ncontain the key/value pair ``vnf_id``\nand the value **MUST** be obtained via a ``get_param``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_resource_indices", - "test_case": "test_indices_start_at_0_increment", + "test_module": "test_servers_metadata_use_get_param", + "test_case": "test_servers_vnf_name_metadata_use_get_param", "result": "PASS", "error": "", "requirements": [ { - "id": "R-11690", - "text": "When a VNF's Heat Orchestration Template's Resource ID contains an\n``{index}``, the ``{index}`` is a numeric value that **MUST** start at\nzero and **MUST** increment by one.\n\nAs stated in R-16447,\n*a VNF's <resource ID> MUST be unique across all Heat\nOrchestration Templates and all HEAT Orchestration Template\nNested YAML files that are used to create the VNF*. While the ``{index}``\nwill start at zero in the VNF, the ``{index}`` may not start at zero\nin a given Heat Orchestration Template or HEAT Orchestration Template\nNested YAML file.", + "id": "R-72483", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` **MUST** contain the key/value pair ``vnf_name`` and the\nvalue **MUST** be obtained via a ``get_param``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_server_and_port_vm_indices_match", - "test_case": "test_server_and_port_vmtype_indices_match", - "result": "PASS", + "test_module": "test_software_config_resource_id", + "test_case": "test_software_config_vm_type", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-304011", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's\n\n* Resource ID (defined in R-29751)\n* property ``image`` parameter name (defined in R-58670)\n* property ``flavor`` parameter name (defined in R-45188)\n* property ``name`` parameter name (defined in R-54171 & R-87817)\n* property port referenced OS::Neutron::Port Resource ID\n (defined in R-20453)\n\n**MUST** contain the identical ``{vm-type}``\nand **MUST** follow the naming conventions defined\nin R-58670, R-45188, R-54171, R-87817, and R-29751. And the ``{index}`` in\nthe ``OS::Nova::Server`` Resource ID (defined in R-29751) **MUST** match\nthe ``{vm-type_index}`` defined in\nthe ``OS::Nova::Server`` property ``port``\nreferenced ``OS::Neutron::Port`` Resource ID (defined in R-20453).", + "id": "R-08975", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::SoftwareConfig``\nResource ID **MUST** contain the ``{vm-type}``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_server_parameters", - "test_case": "test_availability_zone_parameter_type", + "test_module": "test_unique_resources_across_all_templates", + "test_case": "test_unique_resources_across_all_yaml_files", "result": "PASS", "error": "", "requirements": [ { - "id": "R-23311", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Nova::Server`` property\n``availability_zone`` parameter **MUST** be declared as type: ``string``.", + "id": "R-16447", + "text": "A VNF's <resource ID> **MUST** be unique across all Heat\nOrchestration Templates and all HEAT Orchestration Template\nNested YAML files that are used to create the VNF.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_server_parameters", - "test_case": "test_vnf_id_parameter_type_and_parameter_name", + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_vf_module_id_parameter_has_no_constraints", "result": "PASS", "error": "", "requirements": [ { - "id": "R-07507", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property\n``metadata`` key/value pair ``vnf_id`` parameter\n**MUST** be declared as ``vnf_id`` and the parameter **MUST**\nbe defined as type: ``string``.", - "keyword": "MUST" + "id": "R-98374", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` key/value pair ``vf_module_id`` parameter ``vf_module_id``\n**MUST NOT**\nhave parameter constraints defined.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], "test_module": "test_server_parameters", "test_case": "test_vf_module_id_parameter_type_and_parameter_name", @@ -2245,23 +2425,55 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" + ], + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_vf_module_index_parameter_has_no_constraints", + "result": "SKIP", + "error": "", + "requirements": [ + { + "id": "R-09811", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vf_module_index`` **MUST NOT**\nhave parameter constraints defined.", + "keyword": "MUST NOT" + } + ] + }, + { + "files": [ + "../vvp/base_vpkg.yaml" ], "test_module": "test_server_parameters", - "test_case": "test_vnf_name_parameter_type_and_parameter_name", + "test_case": "test_vf_module_index_parameter_type_and_parameter_name", "result": "PASS", "error": "", "requirements": [ { - "id": "R-62428", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vnf_name`` parameter **MUST**\nbe declared as ``vnf_name`` and the parameter **MUST** be defined as\ntype: ``string``.", + "id": "R-54340", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vf_module_index`` parameter **MUST**\nbe declared as ``vf_module_index`` and the parameter **MUST** be\ndefined as type: ``number``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" + ], + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_vf_module_name_parameter_has_no_constraints", + "result": "SKIP", + "error": "", + "requirements": [ + { + "id": "R-15480", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vf_module_name`` parameter ``vf_module_name``\n**MUST NOT** have parameter constraints defined.", + "keyword": "MUST NOT" + } + ] + }, + { + "files": [ + "../vvp/base_vpkg.yaml" ], "test_module": "test_server_parameters", "test_case": "test_vf_module_name_parameter_type_and_parameter_name", @@ -2277,285 +2489,306 @@ }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_server_parameters", - "test_case": "test_vf_module_index_parameter_type_and_parameter_name", - "result": "PASS", + "test_module": "test_vm_class_has_unique_type", + "test_case": "test_vm_class_has_unique_type", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-54340", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vf_module_index`` parameter **MUST**\nbe declared as ``vf_module_index`` and the parameter **MUST** be\ndefined as type: ``number``.", + "id": "R-01455", + "text": "When a VNF's Heat Orchestration Template creates a Virtual Machine\n(i.e., ``OS::Nova::Server``),\neach \"class\" of VMs **MUST** be assigned a VNF unique\n``{vm-type}``; where \"class\" defines VMs that\n**MUST** have the following identical characteristics:\n\n 1.) ``OS::Nova::Server`` resource property ``flavor`` value\n\n 2.) ``OS::Nova::Server`` resource property ``image`` value\n\n 3.) Cinder Volume attachments\n\n - Each VM in the \"class\" **MUST** have the identical Cinder Volume\n configuration\n\n 4.) Network attachments and IP address requirements\n\n - Each VM in the \"class\" **MUST** have the identical number of\n ports connecting to the identical networks and requiring the identical\n IP address configuration.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_servers_have_required_metadata", - "test_case": "test_servers_have_required_metadata", - "result": "PASS", + "test_module": "test_vm_role_value", + "test_case": "test_vm_role_from_env_file", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-37437", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MUST**\ncontain the key/value pair ``vnf_id``\nand the value **MUST** be obtained via a ``get_param``.", - "keyword": "MUST" - }, - { - "id": "R-71493", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` **MUST**\ncontain the key/value pair ``vf_module_id``\nand the value MUST be obtained via a ``get_param``.", - "keyword": "MUST" - }, - { - "id": "R-72483", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` **MUST** contain the key/value pair ``vnf_name`` and the\nvalue **MUST** be obtained via a ``get_param``.", + "id": "R-86476", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` value **MUST**\nonly contain alphanumeric characters and underscores (i.e., '_').", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_servers_metadata_use_get_param", - "test_case": "test_servers_vnf_id_metadata_use_get_param", + "test_module": "test_vm_role_value", + "test_case": "test_vm_role_hardcoded", "result": "PASS", "error": "", "requirements": [ { - "id": "R-37437", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MUST**\ncontain the key/value pair ``vnf_id``\nand the value **MUST** be obtained via a ``get_param``.", + "id": "R-86476", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` value **MUST**\nonly contain alphanumeric characters and underscores (i.e., '_').", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_servers_metadata_use_get_param", - "test_case": "test_servers_vf_module_id_metadata_use_get_param", - "result": "PASS", + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_vm_role_parameter_has_no_constraints", + "result": "SKIP", "error": "", "requirements": [ { - "id": "R-71493", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` **MUST**\ncontain the key/value pair ``vf_module_id``\nand the value MUST be obtained via a ``get_param``.", - "keyword": "MUST" + "id": "R-67597", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` parameter ``vm_role``\n**MUST NOT** have parameter constraints defined.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_servers_metadata_use_get_param", - "test_case": "test_servers_vnf_name_metadata_use_get_param", + "test_module": "test_nova_servers_vm_types_use_get_param", + "test_case": "test_vm_type_assignments_on_nova_servers_only_use_get_param", "result": "PASS", "error": "", "requirements": [ { - "id": "R-72483", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` **MUST** contain the key/value pair ``vnf_name`` and the\nvalue **MUST** be obtained via a ``get_param``.", + "id": "R-901331", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``image`` value **MUST** be be obtained via a ``get_param``.", + "keyword": "MUST" + }, + { + "id": "R-481670", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``flavor`` value **MUST** be be obtained via a ``get_param``.", + "keyword": "MUST" + }, + { + "id": "R-663631", + "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` value **MUST** be be obtained via a ``get_param``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_servers_metadata_use_get_param", - "test_case": "test_servers_vf_module_name_metadata_use_get_param", + "test_module": "test_vm_type_case", + "test_case": "test_vm_type_case", "result": "PASS", "error": "", "requirements": [ { - "id": "R-68023", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` **SHOULD**\ncontain the key/value pair ``vf_module_name`` and the value **MUST**\nbe obtained via a ``get_param``.", + "id": "R-32394", + "text": "A VNF's Heat Orchestration Template's use of ``{vm-type}`` in all Resource\nproperty parameter names **MUST** be the same case.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_servers_metadata_use_get_param", - "test_case": "test_servers_vf_module_index_metadata_use_get_param", + "test_module": "test_nova_servers_vm_types", + "test_case": "test_vm_type_consistent_on_nova_servers", "result": "PASS", "error": "", "requirements": [ { - "id": "R-50816", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MAY**\ncontain the key/value pair ``vf_module_index``\nand the value **MUST** be obtained via a ``get_param``.", + "id": "R-57282", + "text": "Each VNF's Heat Orchestration Template's ``{vm-type}`` **MUST**\nhave a unique parameter name for the ``OS::Nova::Server`` property\n``image`` even if more than one ``{vm-type}`` shares the same image.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_software_config_resource_id", - "test_case": "test_software_config_vm_type", - "result": "SKIP", + "test_module": "test_nova_servers_vm_types", + "test_case": "test_vm_type_network_role_collision", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-08975", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::SoftwareConfig``\nResource ID **MUST** contain the ``{vm-type}``.", - "keyword": "MUST" + "id": "R-48067", + "text": "A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST NOT** be a\nsubstring\nof ``{network-role}``.", + "keyword": "MUST NOT" + }, + { + "id": "R-00977", + "text": "A VNF's Heat Orchestration Template's ``{network-role}``\n**MUST NOT** be a substring of ``{vm-type}``.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_unique_name_str_replace_use_req_params", - "test_case": "test_unique_name_str_replace_use_req_params", + "test_module": "test_vm_type_resource_id", + "test_case": "test_vm_type_resource_id", "result": "PASS", "error": "", "requirements": [ { - "id": "R-85734", - "text": "If a VNF's Heat Orchestration Template contains the property ``name``\nfor a non ``OS::Nova::Server`` resource, the intrinsic function\n``str_replace`` **MUST** be used in conjunction with the ONAP\nsupplied metadata parameter ``vnf_name`` to generate a unique value.\nAdditional data **MAY** be used in the ``str_replace`` construct\nto generate a unique value.", + "id": "R-46839", + "text": "A VNF's Heat Orchestration Template's use of ``{vm-type}``\nin all Resource IDs **MUST** be the same case.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_unique_resources_across_all_templates", - "test_case": "test_unique_resources_across_all_yaml_files", + "test_module": "test_vm_type_syntax", + "test_case": "test_vm_type_syntax", "result": "PASS", "error": "", "requirements": [ { - "id": "R-16447", - "text": "A VNF's <resource ID> **MUST** be unique across all Heat\nOrchestration Templates and all HEAT Orchestration Template\nNested YAML files that are used to create the VNF.", - "keyword": "MUST" + "id": "R-98407", + "text": "A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST** contain only\nalphanumeric characters and/or underscores '_' and **MUST NOT**\ncontain any of the following strings:\n``_int`` or ``int_`` or ``_int_``.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_vm_class_has_unique_type", - "test_case": "test_vm_class_has_unique_type", - "result": "SKIP", + "test_module": "test_nested_parameters", + "test_case": "test_vmi_aap_parameter_name_doesnt_change_in_nested_template", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-01455", - "text": "When a VNF's Heat Orchestration Template creates a Virtual Machine\n(i.e., ``OS::Nova::Server``),\neach \"class\" of VMs **MUST** be assigned a VNF unique\n``{vm-type}``; where \"class\" defines VMs that\n**MUST** have the following identical characteristics:\n\n 1.) ``OS::Nova::Server`` resource property ``flavor`` value\n\n 2.) ``OS::Nova::Server`` resource property ``image`` value\n\n 3.) Cinder Volume attachments\n\n - Each VM in the \"class\" **MUST** have the identical Cinder Volume\n configuration\n\n 4.) Network attachments and IP address requirements\n\n - Each VM in the \"class\" **MUST** have the identical number of\n ports connecting to the identical networks and requiring the identical\n IP address configuration.", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_vm_role_value", - "test_case": "test_vm_role_hardcoded", + "test_module": "test_nested_parameters", + "test_case": "test_vmi_net_ref_parameter_name_doesnt_change_in_nested_template", "result": "PASS", "error": "", "requirements": [ { - "id": "R-86476", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` value **MUST**\nonly contain alphanumeric characters and underscores (i.e., '_').", - "keyword": "MUST" + "id": "R-708564", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_vm_role_value", - "test_case": "test_vm_role_from_env_file", - "result": "SKIP", + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_vnf_id_parameter_has_no_constraints", + "result": "PASS", "error": "", "requirements": [ { - "id": "R-86476", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` value **MUST**\nonly contain alphanumeric characters and underscores (i.e., '_').", - "keyword": "MUST" + "id": "R-55218", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property\n``metadata`` key/value pair ``vnf_id`` parameter ``vnf_id`` **MUST NOT**\nhave parameter constraints defined.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_vm_type_case", - "test_case": "test_vm_type_case", + "test_module": "test_server_parameters", + "test_case": "test_vnf_id_parameter_type_and_parameter_name", "result": "PASS", "error": "", "requirements": [ { - "id": "R-32394", - "text": "A VNF's Heat Orchestration Template's use of ``{vm-type}`` in all Resource\nproperty parameter names **MUST** be the same case.", + "id": "R-07507", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property\n``metadata`` key/value pair ``vnf_id`` parameter\n**MUST** be declared as ``vnf_id`` and the parameter **MUST**\nbe defined as type: ``string``.", "keyword": "MUST" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_vm_type_resource_id", - "test_case": "test_vm_type_resource_id", + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_vnf_name_parameter_has_no_constraints", "result": "PASS", "error": "", "requirements": [ { - "id": "R-46839", - "text": "A VNF's Heat Orchestration Template's use of ``{vm-type}``\nin all Resource IDs **MUST** be the same case.", - "keyword": "MUST" + "id": "R-44318", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vnf_name``\nparameter ``vnf_name`` **MUST NOT**\nhave parameter constraints defined.", + "keyword": "MUST NOT" } ] }, { "files": [ - "base_vpkg.yaml" + "../vvp/base_vpkg.yaml" ], - "test_module": "test_vm_type_syntax", - "test_case": "test_vm_type_syntax", + "test_module": "test_server_parameters", + "test_case": "test_vnf_name_parameter_type_and_parameter_name", "result": "PASS", "error": "", "requirements": [ { - "id": "R-98407", - "text": "A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST** contain only\nalphanumeric characters and/or underscores '_' and **MUST NOT**\ncontain any of the following strings:\n``_int`` or ``int_`` or ``_int_``.", - "keyword": "MUST NOT" + "id": "R-62428", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vnf_name`` parameter **MUST**\nbe declared as ``vnf_name`` and the parameter **MUST** be defined as\ntype: ``string``.", + "keyword": "MUST" } ] }, { "files": [ - "." + "../vvp/base_vpkg.yaml" ], - "test_module": "test_volume_module_naming", - "test_case": "test_detected_volume_module_follows_naming_convention", + "test_module": "test_nova_servers_workload_context", + "test_case": "test_workload_context", "result": "PASS", "error": "", "requirements": [ { - "id": "R-589037", - "text": "A VNF Heat Orchestration Template's Cinder Volume Module resources section\n**MUST** only be defined using one of the following:\n\n* one of more ``OS::Cinder::Volume`` resources\n* one or more ``OS::Heat::ResourceGroup`` resources that call a nested YAML\n file that contains only ``OS::Cinder::Volume`` resources\n* a resource that calls a nested YAML file (static nesting) that contains\n only ``OS::Cinder::Volume`` resources", + "id": "R-74978", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``workload_context``\nparameter **MUST**\nbe declared as ``workload_context`` and the parameter **MUST**\nbe defined as type: ``string``.", "keyword": "MUST" } ] + }, + { + "files": [ + "../vvp/base_vpkg.yaml" + ], + "test_module": "test_required_parameters_no_constraints", + "test_case": "test_workload_context_parameter_has_no_constraints", + "result": "SKIP", + "error": "", + "requirements": [ + { + "id": "R-34055", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``workload_context``\nparameter ``workload_context`` **MUST NOT**\nhave parameter constraints defined.", + "keyword": "MUST NOT" + } + ] } ], "requirements": [ @@ -2568,7 +2801,7 @@ }, { "id": "R-00068", - "text": "The xNF Package **MUST** include documentation which includes\na description of parameters that can be monitored for the xNF\nand event records (status, fault, flow, session, call, control\nplane, etc.) generated by the xNF after instantiation.", + "text": "The VNF or PNF Documentation Package **MUST** include\na description of parameters that can be monitored for the VNF or PNF\nand event records (status, fault, flow, session, call, control\nplane, etc.) generated by the VNF or PNF after instantiation.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2582,7 +2815,7 @@ }, { "id": "R-00156", - "text": "The xNF Package **MUST** include documentation describing xNF\nManagement APIs, which must include information and tools for\nONAP to monitor the health of the xNF (conditions that require\nhealing and/or scaling responses).", + "text": "The VNF or PNF Documentation Package **MUST** describe the VNF or PNF\nManagement APIs, which must include information and tools for\nONAP to monitor the health of the VNF or PNF (conditions that require\nhealing and/or scaling responses).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2610,7 +2843,7 @@ }, { "id": "R-01033", - "text": "The xNF **MAY** use another option which is expected to include SFTP\nfor asynchronous bulk files, such as bulk files that contain large volumes\nof data collected over a long time interval or data collected across many\nxNFs. (Preferred is to reorganize the data into more frequent or more focused\ndata sets, and deliver these by REST or TCP as appropriate.)", + "text": "The VNF or PNF **MAY** use another option which is expected to include SFTP\nfor asynchronous bulk files, such as bulk files that contain large volumes\nof data collected over a long time interval or data collected across many\nVNFs or PNFs. (Preferred is to reorganize the data into more frequent or more focused\ndata sets, and deliver these by REST or TCP as appropriate.)", "keyword": "MAY", "result": "PASS", "errors": [] @@ -2624,35 +2857,35 @@ }, { "id": "R-01123", - "text": "The VNF package Manifest file **MUST** contain: VNF package meta-data, a\nlist of all artifacts (both internal and external) entry's including\ntheir respected URI's, an algorithm to calculate a digest and a digest\nresult calculated on the content of each artifacts, as specified in\nETSI GS NFV-SOL004. The VNF Package MUST include VNF Identification\nData to uniquely identify the resource for a given VNF provider. The\nidentification data must include: an identifier for the VNF, the name\nof the VNF as was given by the VNF provider, VNF description, VNF\nprovider, and version.", + "text": "The VNF or PNF package Manifest file **MUST** contain: VNF or PNF\npackage meta-data, a list of all artifacts (both internal and\nexternal) entry's including their respected URI's, as specified\nin ETSI GS NFV-SOL 004", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-01334", - "text": "The xNF **MUST** conform to the NETCONF RFC 5717,\n\"Partial Lock Remote Procedure Call\".", + "text": "The VNF or PNF **MUST** conform to the NETCONF RFC 5717,\n\"Partial Lock Remote Procedure Call\".", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-01359", - "text": "A VNF's Heat Orchestration Template that contains an ``OS::Nova:Server``\nResource **MAY** define a parameter for the property\n``availability_zone`` that is not utilized in any ``OS::Nova::Server``\nresources in the Heat Orchestration Template.", + "text": "A VNF's Heat Orchestration Template that contains an ``OS::Nova:Server``\nresource **MAY** define a parameter for the property\n``availability_zone`` that is not utilized in any ``OS::Nova::Server``\nresources in the Heat Orchestration Template.", "keyword": "MAY", "result": "PASS", "errors": [] }, { "id": "R-01382", - "text": "The xNF **MUST** allow the entire configuration of the xNF to be\nretrieved via NETCONF's <get-config> and <edit-config>, independently\nof whether it was configured via NETCONF or other mechanisms.", + "text": "The VNF or PNF **MUST** allow the entire configuration of the VNF or PNF to be\nretrieved via NETCONF's <get-config> and <edit-config>, independently\nof whether it was configured via NETCONF or other mechanisms.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-01427", - "text": "The xNF **MUST** support the provisioning of security and authentication\nparameters (HTTP username and password) in order to be able to authenticate\nwith DCAE (in ONAP).\n\nNote: In R3, a username and password are used with the DCAE VES Event\nListener which are used for HTTP Basic Authentication.\n\nNote: The configuration management and provisioning software are specific\nto a vendor architecture.", + "text": "If the VNF or PNF is using Basic Authentication, then the VNF or\nPNF **MUST** support the provisioning of security and authentication\nparameters (HTTP username and password) in order to be able to\nauthenticate with DCAE VES Event Listener.\n\nNote: The configuration management and provisioning software\nare specific to a vendor architecture.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2666,14 +2899,14 @@ }, { "id": "R-01478", - "text": "The xNF Package **MUST** include documentation describing all\nparameters that are available to monitor the xNF after instantiation\n(includes all counters, OIDs, PM data, KPIs, etc.) that must be\ncollected for reporting purposes.", + "text": "The VNF or PNF Documentation Package **MUST** describe all\nparameters that are available to monitor the VNF or PNF after instantiation\n(includes all counters, OIDs, PM data, KPIs, etc.) that must be\ncollected for reporting purposes.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-01556", - "text": "The xNF Package **MUST** include documentation describing the\nfault, performance, capacity events/alarms and other event records\nthat are made available by the xNF.", + "text": "The VNF or PNF Documentation Package **MUST** describe the\nfault, performance, capacity events/alarms and other event records\nthat are made available by the VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2714,22 +2947,29 @@ "errors": [] }, { + "id": "R-025941", + "text": "The VNF or PNF PROVIDER **MUST** provide FM Meta Data to support the\nanalysis of fault events delivered to DCAE. The Meta Data must be\nincluded in the VES Registration YAML file with each fault event\nsupported by that NF at onboarding time and the Meta Data must follow\nthe VES Event Listener and VES Event Registration Specifications.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-02597", - "text": "The xNF **MUST** implement the protocol operation:\n``lock(target)`` - Lock the configuration data store target.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``lock(target)`` - Lock the configuration data store target.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-02616", - "text": "The xNF **MUST** permit locking at the finest granularity\nif a xNF needs to lock an object for configuration to avoid blocking\nsimultaneous configuration operations on unrelated objects (e.g., BGP\nconfiguration should not be locked out if an interface is being\nconfigured or entire Interface configuration should not be locked out\nif a non-overlapping parameter on the interface is being configured).", + "text": "The VNF or PNF **MUST** permit locking at the finest granularity\nif a VNF or PNF needs to lock an object for configuration to avoid blocking\nsimultaneous configuration operations on unrelated objects (e.g., BGP\nconfiguration should not be locked out if an interface is being\nconfigured or entire Interface configuration should not be locked out\nif a non-overlapping parameter on the interface is being configured).", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-02651", - "text": "The xNF **SHOULD** use available backup capabilities to save a\ncopy of configuration files before implementing changes to support\noperations such as backing out of software upgrades, configuration\nchanges or other work as this will help backing out of configuration\nchanges when needed.", + "text": "The VNF or PNF **SHOULD** use available backup capabilities to save a\ncopy of configuration files before implementing changes to support\noperations such as backing out of software upgrades, configuration\nchanges or other work as this will help backing out of configuration\nchanges when needed.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -2750,14 +2990,14 @@ }, { "id": "R-03070", - "text": "The xNF **MUST**, by ONAP Policy, provide the ONAP addresses\nas data destinations for each xNF, and may be changed by Policy while\nthe xNF is in operation. We expect the xNF to be capable of redirecting\ntraffic to changed destinations with no loss of data, for example from\none REST URL to another, or from one TCP host and port to another.", + "text": "The VNF or PNF **MUST**, by ONAP Policy, provide the ONAP addresses\nas data destinations for each VNF or PNF, and may be changed by Policy while\nthe VNF or PNF is in operation. We expect the VNF or PNF to be capable of redirecting\ntraffic to changed destinations with no loss of data, for example from\none REST URL to another, or from one TCP host and port to another.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-03251", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::CinderVolume``\n**MAY** be defined in a Cinder Volume Module.", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume``\n**MAY** be defined in a Cinder Volume Module.", "keyword": "MAY", "result": "PASS", "errors": [] @@ -2771,7 +3011,7 @@ }, { "id": "R-03465", - "text": "The xNF **MUST** release locks to prevent permanent lock-outs\nwhen the corresponding <partial-unlock> operation succeeds.", + "text": "The VNF or PNF **MUST** release locks to prevent permanent lock-outs\nwhen the corresponding <partial-unlock> operation succeeds.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2799,14 +3039,14 @@ }, { "id": "R-04158", - "text": "The xNF **MUST** conform to the NETCONF RFC 4742,\n\"Using the NETCONF Configuration Protocol over Secure Shell (SSH)\".", + "text": "The VNF or PNF **MUST** conform to the NETCONF RFC 4742,\n\"Using the NETCONF Configuration Protocol over Secure Shell (SSH)\".", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-04298", - "text": "The xNF provider **MUST** provide their testing scripts to\nsupport testing.", + "text": "The VNF provider **MUST** provide their testing scripts to\nsupport testing.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2904,14 +3144,14 @@ }, { "id": "R-06924", - "text": "The xNF **MUST** deliver asynchronous data as data becomes\navailable, or according to the configured frequency.", + "text": "The VNF or PNF **MUST** deliver asynchronous data as data becomes\navailable, or according to the configured frequency.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-07251", - "text": "The xNF **MUST** support APPC/SDN-C ``ResumeTraffic`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``ResumeTraffic`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2932,7 +3172,7 @@ }, { "id": "R-07545", - "text": "The xNF **MUST** support all operations, administration and\nmanagement (OAM) functions available from the supplier for xNFs using\nthe supplied YANG code and associated NETCONF servers.", + "text": "The VNF or PNF **MUST** support all operations, administration and\nmanagement (OAM) functions available from the supplier for VNFs or PNFs\nusing the supplied YANG code and associated NETCONF servers.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -2946,14 +3186,14 @@ }, { "id": "R-08134", - "text": "The xNF **MUST** conform to the NETCONF RFC 6241,\n\"NETCONF Configuration Protocol\".", + "text": "The VNF or PNF **MUST** conform to the NETCONF RFC 6241,\n\"NETCONF Configuration Protocol\".", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-08312", - "text": "The xNF **MAY** use another option which is expected to include REST\ndelivery of binary encoded data sets.", + "text": "The VNF or PNF **MAY** use another option which is expected to include REST\ndelivery of binary encoded data sets.", "keyword": "MAY", "result": "PASS", "errors": [] @@ -2994,59 +3234,311 @@ "errors": [] }, { + "id": "R-100000", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n**MUST** be declared as either type ``string`` or type\n``comma_delimited_list``.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100010", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the ONAP definition, see Requirement R-57424),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100020", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_{network-role}_ip_{index}``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100030", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_ips``\n\n where\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the external\n network", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100040", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_{network-role}_ips``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100050", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network\n(per the\nONAP definition, see Requirement R-57424),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a string,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100060", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_{network-role}_v6_ip_{index}``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100070", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100080", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_{network-role}_v6_ips``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100090", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is\ndefined as a ``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100100", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_int_{network-role}_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100110", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100120", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_int_{network-role}_int_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100130", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100140", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nparameter\n``{vm-type}_int_{network-role}_v6_ip_{index}``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100150", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` is assigning an IP address to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``instance_ip_address``\nand the parameter type is defined as a\n``comma_delimited_list``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100160", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``instance_ip_address``\nmap property ``ip_address`` parameter\n``{vm-type}_int_{network-role}_v6_ips``\n**MUST** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100170", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp``\nproperty ``instance_ip_address``\nparameter associated with an external network, i.e.,\n\n * ``{vm-type}_{network-role}_ip_{index}``\n * ``{vm-type}_{network-role}_v6_ip_{index}``\n * ``{vm-type}_{network-role}_ips``\n * ``{vm-type}_{network-role}_v6_ips``\n\n\n**MUST NOT** be enumerated in the Heat Orchestration\nTemplate's Environment File. ONAP provides the IP address\nassignments at orchestration time.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100180", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp``\nproperty ``instance_ip_address``\nparameter associated with an internal network, i.e.,\n\n * ``{vm-type}_int_{network-role}_ip_{index}``\n * ``{vm-type}_int_{network-role}_v6_ip_{index}``\n * ``{vm-type}_int_{network-role}_ips``\n * ``{vm-type}_int_{network-role}_v6_ips``\n\n\n**MUST** be enumerated in the Heat Orchestration\nTemplate's Environment File and IP addresses **MUST** be\nassigned.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100190", + "text": "The VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` property ``subnet_uuid``\nparameter\n**MUST** be declared type ``string``.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100200", + "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv4 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv4 subnet is to be specified\nusing the property ``subnet_uuid``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100210", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``subnet_uuid``\nparameter\n``{network-role}_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100220", + "text": "When the VNF's Heat Orchestration Template's\nresource ``OS::ContrailV2::InstanceIp`` is assigning an IP address\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv6 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv6 subnet is to be specified\nusing the property ``subnet_uuid``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_v6_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100230", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``subnet_uuid``\nparameter\n``{network-role}_v6_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100240", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::ContrailV2::InstanceIp`` in an Incremental Module is\n assigning an IP address\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``subnet_uuid``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100250", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``subnet_uuid``\nparameter\n``int_{network-role}_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100260", + "text": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::ContrailV2::InstanceIp`` in an Incremental Module is\n attaching\n to an internal network (per the ONAP definition,\n see Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``subnet_uuid``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100270", + "text": "The VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` property ``subnet_uuid``\nparameter\n``int_{network-role}_v6_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100280", + "text": "If a VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface``\nis attaching to an external network (per the\nONAP definition, see Requirement R-57424), the\nmap property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameter\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100310", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an external\nnetwork (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 Virtual IP (VIP)\nis required to be supported by the ONAP data model,\nthe map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nThe ONAP data model can only support one IPv4 VIP address.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100330", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an external\nnetwork (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 Virtual IP (VIP)\nis required to be supported by the ONAP data model,\nthe map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nThe ONAP data model can only support one IPv6 VIP address.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100350", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an\nexternal network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv4 VIP address and/or IPv6 VIP address\nis **not** supported by the ONAP data model,\nthe map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\n* Parameter name **MAY** use any naming convention. That is, there is no\n ONAP mandatory parameter naming convention.\n* Parameter **MAY** be declared as type ``string`` or type\n``comma_delimited_list``.\n\nAnd the ``OS::ContrailV2::VirtualMachineInterface`` resource\n**MUST** contain resource-level ``metadata`` (not property-level).\n\nAnd the ``metadata`` format **MUST** must contain the\nkey value ``aap_exempt`` with a list of all map property\n\n``virtual_machine_interface_allowed_address_pairs``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``,\n\n``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n\nparameters **not** supported by the ONAP data model.", + "keyword": "MUST NOT", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100360", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 Virtual IP (VIP)\naddress is assigned using the map property,\n``virtual_machine_interface_allowed_address_pairs,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n, the parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file.\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100370", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` is attaching to an\ninternal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 Virtual IP (VIP)\naddress is assigned\nusing the map property,\n``virtual_machine_interface_allowed_address_pairs,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip,\nvirtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n, the parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100380", + "text": "If a VNF requires the use of an SSH key created by OpenStack, the VNF\nHeat Orchestration Template **SHOULD** create the ``OS::Nova::Keypair``\nin the base module, and expose the public key as an output value.\n\nThis allows re-use of the key by ONAP when triggering scale out, recovery,\nor other day 1 operations.", + "keyword": "SHOULD", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100400", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty metadata **SHOULD** contain the key/value pair ``vf_module_name``.", + "keyword": "SHOULD", + "result": "PASS", + "errors": [] + }, + { + "id": "R-100410", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MAY**\ncontain the key/value pair ``vf_module_index``.", + "keyword": "MAY", + "result": "PASS", + "errors": [] + }, + { "id": "R-10087", - "text": "The VNF package **MUST** contain all standard artifacts as specified in\nETSI GS NFV-SOL004 including Manifest file, VNFD (or Main TOSCA/YAML\nbased Service Template) and other optional artifacts. CSAR Manifest\nfile as per SOL004 - for example ROOT\\\\ **MainServiceTemplate.mf**", + "text": "The VNF or PNF CSAR package **MUST** include all artifacts required by\nETSI GS NFV-SOL004 including Manifest file, VNFD or PNFD (or Main\nTOSCA/YAML based Service Template) and other optional artifacts.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-10129", - "text": "The xNF **SHOULD** conform its YANG model to RFC 7223,\n\"A YANG Data Model for Interface Management\".", + "text": "The VNF or PNF **SHOULD** conform its YANG model to RFC 7223,\n\"A YANG Data Model for Interface Management\".", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-10173", - "text": "The xNF **MUST** allow another NETCONF session to be able to\ninitiate the release of the lock by killing the session owning the lock,\nusing the <kill-session> operation to guard against hung NETCONF sessions.", + "text": "The VNF or PNF **MUST** allow another NETCONF session to be able to\ninitiate the release of the lock by killing the session owning the lock,\nusing the <kill-session> operation to guard against hung NETCONF sessions.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-10353", - "text": "The xNF **MUST** conform its YANG model to RFC 6244,\n\"An Architecture for Network Management Using NETCONF and YANG\".", + "text": "The VNF or PNF **MUST** conform its YANG model to RFC 6244,\n\"An Architecture for Network Management Using NETCONF and YANG\".", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-106240", - "text": "The following VES Events **MUST** be supported by the PNF: pnfRegistration\nVES Event, HVol VES Event, and Fault VES Event. These are onboarded via\nhe SDC Design Studio.\n\nNote: these VES Events are emitted from the PNF to support PNF Plug and\nPlay, High Volume Measurements, and Fault events respectively.", - "keyword": "MUST", + "text": "The following VES Events **SHOULD** be supported by the PNF: pnfRegistration\nVES Event, HVol VES Event, and Fault VES Event. These are onboarded via\nhe SDC Design Studio.\n\nNote: these VES Events are emitted from the PNF to support PNF Plug and\nPlay, High Volume Measurements, and Fault events respectively.", + "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-10716", - "text": "The xNF **MUST** support parallel and simultaneous\nconfiguration of separate objects within itself.", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { - "id": "R-10754", - "text": "If a VNF has two or more ports that\nattach to an external network that require a Virtual IP Address (VIP),\nand the VNF requires ONAP automation to assign the IP address,\nall the Virtual Machines using the VIP address **MUST**\nbe instantiated in the same Base Module Heat Orchestration Template\nor in the same Incremental Module Heat Orchestration Template.", + "text": "The VNF or PNF **MUST** support parallel and simultaneous\nconfiguration of separate objects within itself.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-10834", - "text": "If a VNF's Heat Orchestration Template resource attribute\n``property:`` uses a nested ``get_param``, the nested\n``get_param`` **MUST** reference an index.\n\nThat is, to obtain a property value, two ``get_param`` intrinsic\nfunctions are used. The second ``get_param`` must be used\nto obtain an index value used to reference a parameter value in\na parameter defined as ``type: comma_delimited_list``. For\nexample:\n\n* ``name: {get_param: [ name, get_param: index ] }``", - "keyword": "MUST", - "result": "SKIP", + "text": "A VNF's Heat Orchestration Template resource attribute ``property:``\n**MUST NOT** use more than two levels of nested ``get_param`` intrinsic\nfunctions when deriving a property value. SDC does not support nested\n``get_param`` with recursive lists (i.e., a list inside list).\nThe second ``get_param`` in a nested lookup must directly derive its value\nwithout further calls to ``get_param`` functions.\n\n* Example of valid nesting:\n\n * ``name: {get_param: [ {vm-type}_names, {get_param : index } ] }``\n\n* Examples of invalid nesting. SDC will not support these examples since\n there is an array inside array.\n\n * ``name: {get_param: [ {vm-type}_names, { get_param: [ indexlist, 0 ] } ] }``\n * ``name: {get_param: [ {vm-type}_names, { get_param: [ indexlist1, { get_param: indexlist2 } ] } ] }``", + "keyword": "MUST NOT", + "result": "PASS", "errors": [] }, { @@ -3072,14 +3564,14 @@ }, { "id": "R-11235", - "text": "The xNF **MUST** implement the protocol operation:\n``kill-session(session``- Force the termination of **session**.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``kill-session(session``- Force the termination of **session**.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-11240", - "text": "The xNF **MUST** respond with content encoded in JSON, as\ndescribed in the RESTCONF specification. This way the encoding of a\nsynchronous communication will be consistent with Avro.", + "text": "The VNF or PNF **MUST** respond with content encoded in JSON, as\ndescribed in the RESTCONF specification. This way the encoding of a\nsynchronous communication will be consistent with Avro.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3093,7 +3585,7 @@ }, { "id": "R-11499", - "text": "The xNF **MUST** fully support the XPath 1.0 specification\nfor filtered retrieval of configuration and other database contents.\nThe 'type' attribute within the <filter> parameter for <get> and\n<get-config> operations may be set to 'xpath'. The 'select' attribute\n(which contains the XPath expression) will also be supported by the\nserver. A server may support partial XPath retrieval filtering, but\nit cannot advertise the ``:xpath`` capability unless the entire XPath\n1.0 specification is supported.", + "text": "The VNF or PNF **MUST** fully support the XPath 1.0 specification\nfor filtered retrieval of configuration and other database contents.\nThe 'type' attribute within the <filter> parameter for <get> and\n<get-config> operations may be set to 'xpath'. The 'select' attribute\n(which contains the XPath expression) will also be supported by the\nserver. A server may support partial XPath retrieval filtering, but\nit cannot advertise the ``:xpath`` capability unless the entire XPath\n1.0 specification is supported.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3121,7 +3613,7 @@ }, { "id": "R-120182", - "text": "The xNF provider **MUST** indicate specific conditions that may arise, and\nrecommend actions that may be taken at specific thresholds, or if specific\nconditions repeat within a specified time interval, using the semantics and\nsyntax described by the :doc:`VES Event Registration specification <../../../../vnfsdk/model.git/docs/files/VESEventRegistration_3_0>`.", + "text": "The VNF or PNF provider **MUST** indicate specific conditions that may arise, and\nrecommend actions that may be taken at specific thresholds, or if specific\nconditions repeat within a specified time interval, using the semantics and\nsyntax described by the :ref:`VES Event Registration specification <ves_event_registration_3_2>`.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3135,14 +3627,14 @@ }, { "id": "R-12271", - "text": "The xNF **SHOULD** conform its YANG model to RFC 7223,\n\"IANA Interface Type YANG Module\".", + "text": "The VNF or PNF **SHOULD** conform its YANG model to RFC 7223,\n\"IANA Interface Type YANG Module\".", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-123044", - "text": "The xNF Provider **MAY** require that specific events, identified by their\n``eventName``, require that certain fields, which are optional in the common\nevent format, must be present when they are published.", + "text": "The VNF or PNF Provider **MAY** require that specific events, identified by their\n``eventName``, require that certain fields, which are optional in the common\nevent format, must be present when they are published.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3163,14 +3655,14 @@ }, { "id": "R-12678", - "text": "The xNF Package **MUST** include documentation which includes a\ndescription of runtime lifecycle events and related actions (e.g.,\ncontrol responses, tests) which can be performed for the xNF.", + "text": "The VNF or PNF Documentation Package **MUST** include a\ndescription of runtime lifecycle events and related actions (e.g.,\ncontrol responses, tests) which can be performed for the VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-12706", - "text": "The xNF **MUST** support APPC/SDN-C ``QuiesceTraffic`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``QuiesceTraffic`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3183,6 +3675,13 @@ "errors": [] }, { + "id": "R-130206", + "text": "If the VNF or PNF CSAR Package utilizes Option 1 for package security, then\nthe complete CSAR file **MUST** contain a Digest (a.k.a. hash) for each of\nthe components of the VNF or PNF package. The table of hashes is included\nin the package manifest file, which is signed with the VNF or PNF provider\nprivate key. In addition, the VNF or PNF provider MUST include a signing\ncertificate that includes the VNF or PNF provider public key, following a\nTOSCA pre-defined naming convention and located either at the root of the\narchive or in a predefined location specified by the TOSCA.meta file with\nthe corresponding entry named \"ETSI-Entry-Certificate\".", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-13151", "text": "The VNF **SHOULD** disable the paging of the data requiring\nencryption, if possible, where the encryption of non-transient data is\nrequired on a device for which the operating system performs paging to\nvirtual memory. If not possible to disable the paging of the data\nrequiring encryption, the virtual memory should be encrypted.", "keyword": "SHOULD", @@ -3212,7 +3711,7 @@ }, { "id": "R-13390", - "text": "The xNF provider **MUST** provide cookbooks to be loaded\non the appropriate Chef Server.", + "text": "The VNF or PNF provider **MUST** provide cookbooks to be loaded\non the appropriate Chef Server.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3233,7 +3732,7 @@ }, { "id": "R-13800", - "text": "The xNF **MUST** conform to the NETCONF RFC 5277,\n\"NETCONF Event Notification\".", + "text": "The VNF or PNF **MUST** conform to the NETCONF RFC 5277,\n\"NETCONF Event Notification\".", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3247,14 +3746,21 @@ }, { "id": "R-14447", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate``\nResource ID **MAY** use the naming convention\n\n* ``{vm-type}_RST_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``RST`` signifies that it is the Resource Service Template\n* ``{index}`` is the index", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate``\nResource ID **MAY** use the naming convention\n\n* ``{vm-type}_RST_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``RST`` signifies that it is the Resource Service Template\n* ``{index}`` is the index.\n The ``{index}`` starts at zero and increments by one\n (as described in R-11690).", "keyword": "MAY", "result": "PASS", "errors": [] }, { + "id": "R-146092", + "text": "If one or more non-MANO artifact(s) is included in the VNF or PNF TOSCA CSAR\npackage, the Manifest file in this CSAR package **MUST** contain: non-MANO\nartifact set which MAY contain following ONAP public tag.\n\n - onap_ves_events: contains VES registration files\n\n - onap_pm_dictionary: contains the PM dictionary files\n\n - onap_yang_modules: contains Yang module files for configurations\n\n - onap_ansible_playbooks: contains any ansible_playbooks\n\n - onap_others: contains any other non_MANO artifacts, e.g. informational\n documents", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-146931", - "text": "The xNF **MUST** report exactly one Measurement event per period\nper source name.", + "text": "The VNF or PNF **MUST** report exactly one Measurement event per period\nper source name.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3317,19 +3823,12 @@ }, { "id": "R-15885", - "text": "The xNF **MUST** Upon completion of the chef-client run,\nPOST back on the callback URL, a JSON object as described in Table\nA2 if the chef-client run list includes a cookbook/recipe that is\ncallback capable. Failure to POST on the Callback Url should not be\nconsidered a critical error. That is, if the chef-client successfully\ncompletes the xNF action, it should reflect this status on the Chef\nServer regardless of whether the Callback succeeded or not.", + "text": "The VNF or PNF **MUST** Upon completion of the chef-client run,\nPOST back on the callback URL, a JSON object as described in Table\nA2 if the chef-client run list includes a cookbook/recipe that is\ncallback capable. Failure to POST on the Callback Url should not be\nconsidered a critical error. That is, if the chef-client successfully\ncompletes the VNF or PNF action, it should reflect this status on the Chef\nServer regardless of whether the Callback succeeded or not.", "keyword": "MUST", "result": "PASS", "errors": [] }, { - "id": "R-159016", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nECOMP definition, see Requirement R-57424),\nand an IPv4 and/or IPv6 Virtual IP (VIP)\naddress is assigned via ECOMP automation\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``, the\nparameter **MUST NOT** be declared as ``type: comma_deliited_list``.", - "keyword": "MUST NOT", - "result": "PASS", - "errors": [] - }, - { "id": "R-16039", "text": "The VNF **SHOULD** test for adherence to the defined\nresiliency rating recommendation at each layer, during each\ndelivery cycle so that the resiliency rating is measured and\nfeedback is provided where software resiliency requirements are\nnot met.", "keyword": "SHOULD", @@ -3338,7 +3837,7 @@ }, { "id": "R-16065", - "text": "The xNF provider **MUST** provide configurable parameters\n(if unable to conform to YANG model) including xNF attributes/parameters\nand valid values, dynamic attributes and cross parameter dependencies\n(e.g., customer provisioning data).", + "text": "The VNF or PNF provider **MUST** provide configurable parameters\n(if unable to conform to YANG model) including VNF or PNF attributes/parameters\nand valid values, dynamic attributes and cross parameter dependencies\n(e.g., customer provisioning data).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3352,7 +3851,7 @@ }, { "id": "R-16437", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate``\nResource ID **MUST** contain the ``{vm-type}``.", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::ServiceTemplate``\nResource ID **MUST** contain the ``{vm-type}``.", "keyword": "MUST", "result": "SKIP", "errors": [] @@ -3380,14 +3879,14 @@ }, { "id": "R-16777", - "text": "The xNF provider **MUST** provide a JSON file for each\nsupported action for the xNF. The JSON file must contain key value\npairs with all relevant values populated with sample data that illustrates\nits usage. The fields and their description are defined in Table B1\nin the Appendix.", + "text": "The VNF or PNF provider **MUST** provide a JSON file for each\nsupported action for the VNF or PNF. The JSON file must contain key value\npairs with all relevant values populated with sample data that illustrates\nits usage. The fields and their description are defined in Table B1\nin the Appendix.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-16875", - "text": "The xNF Package **MUST** include documentation which must include\na unique identification string for the specific xNF, a description of\nthe problem that caused the error, and steps or procedures to perform\nRoot Cause Analysis and resolve the issue.", + "text": "The VNF or PNF Documentation Package **MUST** include documentation which must\ninclude a unique identification string for the specific VNF or PNF, a description\nof the problem that caused the error, and steps or procedures to perform\nRoot Cause Analysis and resolve the issue.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3421,6 +3920,13 @@ "errors": [] }, { + "id": "R-177937", + "text": "The PNFD provided by a PNF vendor\u00a0**MUST**\u00a0comply with the following\nCapabilities Types as specified in ETSI NFV-SOL001 standard:\n\n - tosca.datatypes.nfv.VirtualLinkable", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-17852", "text": "The VNFD **MAY** include TOSCA/YAML definitions that are not part of\nNFV Profile. If provided, these definitions MUST comply with TOSCA\nSimple Profile in YAML v.1.2.", "keyword": "MAY", @@ -3429,7 +3935,7 @@ }, { "id": "R-18001", - "text": "If the VNF's ports connected to a unique internal network\nand the port's IP addresses are statically assigned IP Addresses,\nthe IPv4 Addresses **MAY** be from different subnets and the\nIPv6 Addresses **MAY** be from different subnets.", + "text": "If the VNF's ports connected to a unique internal network\nand the port's IP addresses are statically assigned IP addresses,\nthe IPv4 addresses **MAY** be from different subnets and the\nIPv6 addresses **MAY** be from different subnets.", "keyword": "MAY", "result": "PASS", "errors": [] @@ -3450,7 +3956,7 @@ }, { "id": "R-18525", - "text": "The xNF provider **MUST** provide a JSON file for each\nsupported action for the xNF. The JSON file must contain key value\npairs with all relevant values populated with sample data that illustrates\nits usage. The fields and their description are defined in Tables A1\nand A2 in the Appendix.\n\nNote: Chef support in ONAP is not currently available and planned for 4Q 2017.", + "text": "The VNF or PNF provider **MUST** provide a JSON file for each\nsupported action for the VNF or PNF. The JSON file must contain key value\npairs with all relevant values populated with sample data that illustrates\nits usage. The fields and their description are defined in Tables A1\nand A2 in the Appendix.\n\nNote: Chef support in ONAP is not currently available and planned for 4Q 2017.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3471,7 +3977,7 @@ }, { "id": "R-18733", - "text": "The xNF **MUST** implement the protocol operation:\n``discard-changes()`` - Revert the candidate configuration\ndata store to the running configuration.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``discard-changes()`` - Revert the candidate configuration\ndata store to the running configuration.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3492,14 +3998,14 @@ }, { "id": "R-19366", - "text": "The xNF **MUST** support APPC ``ConfigModify`` command.", + "text": "The VNF or PNF **MUST** support APPC ``ConfigModify`` command.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-19624", - "text": "The xNF, when leveraging JSON for events, **MUST** encode and serialize\ncontent delivered to ONAP using JSON (RFC 7159) plain text format.\nHigh-volume data is to be encoded and serialized using\n`Avro <http://avro.apache.org/>`_, where the Avro [#7.4.1]_ data\nformat are described using JSON.", + "text": "The VNF or PNF, when leveraging JSON for events, **MUST** encode and serialize\ncontent delivered to ONAP using JSON (RFC 7159) plain text format.\nHigh-volume data is to be encoded and serialized using\n`Avro <http://avro.apache.org/>`_, where the Avro data\nformat are described using JSON.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3520,7 +4026,7 @@ }, { "id": "R-19922", - "text": "The xNF **MUST** support APPC/SDN-C ``UpgradePrecheck`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``UpgradePrecheck`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3555,14 +4061,14 @@ }, { "id": "R-20353", - "text": "The xNF **MUST** implement both ``:candidate`` and\n``:writable-running`` capabilities. When both ``:candidate`` and\n``:writable-running`` are provided then two locks should be supported.", + "text": "The VNF or PNF **MUST** implement both ``:candidate`` and\n``:writable-running`` capabilities. When both ``:candidate`` and\n``:writable-running`` are provided then two locks should be supported.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-20453", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an external network Resource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port-index}`` is the instance of the port on the vm-type\n attached to the network of ``{network-role}``", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an external network Resource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port_index}`` references the instance of the port on the ``{vm-type}``\n attached to ``{network-role}`` network. The\n ``{port_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new port is defined on the instance of the ``{vm-type}`` attached to\n ``{network-role}`` network.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3576,7 +4082,7 @@ }, { "id": "R-20741", - "text": "The xNF **MUST** support APPC/SDN-C ``Configure`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``Configure`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3639,7 +4145,7 @@ }, { "id": "R-21819", - "text": "The VNF **MUST** provide functionality that enables the Operator to comply\nwith requests for information from law enforcement and government agencies.", + "text": "VNFs that are subject to regulatory requirements **MUST** provide\nfunctionality that enables the Operator to comply with ETSI TC LI\nrequirements, and, optionally, other relevant national equivalents.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3652,8 +4158,8 @@ "errors": [] }, { - "id": "R-22286", - "text": "The VNF **MUST** support Integration functionality via\nAPI/Syslog/SNMP to other functional modules in the network (e.g.,\nPCRF, PCEF) that enable dynamic security control by blocking the\nmalicious traffic or malicious end users.", + "id": "R-221914", + "text": "The VNF or PNF package **MUST** contain a a human-readable change log text\nfile. The Change Log file keeps a history describing any changes in the VNF\nor PNF package. The Change Log file is kept up to date continuously from\nthe creation of the CSAR package.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3667,7 +4173,7 @@ }, { "id": "R-22346", - "text": "The xNF package MUST provide :doc:`VES Event Registration <../../../../vnfsdk/model.git/docs/files/VESEventRegistration_3_0>`\nfor all VES events provided by that xNF.", + "text": "The VNF or PNF package **MUST** provide :ref:`VES Event Registration <ves_event_registration_3_2>`\nfor all VES events provided by that VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3695,21 +4201,21 @@ }, { "id": "R-22680", - "text": "The xNF Package **MUST** include documentation that describes\nany requirements for the monitoring component of tools for Network\nCloud automation and management to provide these records to components\nof the xNF.", + "text": "The VNF or PNF Documentation Package **MUST** describe\nany requirements for the monitoring component of tools for Network\nCloud automation and management to provide these records to components\nof the VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-22688", - "text": "If a VNF's port is connected to an internal network and the port is\ncreated in an Incremental Module and the internal network is created\nin the Base Module then the UUID of the internal network **MUST** be\nexposed as a parameter in the ``outputs:`` section of the Base Module\nand the port resource **MUST** use a ``get_param`` to obtain the network\nUUID.", + "text": "When a VNF's Heat Orchestration Template creates an internal network\n(per the ONAP definition, see Requirements R-52425 and R-46461\nand R-35666) and the internal network needs to be shared between modules\nwithin a VNF, the internal network **MUST** be created either in the\n\n* the base module\n* a nested YAML file invoked by the base module\n\nand the base module **MUST** contain an output parameter that provides\neither the network UUID or network name.\n\n* If the network UUID value is used to reference the network, the output\n parameter name in the base module **MUST** follow the naming convention\n ``int_{network-role}_net_id``\n* If the network name in is used to reference the network, the output\n parameter name in the base template **MUST** follow the naming convention\n ``int_{network-role}_net_name``\n\n``{network-role}`` **MUST** be the network-role of the internal network\ncreated in the Base Module.\n\nThe Base Module Output Parameter MUST be declared in the ``parameters:``\nsection of the Incremental Module(s) where the ``OS::Neutron::Port``\nresource(s) is attaching to the internal network.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-22700", - "text": "The xNF **MUST** conform its YANG model to RFC 6470,\n\"NETCONF Base Notifications\".", + "text": "The VNF or PNF **MUST** conform its YANG model to RFC 6470,\n\"NETCONF Base Notifications\".", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3723,14 +4229,14 @@ }, { "id": "R-22888", - "text": "The xNF provider **MUST** provide documentation for the xNF\nPolicy Description to manage the xNF runtime lifecycle. The document\nmust include a description of how the policies (conditions and actions)\nare implemented in the xNF.", + "text": "The VNF or PNF Documentation Package **MUST** provide the VNF or PNF\nPolicy Description to manage the VNF or PNF runtime lifecycle. The document\nmust include a description of how the policies (conditions and actions)\nare implemented in the VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-22946", - "text": "The xNF **SHOULD** conform its YANG model to RFC 6536,\n\"NETCONF Access Control Model\".", + "text": "The VNF or PNF **SHOULD** conform its YANG model to RFC 6536,\n\"NETCONF Access Control Model\".", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -3758,7 +4264,7 @@ }, { "id": "R-23311", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Nova::Server`` property\n``availability_zone`` parameter **MUST** be declared as type: ``string``.", + "text": "The VNF's Heat Orchestration Template's base module or incremental module\nresource ``OS::Nova::Server`` property\n``availability_zone`` parameter **MUST** be declared as type: ``string``.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3814,14 +4320,14 @@ }, { "id": "R-24189", - "text": "The xNF provider **MUST** deliver a new set of playbooks that includes\nall updated and unchanged playbooks for any new revision to an existing\nset of playbooks.", + "text": "The VNF or PNF provider **MUST** deliver a new set of playbooks that\nincludes all updated and unchanged playbooks for any new revision to an\nexisting set of playbooks.", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-24269", - "text": "The xNF **SHOULD** conform its YANG model to RFC 7407,\n\"A YANG Data Model for SNMP Configuration\", if Netconf used to\nconfigure SNMP engine.", + "text": "The VNF or PNF **SHOULD** conform its YANG model to RFC 7407,\n\"A YANG Data Model for SNMP Configuration\", if Netconf used to\nconfigure SNMP engine.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -3835,7 +4341,14 @@ }, { "id": "R-24482", - "text": "The xNF **MUST** provide Ansible playbooks that are designed to run using\nan inventory hosts file in a supported format; with site group that shall\nbe used to add site specific configurations to the target xNF VM(s) as\nneeded.", + "text": "The VNF or PNF **MUST** provide Ansible playbooks that are designed to run\nusing an inventory hosts file in a supported format; with site group that\nshall be used to add site specific configurations to the target VNF or PNF\nVM(s) as needed.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-24632", + "text": "The PNF Descriptor (PNFD) provided by PNF vendor **MUST** comply with\nTOSCA/YAML based Service template for PNF descriptor specified in ETSI\nNFV-SOL001.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3849,7 +4362,7 @@ }, { "id": "R-24997", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Keypair`` applies to\none ``{vm-type}`` Resource ID **SHOULD** use the naming convention\n\n* ``{vm-type}_keypair_{index}``\n\nwhere\n\n* ``{network-role}`` is the network-role\n* ``{index}`` is the ``{index}`` of the keypair", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Keypair`` applies to\none ``{vm-type}`` Resource ID **SHOULD** use the naming convention\n\n* ``{vm-type}_keypair_{index}``\n\nwhere\n\n* ``{network-role}`` is the network-role\n* ``{index}`` is the ``{index}`` of the keypair.\n The ``{index}`` starts at zero and increments by one\n (as described in R-11690).", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -3863,7 +4376,7 @@ }, { "id": "R-25238", - "text": "The xNF PACKAGE **MUST** validated YANG code using the open\nsource pyang [#7.3.1]_ program using the following commands:\n\n.. code-block:: text\n\n $ pyang --verbose --strict <YANG-file-name(s)> $ echo $!", + "text": "The VNF or PNF PACKAGE **MUST** validated YANG code using the open\nsource pyang [#7.3.1]_ program using the following commands:\n\n.. code-block:: text\n\n $ pyang --verbose --strict <YANG-file-name(s)> $ echo $!", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3897,6 +4410,13 @@ "errors": [] }, { + "id": "R-256790", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``availability_zone`` parameter name **MAY** change when\npast into a nested YAML file.", + "keyword": "MAY", + "result": "PASS", + "errors": [] + }, + { "id": "R-25720", "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Net``\nResource ID **MUST** use the naming convention\n\n* ``int_{network-role}_network``\n\nVNF Heat Orchestration Templates can only create internal networks.\nThere is no ``{index}`` after ``{network-role}`` because ``{network-role}``\n**MUST** be unique in the scope of the VNF's\nHeat Orchestration Template.", "keyword": "MUST", @@ -3905,7 +4425,7 @@ }, { "id": "R-257367", - "text": "The xNF, when leveraging Google Protocol Buffers for events, **MUST**\nserialize the events using native Google Protocol Buffers (GPB) according\nto the following guidelines:\n\n * The keys are represented as integers pointing to the system resources\n for the xNF being monitored\n * The values correspond to integers or strings that identify the\n operational state of the VNF resource, such a statistics counters and\n the state of an xNF resource.\n * The required Google Protocol Buffers (GPB) metadata is provided in the\n form of .proto files.", + "text": "The VNF or PNF, when leveraging Google Protocol Buffers for events, **MUST**\nserialize the events using native Google Protocol Buffers (GPB) according\nto the following guidelines:\n\n * The keys are represented as integers pointing to the system resources\n for the VNF or PNF being monitored\n * The values correspond to integers or strings that identify the\n operational state of the VNF resource, such a statistics counters and\n the state of an VNF or PNF resource.\n * The required Google Protocol Buffers (GPB) metadata is provided in the\n form of .proto files.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3919,8 +4439,8 @@ }, { "id": "R-258686", - "text": "The VNF application processes **MUST NOT** run as root.", - "keyword": "MUST NOT", + "text": "The VNF application processes **SHOULD NOT** run as root. If a VNF\napplication process must run as root, the technical reason must\nbe documented.", + "keyword": "SHOULD NOT", "result": "PASS", "errors": [] }, @@ -3933,7 +4453,7 @@ }, { "id": "R-26115", - "text": "The xNF **MUST** follow the data model upgrade rules defined\nin [RFC6020] section 10. All deviations from section 10 rules shall\nbe handled by a built-in automatic upgrade mechanism.", + "text": "The VNF or PNF **MUST** follow the data model update rules defined in\n[RFC6020] section 10 for YANG 1.0 modules, and [RFC7950] section 11\nfor YANG 1.1 modules. All deviations from the aforementioned update\nrules shall be handled by a built-in automatic upgrade mechanism.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3947,7 +4467,7 @@ }, { "id": "R-26351", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an internal network Resource ID **MUST**\nuse the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port-index}`` is the instance of the port on the vm-type\n attached to the network of ``{network-role}``", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is attaching to an internal network Resource ID **MUST**\nuse the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_port_{port-index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{port_index}`` references the instance of the port on the ``{vm-type}``\n attached to ``{network-role}`` network. The\n ``{port_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new port is defined on the instance of the ``{vm-type}`` attached to\n ``{network-role}`` network.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -3961,35 +4481,28 @@ }, { "id": "R-26506", - "text": "A VNF's Heat Orchestration Template's ``{network-role}`` **MUST** contain\nonly alphanumeric characters and/or underscores '_' and\n**MUST NOT** contain any of the following strings:\n``_int`` or ``int_`` or ``_int_``.", - "keyword": "MUST", + "text": "A VNF's Heat Orchestration Template's ``{network-role}`` **MUST** contain\nonly alphanumeric characters and/or underscores '_' and\n\n* **MUST NOT** contain any of the following strings: ``_int`` or ``int_``\n or ``_int_``\n* **MUST NOT** end in the string: ``_v6``\n* **MUST NOT** contain the strings ``_#_``, where ``#`` is a number\n* **MUST NOT** end in the string: ``_#``, where ``#`` is a number", + "keyword": "MUST NOT", "result": "PASS", "errors": [] }, { "id": "R-26508", - "text": "The xNF **MUST** support a NETCONF server that can be mounted on\nOpenDaylight (client) and perform the operations of: modify, update,\nchange, rollback configurations using each configuration data element,\nquery each state (non-configuration) data element, execute each YANG\nRPC, and receive data through each notification statement.", + "text": "The VNF or PNF **MUST** support a NETCONF server that can be mounted on\nOpenDaylight (client) and perform the operations of: modify, update,\nchange, rollback configurations using each configuration data element,\nquery each state (non-configuration) data element, execute each YANG\nRPC, and receive data through each notification statement.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-26567", - "text": "The xNF Package **MUST** include a run list of\nroles/cookbooks/recipes, for each supported xNF action, that will\nperform the desired xNF action in its entirety as specified by ONAP\n(see Section 7.c, APPC/SDN-C APIs and Behavior, for list of xNF\nactions and requirements), when triggered by a chef-client run list\nin JSON file.", + "text": "The VNF or PNF Package **MUST** include a run list of\nroles/cookbooks/recipes, for each supported VNF or PNF action, that will\nperform the desired VNF or PNF action in its entirety as specified by ONAP\n(see Section 7.c, APPC/SDN-C APIs and Behavior, for list of VNF or PNF\nactions and requirements), when triggered by a chef-client run list\nin JSON file.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-26881", - "text": "The xNF provider **MUST** provide the binaries and images\nneeded to instantiate the xNF (xNF and VNFC images).", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { - "id": "R-26885", - "text": "The VNF provider **MUST** provide the binaries and images needed to\ninstantiate the VNF (VNF and VNFC images) either as:\n\n - Local artifact in CSAR: ROOT\\\\Artifacts\\\\ **VNF_Image.bin**\n\n - externally referred (by URI) artifact in Manifest file (also may be\n referred by VNF Descriptor)\n\nNote: Currently, ONAP doesn't have the capability of Image management,\nwe upload the image into VIM/VNFM manually.", + "text": "The VNF provider **MUST** provide the binaries and images\nneeded to instantiate the VNF (VNF and VNFC images).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4010,14 +4523,14 @@ }, { "id": "R-27310", - "text": "The xNF Package **MUST** include all relevant Chef artifacts\n(roles/cookbooks/recipes) required to execute xNF actions requested by\nONAP for loading on appropriate Chef Server.", + "text": "The VNF or PNF Package **MUST** include all relevant Chef artifacts\n(roles/cookbooks/recipes) required to execute VNF or PNF actions requested\nby ONAP for loading on appropriate Chef Server.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-27469", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is creating a *Reserve Port* with an IPv4 address Resource ID\n**SHOULD** use the naming convention\n\n* ``reserve_port_{vm-type}_{network-role}_floating_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{index}`` is the instance of the IPv4 *Reserve Port*\n for the vm-type attached to the network of ``{network-role}``", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is creating a *Reserve Port* with an IPv4 address Resource ID\n**SHOULD** use the naming convention\n\n* ``reserve_port_{vm-type}_{network-role}_floating_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{index}`` is the instance of the IPv4 *Reserve Port*\n for the vm-type attached to the network of ``{network-role}``.\n The ``{index}`` starts at zero and increments by one\n (as described in R-11690).", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -4030,13 +4543,6 @@ "errors": [] }, { - "id": "R-27711", - "text": "The xNF provider **MUST** provide an XML file that contains a\nlist of xNF error codes, descriptions of the error, and possible\ncauses/corrective action.", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { "id": "R-27818", "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 address is assigned\nusing the property ``fixed_ips``\nmap property ``ip_address`` and the parameter type is defined as a\n``string``,\nthe parameter name **MUST** follow the\nnaming convention\n\n* ``{vm-type}_int_{network-role}_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the internal network\n* ``{index}`` is a numeric value that **MUST** start at zero in a\n VNF's Heat Orchestration Template and **MUST** increment by one", "keyword": "MUST", @@ -4093,15 +4599,8 @@ "errors": [] }, { - "id": "R-28545", - "text": "The xNF **MUST** conform its YANG model to RFC 6060,\n\"YANG - A Data Modeling Language for the Network Configuration\nProtocol (NETCONF)\".", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { "id": "R-28756", - "text": "The xNF **MUST** support ``:partial-lock`` and\n``:partial-unlock`` capabilities, defined in RFC 5717. This\nallows multiple independent clients to each write to a different\npart of the <running> configuration at the same time.", + "text": "The VNF or PNF **MUST** support ``:partial-lock`` and\n``:partial-unlock`` capabilities, defined in RFC 5717. This\nallows multiple independent clients to each write to a different\npart of the <running> configuration at the same time.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4122,21 +4621,28 @@ }, { "id": "R-29324", - "text": "The xNF **SHOULD** implement the protocol operation:\n``copy-config(target, source)`` - Copy the content of the\nconfiguration data store source to the configuration data store target.", + "text": "The VNF or PNF **SHOULD** implement the protocol operation:\n``copy-config(target, source)`` - Copy the content of the\nconfiguration data store source to the configuration data store target.", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { + "id": "R-293901", + "text": "The VNF or PNF CSAR PACKAGE with TOSCA-Metadata **MUST** include following\nadditional keywords pointing to TOSCA files:\n\n - ETSI-Entry-Manifest\n\n - ETSI-Entry-Change-Log\n\nNote: For a CSAR containing a TOSCA-Metadata directory, which includes\nthe TOSCA.meta metadata file. The TOSCA.meta metadata file includes block_0\nwith the Entry-Definitions keyword pointing to a TOSCA definitions YAML\nfile used as entry for parsing the contents of the overall CSAR archive.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-29488", - "text": "The xNF **MUST** implement the protocol operation:\n``get-config(source, filter`` - Retrieve a (filtered subset of\na) configuration from the configuration data store source.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``get-config(source, filter`` - Retrieve a (filtered subset of\na) configuration from the configuration data store source.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-29495", - "text": "The xNF **MUST** support locking if a common object is\nbeing manipulated by two simultaneous NETCONF configuration operations\non the same xNF within the context of the same writable running data\nstore (e.g., if an interface parameter is being configured then it\nshould be locked out for configuration by a simultaneous configuration\noperation on that same interface parameter).", + "text": "The VNF or PNF **MUST** support locking if a common object is\nbeing manipulated by two simultaneous NETCONF configuration operations\non the same VNF or PNF within the context of the same writable running data\nstore (e.g., if an interface parameter is being configured then it\nshould be locked out for configuration by a simultaneous configuration\noperation on that same interface parameter).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4150,7 +4656,7 @@ }, { "id": "R-29751", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Server`` Resource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_server_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` is the index", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nResource ID\n**MUST** use the naming convention\n\n* ``{vm-type}_server_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` is the index.\n The ``{index}`` **MUST** starts at zero and increment by one\n as described in R-11690.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4192,8 +4698,8 @@ }, { "id": "R-30278", - "text": "The xNF provider **MUST** provide a Resource/Device YANG model\nas a foundation for creating the YANG model for configuration. This will\ninclude xNF attributes/parameters and valid values/attributes configurable\nby policy.", - "keyword": "MUST", + "text": "The VNF or PNF provider **SHOULD** provide a Resource/Device YANG model\nas a foundation for creating the YANG model for configuration.", + "keyword": "SHOULD", "result": "PASS", "errors": [] }, @@ -4213,7 +4719,7 @@ }, { "id": "R-304011", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's\n\n* Resource ID (defined in R-29751)\n* property ``image`` parameter name (defined in R-58670)\n* property ``flavor`` parameter name (defined in R-45188)\n* property ``name`` parameter name (defined in R-54171 & R-87817)\n* property port referenced OS::Neutron::Port Resource ID\n (defined in R-20453)\n\n**MUST** contain the identical ``{vm-type}``\nand **MUST** follow the naming conventions defined\nin R-58670, R-45188, R-54171, R-87817, and R-29751. And the ``{index}`` in\nthe ``OS::Nova::Server`` Resource ID (defined in R-29751) **MUST** match\nthe ``{vm-type_index}`` defined in\nthe ``OS::Nova::Server`` property ``port``\nreferenced ``OS::Neutron::Port`` Resource ID (defined in R-20453).", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's\n\n* Resource ID (defined in R-29751)\n* property ``image`` parameter name (defined in R-58670)\n* property ``flavor`` parameter name (defined in R-45188)\n* property ``name`` parameter name (defined in R-54171 & R-87817)\n* property ``networks`` map property ``port`` value which is a\n ``OS::Neutron::Port`` Resource ID (defined in R-20453)\n referenced using the intrinsic function ``get_attr``\n\n**MUST** contain the identical ``{vm-type}``\nand **MUST** follow the naming conventions defined\nin R-58670, R-45188, R-54171, R-87817, and R-29751. And the ``{index}`` in\nthe ``OS::Nova::Server`` Resource ID (defined in R-29751) **MUST** match\nthe ``{vm-type_index}`` defined in\nthe ``OS::Nova::Server`` property ``networks`` map property ``port``\nreferenced ``OS::Neutron::Port`` Resource ID (defined in R-20453).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4227,7 +4733,7 @@ }, { "id": "R-30654", - "text": "The xNF Package **MUST** have appropriate cookbooks that are\ndesigned to automatically 'rollback' to the original state in case of\nany errors for actions that change state of the xNF (e.g., configure).", + "text": "The VNF or PNF Package **MUST** have appropriate cookbooks that are\ndesigned to automatically 'rollback' to the original state in case of\nany errors for actions that change state of the VNF or PNF (e.g.,\nconfigure).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4269,7 +4775,7 @@ }, { "id": "R-31809", - "text": "The xNF **MUST** support the HealthCheck RPC. The HealthCheck\nRPC executes a xNF Provider-defined xNF HealthCheck over the scope of\nthe entire xNF (e.g., if there are multiple VNFCs, then run a health check,\nas appropriate, for all VNFCs). It returns a 200 OK if the test completes.\nA JSON object is returned indicating state (healthy, unhealthy), scope\nidentifier, time-stamp and one or more blocks containing info and fault\ninformation. If the xNF is unable to run the HealthCheck, return a\nstandard http error code and message.", + "text": "The VNF or PNF **MUST** support the HealthCheck RPC. The HealthCheck\nRPC executes a VNF or PNF Provider-defined VNF or PNF HealthCheck over the\nscope of the entire VNF or PNF (e.g., if there are multiple VNFCs, then\nrun a health check, as appropriate, for all VNFCs). It returns a 200 OK if\nthe test completes. A JSON object is returned indicating state (healthy,\nunhealthy), scope identifier, time-stamp and one or more blocks containing\ninfo and fault information. If the VNF or PNF is unable to run the\nHealthCheck, return a standard http error code and message.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4290,7 +4796,7 @@ }, { "id": "R-32217", - "text": "The xNF **MUST** have routable management IP addresses or FQDNs that\nare reachable via the Ansible Server for the endpoints (VMs) of a\nxNF that playbooks will target. ONAP will initiate requests to the\nAnsible Server for invocation of playbooks against these end\npoints [#7.3.3]_.", + "text": "The VNF or PNF **MUST** have routable management IP addresses or FQDNs that\nare reachable via the Ansible Server for the endpoints (VMs) of a\nVNF or PNF that playbooks will target. ONAP will initiate requests to the\nAnsible Server for invocation of playbooks against these end\npoints [#7.3.3]_.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4332,14 +4838,14 @@ }, { "id": "R-328086", - "text": "The xNF **MUST**, if serving as a distribution point or anchor point for\nsteering point from source to destination, support the ONAP Controller's\n``DistributeTraffic`` command.", + "text": "The VNF or PNF **MUST**, if serving as a distribution point or anchor point for\nsteering point from source to destination, support the ONAP Controller's\n``DistributeTraffic`` command.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-32981", - "text": "The xNF **MUST** support APPC ``ConfigBackup`` command.", + "text": "The VNF or PNF **MUST** support APPC ``ConfigBackup`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4353,14 +4859,14 @@ }, { "id": "R-332680", - "text": "The xNF **SHOULD** deliver all syslog messages to the VES Collector per the\nspecifications in Monitoring and Management chapter.", + "text": "The VNF or PNF **SHOULD** deliver all syslog messages to the VES Collector per the\nspecifications in Monitoring and Management chapter.", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-33280", - "text": "The xNF **MUST NOT** use any instance specific parameters\nin a playbook.", + "text": "The VNF or PNF **MUST NOT** use any instance specific parameters\nin a playbook.", "keyword": "MUST NOT", "result": "PASS", "errors": [] @@ -4374,7 +4880,7 @@ }, { "id": "R-33694", - "text": "The xNF Package **MUST** include documentation to when applicable,\nprovide calculators needed to convert raw data into appropriate reporting\nartifacts.", + "text": "The VNF or PNF Package **MUST** include documentation to when applicable,\nprovide calculators needed to convert raw data into appropriate reporting\nartifacts.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4387,22 +4893,29 @@ "errors": [] }, { + "id": "R-33878", + "text": "The VNF or PNF **MUST** support one of the following authentication\nmethods for authenticating HTTPS connections to the DCAE VES Event\nListener:\n\n- The preferred method is Certificate Authentication\n\n- The non-preferred option is Basic Authentication.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-33904", - "text": "The xNF Package **MUST** include documentation for each KPI, provide\nlower and upper limits.", + "text": "The VNF or PNF Package **MUST** include documentation for each KPI, provide\nlower and upper limits.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-33946", - "text": "The xNF **MUST** conform to the NETCONF RFC 4741,\n\"NETCONF Configuration Protocol\".", + "text": "The VNF or PNF **MUST** conform to the NETCONF RFC 4741,\n\"NETCONF Configuration Protocol\".", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-33955", - "text": "The xNF **SHOULD** conform its YANG model to RFC 6991,\n\"Common YANG Data Types\".", + "text": "The VNF or PNF **SHOULD** conform its YANG model to RFC 6991,\n\"Common YANG Data Types\".", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -4444,7 +4957,7 @@ }, { "id": "R-34660", - "text": "The xNF **MUST** use the RESTCONF/NETCONF framework used by\nthe ONAP configuration subsystem for synchronous communication.", + "text": "The VNF or PNF **MUST** use the RESTCONF/NETCONF framework used by\nthe ONAP configuration subsystem for synchronous communication.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4458,7 +4971,7 @@ }, { "id": "R-34957", - "text": "The VNF **MUST** provide a method of metrics gathering for each\nlayer's performance to identify/document variances in the allocations so\nthey can be addressed.", + "text": "The VNF **MUST** provide a method of metrics gathering for each\nlayer's performance to identify variances in the allocations so\nthey can be addressed.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4472,7 +4985,7 @@ }, { "id": "R-35401", - "text": "The xNF **MUST** support SSH and allow SSH access by the\nAnsible server to the endpoint VM(s) and comply with the Network\nCloud Service Provider guidelines for authentication and access.", + "text": "The VNF or PNF **MUST** support SSH and allow SSH access by the\nAnsible server to the endpoint VM(s) and comply with the Network\nCloud Service Provider guidelines for authentication and access.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4493,21 +5006,21 @@ }, { "id": "R-35666", - "text": "If a VNF has an internal network, the VNF Heat Orchestration Template\n**MUST** include the heat resources to create the internal network.", + "text": "If a VNF has an internal network, the VNF Heat Orchestration Template\n**MUST** include the heat resources to create the internal network.\n\nA VNF's Internal Network is created using Neutron Heat Resources\n(i.e., ``OS::Neutron::Net``, ``OS::Neutron::Subnet``) and/or\nContrail Heat Resources (i.e., ``OS::ContrailV2::VirtualNetwork``,\n``ContrailV2::NetworkIpam``).", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-35735", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv6 Virtual IP (VIP)\naddress is assigned via ONAP automation\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as type ``string``.", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv6 VIP is required to be supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_v6_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nAs noted in the introduction to this section, the ONAP data model\ncan only support one IPv6 VIP address.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-35851", - "text": "The xNF Package **MUST** include xNF topology that describes\nbasic network and application connectivity internal and external to the\nxNF including Link type, KPIs, Bandwidth, latency, jitter, QoS (if\napplicable) for each interface.", + "text": "The VNF HEAT Package\u00a0**MUST**\u00a0include VNF topology that describes basic\nnetwork and application connectivity internal and external to the VNF\nincluding Link type, KPIs, Bandwidth, latency, jitter, QoS (if applicable)\nfor each interface.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4521,14 +5034,14 @@ }, { "id": "R-35960", - "text": "The xNF Package **MUST** include documentation which must include\nall events, severity level (e.g., informational, warning, error) and\ndescriptions including causes/fixes if applicable for the event.", + "text": "The VNF or PNF Package **MUST** include documentation which must include\nall events, severity level (e.g., informational, warning, error) and\ndescriptions including causes/fixes if applicable for the event.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-36280", - "text": "The xNF provider **MUST** provide documentation describing\nxNF Functional Capabilities that are utilized to operationalize the\nxNF and compose complex services.", + "text": "The VNF or PNF Documentation Package **MUST** describe the\nVNF or PNF Functional Capabilities that are utilized to operationalize the\nVNF or PNF and compose complex services.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4619,7 +5132,7 @@ }, { "id": "R-37929", - "text": "The xNF **MUST** accept all necessary instance specific\ndata from the environment or node object attributes for the xNF\nin roles/cookbooks/recipes invoked for a xNF action.", + "text": "The VNF or PNF **MUST** accept all necessary instance specific\ndata from the environment or node object attributes for the VNF or PNF\nin roles/cookbooks/recipes invoked for a VNF or PNF action.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4640,7 +5153,7 @@ }, { "id": "R-384337", - "text": "The VNF documentation **MUST** contain a list of the files within the VNF\npackage that are static during the VNF's runtime.", + "text": "The VNF Documentation Package **MUST** contain a list of the files within the VNF\npackage that are static during the VNF's runtime.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4703,7 +5216,7 @@ }, { "id": "R-40293", - "text": "The xNF **MUST** make available playbooks that conform\nto the ONAP requirement.", + "text": "The VNF or PNF **MUST** make available playbooks that conform\nto the ONAP requirement.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4738,14 +5251,14 @@ }, { "id": "R-40820", - "text": "The VNF provider MUST enumerate all of the open source licenses\ntheir VNF(s) incorporate. CSAR License directory as per ETSI SOL004.\n\nfor example ROOT\\\\Licenses\\\\ **License_term.txt**", + "text": "The VNF or PNF TOSCA PACKAGE **MUST** enumerate all of the open source\nlicenses their VNF(s) incorporate. CSAR License directory as per ETSI\nSOL004.\n\nfor example ROOT\\\\Licenses\\\\ **License_term.txt**", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-40827", - "text": "The xNF provider **MUST** enumerate all of the open\nsource licenses their xNF(s) incorporate.", + "text": "The VNF or PNF provider **MUST** enumerate all of the open\nsource licenses their VNF or PNF(s) incorporate.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4787,14 +5300,21 @@ }, { "id": "R-41430", - "text": "The xNF **MUST** support APPC/SDN-C ``HealthCheck`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``HealthCheck`` command.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-41492", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424),\nand an IPv4 Virtual IP (VIP)\naddress is assigned via ONAP automation\nusing the property ``allowed_address_pairs``\nmap property ``ip_address`` and\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as type ``string``.", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv4 VIP is required to be supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\nparameter name **MUST** follow the naming convention\n\n* ``{vm-type}_{network-role}_floating_ip``\n\nwhere\n\n* ``{vm-type}`` is the {vm-type} associated with the ``OS::Nova::Server``\n* ``{network-role}`` is the {network-role} of the external network\n\nAnd the parameter **MUST** be declared as type ``string``.\n\nAs noted in the introduction to this section, the ONAP data model\ncan only support one IPv4 VIP address.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-41493", + "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network\n(per the ONAP definition, see Requirement R-57424),\nand the IPv4 VIP address and/or IPv6 VIP address\nis **not** supported by the ONAP data model,\nthe property ``allowed_address_pairs`` map property ``ip_address``\n\n* Parameter name **MAY** use any naming convention. That is, there is no\n ONAP mandatory parameter naming convention.\n* Parameter **MAY** be declared as type ``string`` or type\n``comma_delimited_list``.\n\nAnd the ``OS::Neutron::Port`` resource **MUST** contain\nresource-level ``metadata`` (not property-level).\n\nAnd the ``metadata`` format **MUST** must contain the\nkey value ``aap_exempt`` with a list of all\n``allowed_address_pairs`` map property ``ip_address`` parameters\n**not** supported by the ONAP data model.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4808,7 +5328,7 @@ }, { "id": "R-41829", - "text": "The xNF **MUST** be able to specify the granularity of the\nlock via a restricted or full XPath expression.", + "text": "The VNF or PNF **MUST** be able to specify the granularity of the\nlock via a restricted or full XPath expression.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4821,13 +5341,6 @@ "errors": [] }, { - "id": "R-41956", - "text": "If a VNF requires ONAP to assign a Virtual IP (VIP) Address to\nports connected an external network, the port\n**MUST NOT** have more than one IPv6 VIP address.", - "keyword": "MUST NOT", - "result": "PASS", - "errors": [] - }, - { "id": "R-41994", "text": "The VNF **MUST** support the use of X.509 certificates issued from any\nCertificate Authority (CA) that is compliant with RFC5280, e.g., a public\nCA such as DigiCert or Let's Encrypt, or an RFC5280 compliant Operator\nCA.\n\nNote: The VNF provider cannot require the use of self-signed certificates\nin an Operator's run time environment.", "keyword": "MUST", @@ -4836,14 +5349,14 @@ }, { "id": "R-42018", - "text": "The xNF Package **MUST** include documentation which must include\nall events (fault, measurement for xNF Scaling, Syslogs, State Change\nand Mobile Flow), that need to be collected at each VM, VNFC (defined in `VNF Guidelines <https://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines/vnf_guidelines.html>`__ ) and for the overall xNF.", + "text": "The VNF or PNF Package **MUST** include documentation which must include\nall events (fault, measurement for VNF or PNF Scaling, Syslogs, State Change\nand Mobile Flow), that need to be collected at each VM, VNFC (defined in `VNF Guidelines <https://onap.readthedocs.io/en/latest/submodules/vnfrqts/guidelines.git/docs/vnf_guidelines.html>`__ ) and for the overall VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-42140", - "text": "The xNF **MUST** respond to data requests from ONAP as soon\nas those requests are received, as a synchronous response.", + "text": "The VNF or PNF **MUST** respond to data requests from ONAP as soon\nas those requests are received, as a synchronous response.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4857,7 +5370,7 @@ }, { "id": "R-42366", - "text": "The xNF **MUST** support secure connections and transports such as\nTransport Layer Security (TLS) protocol\n[`RFC5246 <https://tools.ietf.org/html/rfc5246>`_] and should adhere to\nthe best current practices outlined in\n`RFC7525 <https://tools.ietf.org/html/rfc7525>`_.", + "text": "The VNF or PNF **MUST** support secure connections and transports such as\nTransport Layer Security (TLS) protocol\n[`RFC5246 <https://tools.ietf.org/html/rfc5246>`_] and should adhere to\nthe best current practices outlined in\n`RFC7525 <https://tools.ietf.org/html/rfc7525>`_.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4878,14 +5391,14 @@ }, { "id": "R-43253", - "text": "The xNF **MUST** use playbooks designed to allow Ansible\nServer to infer failure or success based on the \"PLAY_RECAP\" capability.\n\n**Note**: There are cases where playbooks need to interpret results\nof a task and then determine success or failure and return result\naccordingly (failure for failed tasks).", + "text": "The VNF or PNF **MUST** use playbooks designed to allow Ansible\nServer to infer failure or success based on the \"PLAY_RECAP\" capability.\n\n**Note**: There are cases where playbooks need to interpret results\nof a task and then determine success or failure and return result\naccordingly (failure for failed tasks).", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-43327", - "text": "The xNF **SHOULD** use `Modeling JSON text with YANG\n<https://tools.ietf.org/html/rfc7951>`_, If YANG models need to be\ntranslated to and from JSON{RFC7951]. YANG configuration and content can\nbe represented via JSON, consistent with Avro, as described in \"Encoding\nand Serialization\" section.", + "text": "The VNF or PNF **SHOULD** use `Modeling JSON text with YANG\n<https://tools.ietf.org/html/rfc7951>`_, If YANG models need to be\ntranslated to and from JSON{RFC7951]. YANG configuration and content can\nbe represented via JSON, consistent with Avro, as described in \"Encoding\nand Serialization\" section.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -4899,7 +5412,14 @@ }, { "id": "R-43353", - "text": "The xNF **MUST** return control from Ansible Playbooks only after all\ntasks performed by playbook are fully complete, signaling that the\nplaybook completed all tasks. When starting services, return control\nonly after all services are up. This is critical for workflows where\nthe next steps are dependent on prior tasks being fully completed.", + "text": "The VNF or PNF **MUST** return control from Ansible Playbooks only after\nall tasks performed by playbook are fully complete, signaling that the\nplaybook completed all tasks. When starting services, return control\nonly after all services are up. This is critical for workflows where\nthe next steps are dependent on prior tasks being fully completed.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-43387", + "text": "If the VNF or PNF is using Certificate Authentication, the\nVNF or PNF **MUST** support mutual TLS authentication and the Subject\nName in the end-entity certificate MUST be used according to\n`RFC5280 <https://tools.ietf.org/html/rfc5280>`_.\n\nNote: In mutual TLS authentication, the client (VNF or PNF) must\nauthenticate the server (DCAE) certificate and must provide its own\nX.509v3 end-entity certificate to the server for authentication.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4927,7 +5447,7 @@ }, { "id": "R-43958", - "text": "The xNF Package **MUST** include documentation describing\nthe tests that were conducted by the xNF provider and the test results.", + "text": "The VNF Documentation Package **MUST** describe\nthe tests that were conducted by the VNF provider and the test results.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4941,21 +5461,21 @@ }, { "id": "R-44013", - "text": "The xNF **MUST** populate an attribute, defined as node\n['PushJobOutput'] with the desired output on all nodes in the push job\nthat execute chef-client run if the xNF action requires the output of a\nchef-client run be made available (e.g., get running configuration).", + "text": "The VNF or PNF **MUST** populate an attribute, defined as node\n['PushJobOutput'] with the desired output on all nodes in the push job\nthat execute chef-client run if the VNF or PNF action requires the output\nof a chef-client run be made available (e.g., get running configuration).", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-440220", - "text": "The xNF **SHOULD** support File transferring protocol, such as FTPES or SFTP,\nwhen supporting the event-driven bulk transfer of monitoring data.", + "text": "The VNF or PNF **SHOULD** support File transferring protocol, such as FTPES or SFTP,\nwhen supporting the event-driven bulk transfer of monitoring data.", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-44125", - "text": "The xNF provider **MUST** agree to the process that can\nbe met by Service Provider reporting infrastructure. The Contract\nshall define the reporting process and the available reporting tools.", + "text": "The VNF or PNF provider **MUST** agree to the process that can\nbe met by Service Provider reporting infrastructure. The Contract\nshall define the reporting process and the available reporting tools.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4969,14 +5489,14 @@ }, { "id": "R-44281", - "text": "The xNF **MUST** implement the protocol operation:\n``edit-config(target, default-operation, test-option, error-option,\nconfig)`` - Edit the target configuration data store by merging,\nreplacing, creating, or deleting new config elements.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``edit-config(target, default-operation, test-option, error-option,\nconfig)`` - Edit the target configuration data store by merging,\nreplacing, creating, or deleting new config elements.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-44290", - "text": "The xNF **MUST** control access to ONAP and to xNFs, and creation\nof connections, through secure credentials, log-on and exchange mechanisms.", + "text": "The VNF or PNF **MUST** control access to ONAP and to VNFs or PNFs, and creation\nof connections, through secure credentials, log-on and exchange mechanisms.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -4990,7 +5510,7 @@ }, { "id": "R-44569", - "text": "The xNF provider **MUST NOT** require additional\ninfrastructure such as a xNF provider license server for xNF provider\nfunctions and metrics.", + "text": "The VNF or PNF provider **MUST NOT** require additional\ninfrastructure such as a VNF or PNF provider license server for VNF or PNF provider\nfunctions and metrics.", "keyword": "MUST NOT", "result": "PASS", "errors": [] @@ -5018,7 +5538,7 @@ }, { "id": "R-45197", - "text": "The xNF **MUST** define the \"from=\" clause to provide the list of IP\naddresses of the Ansible Servers in the Cluster, separated by coma, to\nrestrict use of the SSH key pair to elements that are part of the Ansible\nCluster owner of the issued and assigned mechanized user ID.", + "text": "The VNF or PNF **MUST** define the \"from=\" clause to provide the list of IP\naddresses of the Ansible Servers in the Cluster, separated by coma, to\nrestrict use of the SSH key pair to elements that are part of the Ansible\nCluster owner of the issued and assigned mechanized user ID.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5039,7 +5559,7 @@ }, { "id": "R-45856", - "text": "The xNF **MUST** support APPC/SDN-C ``UpgradePostCheck`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``UpgradePostCheck`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5053,21 +5573,21 @@ }, { "id": "R-46119", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::CinderVolume``\n**MAY** be defined in a Base Module.", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume``\n**MAY** be defined in a Base Module.", "keyword": "MAY", "result": "PASS", "errors": [] }, { "id": "R-46128", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv6 Address on a port attached to an external network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type\n attached to the network of {network-role}\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` is the index of the IPv6 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv6 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an external network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` references the instance of the IPv6 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv6 address is configured on the\n virtual machine interface.", "keyword": "MUST", "result": "SKIP", "errors": [] }, { "id": "R-46290", - "text": "The xNF **MUST** respond to an ONAP request to deliver granular\ndata on device or subsystem status or performance, referencing the YANG\nconfiguration model for the xNF by returning the requested data elements.", + "text": "The VNF or PNF **MUST** respond to an ONAP request to deliver granular\ndata on device or subsystem status or performance, referencing the YANG\nconfiguration model for the VNF or PNF by returning the requested data elements.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5095,7 +5615,7 @@ }, { "id": "R-46567", - "text": "The xNF Package **MUST** include configuration scripts\nfor boot sequence and configuration.", + "text": "The VNF or PNF Package **MUST** include configuration scripts\nfor boot sequence and configuration.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5151,7 +5671,7 @@ }, { "id": "R-47068", - "text": "The xNF **MAY** expose a single endpoint that is\nresponsible for all functionality.", + "text": "The VNF or PNF **MAY** expose a single endpoint that is\nresponsible for all functionality.", "keyword": "MAY", "result": "PASS", "errors": [] @@ -5172,14 +5692,14 @@ }, { "id": "R-47597", - "text": "The xNF **MUST** carry data in motion only over secure connections.", + "text": "The VNF or PNF **MUST** carry data in motion only over secure connections.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-47849", - "text": "The xNF provider **MUST** support the metadata about\nlicenses (and their applicable entitlements) as defined in this\ndocument for xNF software, and any license keys required to authorize\nuse of the xNF software. This metadata will be used to facilitate\nonboarding the xNF into the ONAP environment and automating processes\nfor putting the licenses into use and managing the full lifecycle of\nthe licenses. The details of this license model are described in\nTables C1 to C8 in the Appendix.\n\nNote: License metadata support in ONAP is not currently available\nand planned for 1Q 2018.", + "text": "The VNF or PNF provider **MUST** support the metadata about\nlicenses (and their applicable entitlements) as defined in this\nspecification for VNF or PNF software, and any license keys required to authorize\nuse of the VNF or PNF software. This metadata will be used to facilitate\nonboarding the VNF or PNF into the ONAP environment and automating processes\nfor putting the licenses into use and managing the full lifecycle of\nthe licenses. The details of this license model are described in\nTables C1 to C8 in the Appendix.\n\nNote: License metadata support in ONAP is not currently available\nand planned for 1Q 2018.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5221,7 +5741,7 @@ }, { "id": "R-48247", - "text": "The xNF **MUST** support APPC ``ConfigRestore`` command.", + "text": "The VNF or PNF **MUST** support APPC ``ConfigRestore`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5241,15 +5761,22 @@ "errors": [] }, { + "id": "R-484843", + "text": "The PNFD provided by a PNF vendor\u00a0**MUST**\u00a0comply with the following Data\nTypes as specified in ETSI NFV-SOL001 standard:\n\n - tosca.datatypes.nfv.CpProtocolData\n\n - tosca.datatypes.nfv.AddressData\n\n - tosca.datatypes.nfv.L2AddressData\n\n - tosca.datatypes.nfv.L3AddressData\n\n - tosca.datatypes.nfv.LocationInfo\n\n - tosca.datatypes.nfv.CivicAddressElement", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-48596", - "text": "The xNF Package **MUST** include documentation describing\nthe characteristics for the xNF reliability and high availability.", + "text": "The VNF or PNF Documentation Package **MUST** describe\nthe characteristics for the VNF or PNF reliability and high availability.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-48698", - "text": "The xNF **MUST** utilize information from key value pairs that will be\nprovided by the Ansible Server as \"extra-vars\" during invocation to\nexecute the desired xNF action. The \"extra-vars\" attribute-value pairs\nare passed to the Ansible Server by an APPC/SDN-C as part of the\nRest API request. If the playbook requires files, they must also be\nsupplied using the methodology detailed in the Ansible Server API, unless\nthey are bundled with playbooks, example, generic templates. Any files\ncontaining instance specific info (attribute-value pairs), not obtainable\nfrom any ONAP inventory databases or other sources, referenced and used an\ninput by playbooks, shall be provisioned (and distributed) in advance of\nuse, e.g., xNF instantiation. Recommendation is to avoid these instance\nspecific, manually created in advance of instantiation, files.", + "text": "The VNF or PNF **MUST** utilize information from key value pairs that will\nbe provided by the Ansible Server as \"extra-vars\" during invocation to\nexecute the desired VNF or PNF action. The \"extra-vars\" attribute-value\npairs are passed to the Ansible Server by an APPC/SDN-C as part of the\nRest API request. If the playbook requires files, they must also be\nsupplied using the methodology detailed in the Ansible Server API, unless\nthey are bundled with playbooks, example, generic templates. Any files\ncontaining instance specific info (attribute-value pairs), not obtainable\nfrom any ONAP inventory databases or other sources, referenced and used an\ninput by playbooks, shall be provisioned (and distributed) in advance of\nuse, e.g., VNF or PNF instantiation. Recommendation is to avoid these\ninstance specific, manually created in advance of instantiation, files.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5284,21 +5811,21 @@ }, { "id": "R-49036", - "text": "The xNF **SHOULD** conform its YANG model to RFC 7277,\n\"A YANG Data Model for IP Management\".", + "text": "The VNF or PNF **SHOULD** conform its YANG model to RFC 7277,\n\"A YANG Data Model for IP Management\".", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-49109", - "text": "The VNF **MUST** support HTTP/S using TLS v1.2 or higher\nwith strong cryptographic ciphers.", + "text": "The VNF or PNF **MUST** support HTTPS using TLS v1.2 or higher\nwith strong cryptographic ciphers.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-49145", - "text": "The xNF **MUST** implement ``:confirmed-commit`` If\n``:candidate`` is supported.", + "text": "The VNF or PNF **MUST** implement ``:confirmed-commit`` If\n``:candidate`` is supported.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5319,28 +5846,28 @@ }, { "id": "R-49396", - "text": "The xNF **MUST** support each APPC/SDN-C xNF action\nby invocation of **one** playbook [#7.3.4]_. The playbook will be responsible\nfor executing all necessary tasks (as well as calling other playbooks)\nto complete the request.", + "text": "The VNF or PNF **MUST** support each APPC/SDN-C VNF or PNF action\nby invocation of **one** playbook [#7.3.4]_. The playbook will be\nresponsible for executing all necessary tasks (as well as calling other\nplaybooks) to complete the request.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-49466", - "text": "The xNF **MUST** support APPC/SDN-C ``UpgradeSoftware`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``UpgradeSoftware`` command.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-49751", - "text": "The xNF **MUST** support Ansible playbooks that are compatible with\nAnsible version 2.6 or later.", + "text": "The VNF or PNF **MUST** support Ansible playbooks that are compatible with\nAnsible version 2.6 or later.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-49911", - "text": "The xNF provider **MUST** assign a new point release to the updated\nplaybook set. The functionality of a new playbook set must be tested before\nit is deployed to the production.", + "text": "The VNF or PNF provider **MUST** assign a new point release to the updated\nplaybook set. The functionality of a new playbook set must be tested before\nit is deployed to the production.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -5354,7 +5881,7 @@ }, { "id": "R-50252", - "text": "The xNF **MUST** write to a response file in JSON format that will be\nretrieved and made available by the Ansible Server if, as part of a xNF\naction (e.g., audit), a playbook is required to return any xNF\ninformation/response. The text files must be written in the main playbook\nhome directory, in JSON format. The JSON file must be created for the xNF\nwith the name '<xNF name>_results.txt'. All playbook output results, for\nall xNF VMs, to be provided as a response to the request, must be written\nto this response file.", + "text": "The VNF or PNF **MUST** write to a response file in JSON format that will\nbe retrieved and made available by the Ansible Server if, as part of a VNF\nor PNF action (e.g., audit), a playbook is required to return any VNF or\nPNF information/response. The text files must be written in the main\nplaybook home directory, in JSON format. The JSON file must be created for\nthe VNF or PNF with the name '<VNF or PNF name>_results.txt'. All playbook\noutput results, for all VNF or PNF VMs, to be provided as a response to the\nrequest, must be written to this response file.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5368,14 +5895,21 @@ }, { "id": "R-50468", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` that is attaching to an internal network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` is the instance of the vmi on the vm-type\n attached to the network of ``{network-role}``", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` Resource ID\nthat is attaching to an internal network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.", "keyword": "MUST", "result": "SKIP", "errors": [] }, { + "id": "R-506221", + "text": "The VNF or PNF TOSCA CSAR file **MUST** be a zip file with .csar extension.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-50816", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata`` **MAY**\ncontain the key/value pair ``vf_module_index``\nand the value **MUST** be obtained via a ``get_param``.", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property ``metadata``\nkey/value pair ``vf_module_index``\nvalue **MUST** be obtained via a ``get_param``.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5389,7 +5923,7 @@ }, { "id": "R-51347", - "text": "The VNF package **MUST** be arranged as a CSAR archive as specified in\nTOSCA Simple Profile in YAML 1.2.", + "text": "The VNF or PNF CSAR package **MUST** be arranged as a CSAR archive as\nspecified in TOSCA Simple Profile in YAML 1.2.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5403,7 +5937,7 @@ }, { "id": "R-51442", - "text": "The xNF **SHOULD** use playbooks that are designed to\nautomatically 'rollback' to the original state in case of any errors\nfor actions that change state of the xNF (e.g., configure).\n\n**Note**: In case rollback at the playbook level is not supported or\npossible, the xNF provider shall provide alternative rollback\nmechanism (e.g., for a small xNF the rollback mechanism may rely\non workflow to terminate and re-instantiate VNF VMs and then re-run\nplaybook(s)). Backing up updated files is also recommended to support\nrollback when soft rollback is feasible.", + "text": "The VNF or PNF **SHOULD** use playbooks that are designed to\nautomatically 'rollback' to the original state in case of any errors\nfor actions that change state of the VNF or PNF (e.g., configure).\n\n**Note**: In case rollback at the playbook level is not supported or\npossible, the VNF or PNF provider shall provide alternative rollback\nmechanism (e.g., for a small VNF or PNF the rollback mechanism may rely\non workflow to terminate and re-instantiate VNF VMs and then re-run\nplaybook(s)). Backing up updated files is also recommended to support\nrollback when soft rollback is feasible.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -5417,7 +5951,7 @@ }, { "id": "R-520802", - "text": "The xNF provider **MUST** provide a YAML file formatted in adherence with\nthe :doc:`VES Event Registration specification <../../../../vnfsdk/model.git/docs/files/VESEventRegistration_3_0>`\nthat defines the following information for each event produced by the VNF:\n\n* ``eventName``\n* Required fields\n* Optional fields\n* Any special handling to be performed for that event", + "text": "The VNF or PNF provider **MUST** provide a YAML file formatted in adherence with\nthe :ref:`VES Event Registration specification <ves_event_registration_3_2>`\nthat defines the following information for each event produced by the VNF:\n\n* ``eventName``\n* Required fields\n* Optional fields\n* Any special handling to be performed for that event", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5452,28 +5986,28 @@ }, { "id": "R-528866", - "text": "The VNF **MUST** produce VES events that include the following mandatory\nfields in the common event header.\n\n * ``domain`` - the event domain enumeration\n * ``eventId`` - the event key unique to the event source\n * ``eventName`` - the unique event name\n * ``lastEpochMicrosec`` - the latest unix time (aka epoch time) associated\n with the event\n * ``priority`` - the processing priority enumeration\n * ``reportingEntityName`` - name of the entity reporting the event or\n detecting a problem in another xNF\n * ``sequence`` - the ordering of events communicated by an event source\n * ``sourceName`` - name of the entity experiencing the event issue, which\n may be detected and reported by a separate reporting entity\n * ``startEpochMicrosec`` - the earliest unix time (aka epoch time)\n associated with the event\n * ``version`` - the version of the event header\n * ``vesEventListenerVersion`` - Version of the VES event listener API spec\n that this event is compliant with", + "text": "The VNF **MUST** produce VES events that include the following mandatory\nfields in the common event header.\n\n * ``domain`` - the event domain enumeration\n * ``eventId`` - the event key unique to the event source\n * ``eventName`` - the unique event name\n * ``lastEpochMicrosec`` - the latest unix time (aka epoch time) associated\n with the event\n * ``priority`` - the processing priority enumeration\n * ``reportingEntityName`` - name of the entity reporting the event or\n detecting a problem in another VNF or PNF\n * ``sequence`` - the ordering of events communicated by an event source\n * ``sourceName`` - name of the entity experiencing the event issue, which\n may be detected and reported by a separate reporting entity\n * ``startEpochMicrosec`` - the earliest unix time (aka epoch time)\n associated with the event\n * ``version`` - the version of the event header\n * ``vesEventListenerVersion`` - Version of the VES event listener API spec\n that this event is compliant with", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-53015", - "text": "The xNF **MUST** apply locking based on the sequence of\nNETCONF operations, with the first configuration operation locking\nout all others until completed.", + "text": "The VNF or PNF **MUST** apply locking based on the sequence of\nNETCONF operations, with the first configuration operation locking\nout all others until completed.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-53310", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv4 Address on a port attached to an external network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the {vm-type}\n* ``{network-role}`` is the network-role of the network that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type attached to the network of {network-role}\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` is the index of the IPv4 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv4 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an external network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network that the\n virtual machine interface is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` references the instance of the IPv4 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv4 address is configured on the\n virtual machine interface.", "keyword": "MUST", "result": "SKIP", "errors": [] }, { "id": "R-53317", - "text": "The xNF **MUST** conform its YANG model to RFC 6087,\n\"Guidelines for Authors and Reviewers of YANG Data Model Documents\".", + "text": "The VNF or PNF **MUST** conform its YANG model to RFC 6087,\n\"Guidelines for Authors and Reviewers of YANG Data Model specification\".", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5486,8 +6020,15 @@ "errors": [] }, { + "id": "R-535009", + "text": "The PNFD provided by a PNF vendor\u00a0**MUST**\u00a0comply with the following Node\nTypes as specified in ETSI NFV-SOL001 standard:\n\n - tosca.nodes.nfv.PNF\n\n - tosca.nodes.nfv.PnfExtCp\n\n - tosca.nodes.nfv.Cp", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-53598", - "text": "The xNF Package **MUST** include documentation to, when relevant,\nprovide a threshold crossing alert point for each KPI and describe the\nsignificance of the threshold crossing.", + "text": "The VNF or PNF Documentation Package **MUST**, when relevant,\nprovide a threshold crossing alert point for each KPI and describe the\nsignificance of the threshold crossing.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5508,7 +6049,7 @@ }, { "id": "R-54190", - "text": "The xNF **MUST** release locks to prevent permanent lock-outs\nwhen/if a session applying the lock is terminated (e.g., SSH session\nis terminated).", + "text": "The VNF or PNF **MUST** release locks to prevent permanent lock-outs\nwhen/if a session applying the lock is terminated (e.g., SSH session\nis terminated).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5529,7 +6070,7 @@ }, { "id": "R-54373", - "text": "The xNF **MUST** have Python >= 2.6 on the endpoint VM(s)\nof a xNF on which an Ansible playbook will be executed.", + "text": "The VNF or PNF **MUST** have Python >= 2.6 on the endpoint VM(s)\nof a VNF or PNF on which an Ansible playbook will be executed.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5605,6 +6146,13 @@ "errors": [] }, { + "id": "R-55634", + "text": "If VNF or PNF is using Basic Authentication, then the VNF or PNF\n**MUST** be in compliance with\n`RFC7617 <https://tools.ietf.org/html/rfc7617>`_ for authenticating HTTPS\nconnections to the DCAE VES Event Listener.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-55802", "text": "The VNF Package **MUST** include VM requirements via a Heat\ntemplate that provides the necessary data for scaling/growth VM\nspecifications.\n\nNote: Must comply with the *Heat requirements in 5.b*.", "keyword": "MUST", @@ -5634,7 +6182,7 @@ }, { "id": "R-56385", - "text": "The xNF **MUST** support APPC ``Audit`` command.", + "text": "The VNF or PNF **MUST** support APPC ``Audit`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5669,7 +6217,7 @@ }, { "id": "R-56815", - "text": "The xNF Package **MUST** include documentation describing\nsupported xNF scaling capabilities and capacity limits (e.g., number\nof users, bandwidth, throughput, concurrent calls).", + "text": "The VNF or PNF Documentation Package **MUST** describe\nsupported VNF or PNF scaling capabilities and capacity limits (e.g., number\nof users, bandwidth, throughput, concurrent calls).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5690,7 +6238,14 @@ }, { "id": "R-570134", - "text": "The events produced by the xNF **MUST** must be compliant with the common\nevent format defined in the\n:doc:`VES Event Listener<../../../../vnfsdk/model.git/docs/files/VESEventListener_7_0_1>`\nspecification.", + "text": "The events produced by the VNF or PNF **MUST** must be compliant with the common\nevent format defined in the\n:ref:`VES Event Listener<ves_event_listener_7_1>`\nspecification.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-57019", + "text": "The PNF TOSCA CSAR PACKAGE Manifest file **MUST** start with the PNF\npackage metadata in the form of a name-value pairs. Each pair shall appear\non a different line. The name is specified as following:\n\n - pnfd_provider\n\n - pnfd_name\n\n - pnfd_release_date_time\n\n - pnfd_archive_version", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5724,13 +6279,6 @@ "errors": [] }, { - "id": "R-579051", - "text": "The PNF **MAY** support a HTTP connection to the DCAE VES Event Listener.\n\nNote: HTTP is allowed but not recommended.", - "keyword": "MAY", - "result": "PASS", - "errors": [] - }, - { "id": "R-581188", "text": "A failed authentication attempt **MUST NOT** identify the reason for the\nfailure to the user, only that the authentication failed.", "keyword": "MUST NOT", @@ -5739,14 +6287,14 @@ }, { "id": "R-58301", - "text": "The xNF **SHOULD NOT** use playbooks that make requests to\nCloud resources e.g. Openstack (nova, neutron, glance, heat, etc.);\ntherefore, there is no use for Cloud specific variables like Openstack\nUUIDs in Ansible Playbook related artifacts.\n\n**Rationale**: Flows that require interactions with Cloud services e.g.\nOpenstack shall rely on workflows run by an Orchestrator\n(Change Management) or other capability (such as a control loop or\nOperations GUI) outside Ansible Server which can be executed by a\nAPPC/SDN-C. There are policies, as part of Control Loop\nmodels, that send remediation action requests to an APPC/SDN-C; these\nare triggered as a response to an event or correlated events published\nto Event Bus.", + "text": "The VNF or PNF **SHOULD NOT** use playbooks that make requests to\nCloud resources e.g. Openstack (nova, neutron, glance, heat, etc.);\ntherefore, there is no use for Cloud specific variables like Openstack\nUUIDs in Ansible Playbook related artifacts.\n\n**Rationale**: Flows that require interactions with Cloud services e.g.\nOpenstack shall rely on workflows run by an Orchestrator\n(Change Management) or other capability (such as a control loop or\nOperations GUI) outside Ansible Server which can be executed by a\nAPPC/SDN-C. There are policies, as part of Control Loop\nmodels, that send remediation action requests to an APPC/SDN-C; these\nare triggered as a response to an event or correlated events published\nto Event Bus.", "keyword": "SHOULD NOT", "result": "PASS", "errors": [] }, { "id": "R-58358", - "text": "The xNF **MUST** implement the ``:with-defaults`` capability\n[RFC6243].", + "text": "The VNF or PNF **MUST** implement the ``:with-defaults`` capability\n[RFC6243].", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5781,14 +6329,14 @@ }, { "id": "R-58775", - "text": "The xNF provider **MUST** provide software components that\ncan be packaged with/near the xNF, if needed, to simulate any functions\nor systems that connect to the xNF system under test. This component is\nnecessary only if the existing testing environment does not have the\nnecessary simulators.", + "text": "The VNF provider **MUST** provide software components that\ncan be packaged with/near the VNF, if needed, to simulate any functions\nor systems that connect to the VNF system under test. This component is\nnecessary only if the existing testing environment does not have the\nnecessary simulators.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-589037", - "text": "A VNF Heat Orchestration Template's Cinder Volume Module resources section\n**MUST** only be defined using one of the following:\n\n* one of more ``OS::Cinder::Volume`` resources\n* one or more ``OS::Heat::ResourceGroup`` resources that call a nested YAML\n file that contains only ``OS::Cinder::Volume`` resources\n* a resource that calls a nested YAML file (static nesting) that contains\n only ``OS::Cinder::Volume`` resources", + "text": "A VNF Heat Orchestration Template's Cinder Volume Module ``resources:``\nsection\n**MUST** only be defined using one of the following:\n\n* one of more ``OS::Cinder::Volume`` resources\n* one or more ``OS::Heat::ResourceGroup`` resources that call a nested YAML\n file that contains only ``OS::Cinder::Volume`` resources\n* a resource that calls a nested YAML file (static nesting) that contains\n only ``OS::Cinder::Volume`` resources", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5809,7 +6357,7 @@ }, { "id": "R-59434", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Subnet``\nResource ID **SHOULD** use the naming convention\n\n* ``int_{network-role}_subnet_{index}``\n\nwhere\n\n* ``{network-role}`` is the network-role\n* ``{index}`` is the ``{index}`` of the subnet of the network", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Subnet``\nResource ID **SHOULD** use the naming convention\n\n* ``int_{network-role}_subnet_{index}``\n\nwhere\n\n* ``{network-role}`` is the network-role\n* ``{index}`` is the ``{index}`` of the subnet of the network.\n The ``{index}`` starts at zero and increments by one\n (as described in R-11690).", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -5829,8 +6377,15 @@ "errors": [] }, { + "id": "R-596064", + "text": "The PNFD provided by a PNF vendor **MUST** comply with the following Policy\nTypes as specified in ETSI NFV-SOL001 standard:\n\n - tosca.datatypes.nfv.SecurityGroupRule", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-59610", - "text": "The xNF **MUST** implement the data model discovery and\ndownload as defined in [RFC6022].", + "text": "The VNF or PNF **MUST** implement the data model discovery and\ndownload as defined in [RFC6022].", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5858,14 +6413,14 @@ }, { "id": "R-60106", - "text": "The xNF **MUST** implement the protocol operation:\n``get(filter)`` - Retrieve (a filtered subset of) the running\nconfiguration and device state information. This should include\nthe list of xNF supported schemas.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``get(filter)`` - Retrieve (a filtered subset of) the running\nconfiguration and device state information. This should include\nthe list of VNF or PNF supported schemas.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-60656", - "text": "The xNF **MUST** support sub tree filtering.", + "text": "The VNF or PNF **MUST** support sub tree filtering.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5878,6 +6433,41 @@ "errors": [] }, { + "id": "R-610010", + "text": "A VNF's Heat Orchestration Template's Base Module **MAY** declare zero, one,\nor more than one ``OS::Nova::Server`` resource. A ``OS::Nova::Server``\n**MAY** be created in the base module or a nested yaml file invoked by the\nbase module.", + "keyword": "MAY", + "result": "PASS", + "errors": [] + }, + { + "id": "R-610020", + "text": "If a VNF's Heat Orchestration Template's Base Module contains two or more\n``OS::Nova::Server`` resources (created in the base module itself and/or\nin a nested yaml file invoked by the base module), the ``OS::Nova::Server``\nresources **MAY**\ndefine the same ``{vm-type}`` (as defined in R-01455) or **MAY**\ndefine different ``{vm-type}``.\n\nNote that\n\n- there is no constraint on the number of unique ``{vm-type}`` defined in\n the base module.\n- there is no constraint on the number of ``OS::Nova::Server`` resources\n that define the same ``{vm-type}`` in the base module.\n- if an ``OS::Nova::Server`` is created in a nested yaml file invoked by\n the base module, the nested yaml file **MUST NOT** contain more than one\n ``OS::Nova::Server`` resource (as defined in R-17528).", + "keyword": "MAY", + "result": "PASS", + "errors": [] + }, + { + "id": "R-610030", + "text": "A VNF's Heat Orchestration Template's Incremental Module **MUST**\ndeclare one or more ``OS::Nova::Server`` resources. A ``OS::Nova::Server``\n**MAY** be created in the incremental module or a nested yaml file invoked\nby the incremental module.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { + "id": "R-610040", + "text": "If a VNF's Heat Orchestration Template's Incremental Module contains two or\nmore ``OS::Nova::Server`` resources, the ``OS::Nova::Server`` resources\n**MAY** define the same ``{vm-type}`` (as defined in R-01455) or **MAY**\ndefine different ``{vm-type}``.\n\nNote that\n\n- there is no constraint on the number of unique ``{vm-type}`` defined in\n the incremental module.\n- there is no constraint on the number of ``OS::Nova::Server`` resources\n that define the same ``{vm-type}`` in the incremental module.\n- if an ``OS::Nova::Server`` is created in a nested yaml file invoked by\n the incremental module, the nested yaml file **MUST NOT** contain more\n than one ``OS::Nova::Server`` resource (as defined in R-17528).", + "keyword": "MAY", + "result": "PASS", + "errors": [] + }, + { + "id": "R-610050", + "text": "The same ``{vm-type}`` for a VNF's Heat Orchestration Template's\n``OS::Nova::Server`` resource (as defined in R-01455) **MAY** exist in\nthe VNF's Heat Orchestration Template's Base Module (or invoked nested yaml\nfile) and/or one or more of the VNF's Heat Orchestration Template's\nIncremental Modules (or invoked nested yaml file).", + "keyword": "MAY", + "result": "PASS", + "errors": [] + }, + { "id": "R-61354", "text": "The VNF **MUST** provide a mechanism (e.g., access control list) to\npermit and/or restrict access to services on the VNF by source,\ndestination, protocol, and/or port.", "keyword": "MUST", @@ -5886,14 +6476,14 @@ }, { "id": "R-62170", - "text": "The xNF **MUST** over-ride any default values for\nconfigurable parameters that can be set by ONAP in the roles,\ncookbooks and recipes.", + "text": "The VNF or PNF **MUST** over-ride any default values for\nconfigurable parameters that can be set by ONAP in the roles,\ncookbooks and recipes.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-62187", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv4 Address on a port attached to an internal network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type\n attached to the network of ``{network-role}``\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` is the index of the IPv4 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv4 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an internal network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``IP`` signifies that an IPv4 address is being configured\n* ``{index}`` references the instance of the IPv4 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv4 address is configured on the\n virtual machine interface.", "keyword": "MUST", "result": "SKIP", "errors": [] @@ -5907,7 +6497,7 @@ }, { "id": "R-62468", - "text": "The xNF **MUST** allow all configuration data to be\nedited through a NETCONF <edit-config> operation. Proprietary\nNETCONF RPCs that make configuration changes are not sufficient.", + "text": "The VNF or PNF **MUST** allow all configuration data to be\nedited through a NETCONF <edit-config> operation. Proprietary\nNETCONF RPCs that make configuration changes are not sufficient.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -5956,7 +6546,7 @@ }, { "id": "R-63229", - "text": "The xNF **MAY** use another option which is expected to include REST\nfor synchronous data, using RESTCONF (e.g., for xNF state polling).", + "text": "The VNF or PNF **MAY** use another option which is expected to include REST\nfor synchronous data, using RESTCONF (e.g., for VNF or PNF state polling).", "keyword": "MAY", "result": "PASS", "errors": [] @@ -5991,26 +6581,33 @@ }, { "id": "R-63935", - "text": "The xNF **MUST** release locks to prevent permanent lock-outs\nwhen a user configured timer has expired forcing the NETCONF SSH Session\ntermination (i.e., product must expose a configuration knob for a user\nsetting of a lock expiration timer).", + "text": "The VNF or PNF **MUST** release locks to prevent permanent lock-outs\nwhen a user configured timer has expired forcing the NETCONF SSH Session\ntermination (i.e., product must expose a configuration knob for a user\nsetting of a lock expiration timer).", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-63953", - "text": "The xNF **MUST** have the echo command return a zero value\notherwise the validation has failed.", + "text": "The VNF or PNF **MUST** have the echo command return a zero value\notherwise the validation has failed.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-63956", - "text": "If the VNF's ports connected to a unique external network\nand the port's IP addresses are ONAP SDN-C assigned IP Addresses,\nthe IPv4 Addresses **MAY** be from different subnets and the IPv6\nAddresses **MAY** be from different subnets.", + "text": "If the VNF's ports connected to a unique external network\nand the port's IP addresses are ONAP SDN-C assigned IP addresses,\nthe IPv4 addresses **MAY** be from different subnets and the IPv6\naddresses **MAY** be from different subnets.", "keyword": "MAY", "result": "PASS", "errors": [] }, { + "id": "R-64064", + "text": "The PNFD provided by a PNF vendor **MUST** comply with the following\nRelationship Types as specified in ETSI NFV-SOL001 standard:\n\n - tosca.datatypes.nfv.VirtualLinksTo", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-64445", "text": "The VNF **MUST** support the ability of a requestor of the\nservice to determine the version (and therefore capabilities) of the\nservice so that Network Cloud Service Provider can understand the\ncapabilities of the service.", "keyword": "MUST", @@ -6040,7 +6637,7 @@ }, { "id": "R-65486", - "text": "The VNFD **MUST** comply with ETSI GS NFV-SOL001 document endorsing\nthe above mentioned NFV Profile and maintaining the gaps with the\nrequirements specified in ETSI GS NFV-IFA011 standard.", + "text": "The VNFD **MUST** comply with ETSI GS NFV-SOL001 specification endorsing\nthe above mentioned NFV Profile and maintaining the gaps with the\nrequirements specified in ETSI GS NFV-IFA011 standard.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6068,28 +6665,28 @@ }, { "id": "R-65641", - "text": "The xNF **MUST** support APPC/SDN-C ``UpgradeBackOut`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``UpgradeBackOut`` command.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-65755", - "text": "The xNF **SHOULD** support callback URLs to return information\nto ONAP upon completion of the chef-client run for any chef-client run\nassociated with a xNF action.\n\n- As part of the push job, ONAP will provide two parameters in the\n environment of the push job JSON object:\n\n - \"RequestId\" a unique Id to be used to identify the request,\n - \"CallbackUrl\", the URL to post response back.\n\n- If the CallbackUrl field is empty or missing in the push job, then\n the chef-client run need not post the results back via callback.", + "text": "The VNF or PNF **SHOULD** support callback URLs to return information\nto ONAP upon completion of the chef-client run for any chef-client run\nassociated with a VNF or PNF action.\n\n- As part of the push job, ONAP will provide two parameters in the\n environment of the push job JSON object:\n\n - \"RequestId\" a unique Id to be used to identify the request,\n - \"CallbackUrl\", the URL to post response back.\n\n- If the CallbackUrl field is empty or missing in the push job, then\n the chef-client run need not post the results back via callback.", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-659655", - "text": "The xNF **SHOULD** leverage the JSON-driven model, as depicted in Figure 2,\nfor data delivery unless there are specific performance or operational\nconcerns agreed upon by the Service Provider that would warrant using an\nalternate model.", + "text": "The VNF or PNF **SHOULD** leverage the JSON-driven model, as depicted in Figure 2,\nfor data delivery unless there are specific performance or operational\nconcerns agreed upon by the Service Provider that would warrant using an\nalternate model.", "keyword": "SHOULD", "result": "PASS", "errors": [] }, { "id": "R-66070", - "text": "The xNF Package **MUST** include xNF Identification Data to\nuniquely identify the resource for a given xNF provider. The identification\ndata must include: an identifier for the xNF, the name of the xNF as was\ngiven by the xNF provider, xNF description, xNF provider, and version.", + "text": "For HEAT package, the VNF Package **MUST** include VNF Identification Data to\nuniquely identify the resource for a given VNF provider. The identification\ndata must include: an identifier for the VNF, the name of the VNF as was\ngiven by the VNF provider, VNF description, VNF provider, and version.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6103,21 +6700,21 @@ }, { "id": "R-66793", - "text": "The xNF **MUST** guarantee the xNF configuration integrity\nfor all simultaneous configuration operations (e.g., if a change is\nattempted to the BUM filter rate from multiple interfaces on the same\nEVC, then they need to be sequenced in the xNF without locking either\nconfiguration method out).", + "text": "The VNF or PNF **MUST** guarantee the VNF or PNF configuration integrity\nfor all simultaneous configuration operations (e.g., if a change is\nattempted to the BUM filter rate from multiple interfaces on the same\nEVC, then they need to be sequenced in the VNF or PNF without locking either\nconfiguration method out).", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-67114", - "text": "The xNF **MUST** be installed with Chef-Client >= 12.0 and Chef\npush jobs client >= 2.0.", + "text": "The VNF or PNF **MUST** be installed with Chef-Client >= 12.0 and Chef\npush jobs client >= 2.0.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-67124", - "text": "The xNF **MUST** provide Ansible playbooks that are designed to run using\nan inventory hosts file in a supported format; with group names matching\nVNFC 3-character string adding \"vip\" for groups with virtual IP addresses\nshared by multiple VMs as seen in examples provided in Appendix.", + "text": "The VNF or PNF **MUST** provide Ansible playbooks that are designed to run\nusing an inventory hosts file in a supported format; with group names\nmatching VNFC 3-character string adding \"vip\" for groups with virtual IP\naddresses shared by multiple VMs as seen in examples provided in Appendix.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6152,7 +6749,7 @@ }, { "id": "R-67793", - "text": "When a VNF's Heat Orchestration Template's resource is associated\nwith more than one ``{vm-type}`` and/or more than one internal and/or\nexternal network, the Resource ID **MUST** not contain the ``{vm-type}``\nand/or ``{network-role}``/``int_{network-role}``. It also should contain the\nterm ``shared`` and/or contain text that identifies the VNF.", + "text": "When a VNF's Heat Orchestration Template's resource is associated\nwith more than one ``{vm-type}`` and/or more than one internal and/or\nexternal network, the Resource ID **MUST NOT** contain the ``{vm-type}``\nand/or ``{network-role}``/``int_{network-role}``. It also should contain the\nterm ``shared`` and/or contain text that identifies the VNF.", "keyword": "MUST NOT", "result": "PASS", "errors": [] @@ -6173,7 +6770,7 @@ }, { "id": "R-68023", - "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` **SHOULD**\ncontain the key/value pair ``vf_module_name`` and the value **MUST**\nbe obtained via a ``get_param``.", + "text": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vf_module_name``\nvalue **MUST**\nbe obtained via a ``get_param``.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6187,7 +6784,7 @@ }, { "id": "R-68165", - "text": "The xNF **MUST** encrypt any content containing Sensitive Personal\nInformation (SPI) or certain proprietary data, in addition to applying the\nregular procedures for securing access and delivery.", + "text": "The VNF or PNF **MUST** encrypt any content containing Sensitive Personal\nInformation (SPI) or certain proprietary data, in addition to applying the\nregular procedures for securing access and delivery.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6208,14 +6805,14 @@ }, { "id": "R-68200", - "text": "The xNF **MUST** support the ``:url`` value to specify\nprotocol operation source and target parameters. The capability URI\nfor this feature will indicate which schemes (e.g., file, https, sftp)\nthat the server supports within a particular URL value. The 'file'\nscheme allows for editable local configuration databases. The other\nschemes allow for remote storage of configuration databases.", + "text": "The VNF or PNF **MUST** support the ``:url`` value to specify\nprotocol operation source and target parameters. The capability URI\nfor this feature will indicate which schemes (e.g., file, https, sftp)\nthat the server supports within a particular URL value. The 'file'\nscheme allows for editable local configuration databases. The other\nschemes allow for remote storage of configuration databases.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-68520", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is creating a *Reserve Port* with an IPv6 address Resource ID\n**SHOULD** use the naming convention\n\n* ``reserve_port_{vm-type}_{network-role}_floating_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{index}`` is the instance of the IPv6 *Reserve Port*\n for the vm-type attached to the network of ``{network-role}``", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is creating a *Reserve Port* with an IPv6 address Resource ID\n**SHOULD** use the naming convention\n\n* ``reserve_port_{vm-type}_{network-role}_floating_v6_ip_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{index}`` is the instance of the IPv6 *Reserve Port*\n for the vm-type attached to the network of ``{network-role}``.\n The ``{index}`` starts at zero and increments by one\n (as described in R-11690).", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -6229,7 +6826,7 @@ }, { "id": "R-68990", - "text": "The xNF **MUST** support the ``:startup`` capability. It\nwill allow the running configuration to be copied to this special\ndatabase. It can also be locked and unlocked.", + "text": "The VNF or PNF **MUST** support the ``:startup`` capability. It\nwill allow the running configuration to be copied to this special\ndatabase. It can also be locked and unlocked.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6250,7 +6847,7 @@ }, { "id": "R-69565", - "text": "The xNF Package **MUST** include documentation describing xNF\nManagement APIs, which must include information and tools for ONAP to\ndeploy and configure (initially and ongoing) the xNF application(s)\n(e.g., NETCONF APIs) which includes a description of configurable\nparameters for the xNF and whether the parameters can be configured\nafter xNF instantiation.", + "text": "The VNF or PNF Documentation Package **MUST** describe the VNF or PNF\nManagement APIs, which must include information and tools for ONAP to\ndeploy and configure (initially and ongoing) the VNF or PNF application(s)\n(e.g., NETCONF APIs) which includes a description of configurable\nparameters for the VNF or PNF and whether the parameters can be configured\nafter VNF or PNF instantiation.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6292,14 +6889,14 @@ }, { "id": "R-697654", - "text": "The xNF **MAY** leverage the Google Protocol Buffers (GPB) delivery model\ndepicted in Figure 3 to support real-time performance management (PM) data.\nIn this model the VES events are streamed as binary-encoded GBPs over via\nTCP sockets.", + "text": "The VNF or PNF **MAY** leverage the Google Protocol Buffers (GPB) delivery model\ndepicted in Figure 3 to support real-time performance management (PM) data.\nIn this model the VES events are streamed as binary-encoded GBPs over via\nTCP sockets.", "keyword": "MAY", "result": "PASS", "errors": [] }, { "id": "R-69877", - "text": "The xNF Package **MUST** include documentation for each KPI,\nidentify the suggested actions that need to be performed when a\nthreshold crossing alert event is recorded.", + "text": "The VNF or PNF Package **MUST** include documentation for each KPI,\nidentify the suggested actions that need to be performed when a\nthreshold crossing alert event is recorded.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6313,7 +6910,7 @@ }, { "id": "R-70266", - "text": "The xNF **MUST** respond to an ONAP request to deliver the\ncurrent data for any of the record types defined in\n`Event Records - Data Structure Description`_ by returning the requested\nrecord, populated with the current field values. (Currently the defined\nrecord types include fault fields, mobile flow fields, measurements for\nxNF scaling fields, and syslog fields. Other record types will be added\nin the future as they become standardized and are made available.)", + "text": "The VNF or PNF **MUST** respond to an ONAP request to deliver the\ncurrent data for any of the record types defined in\n`Event Records - Data Structure Description`_ by returning the requested\nrecord, populated with the current field values. (Currently the defined\nrecord types include fault fields, mobile flow fields, measurements for\nVNF or PNF scaling fields, and syslog fields. Other record types will be added\nin the future as they become standardized and are made available.)", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6334,7 +6931,7 @@ }, { "id": "R-70496", - "text": "The xNF **MUST** implement the protocol operation:\n``commit(confirmed, confirm-timeout)`` - Commit candidate\nconfiguration data store to the running configuration.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``commit(confirmed, confirm-timeout)`` - Commit candidate\nconfiguration data store to the running configuration.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6348,8 +6945,8 @@ }, { "id": "R-708564", - "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically, the names of the parameters\npassed into the nested YAML file **MUST NOT** change.", - "keyword": "MUST", + "text": "If a VNF's Heat Orchestration Template's resource invokes a nested\nYAML file, either statically or dynamically\n(via ``OS::Heat::ResourceGroup``),\nthe names of the parameters associated with the following resource\nproperties **MUST NOT** change.\n\n* ``OS::Nova::Server`` property ``flavor``\n* ``OS::Nova::Server`` property ``image``\n* ``OS::Nova::Server`` property ``name``\n* ``OS::Nova::Server`` property metadata key value ``vnf_id``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_id``\n* ``OS::Nova::Server`` property metadata key value ``vnf_name``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_name``\n* ``OS::Nova::Server`` property metadata key value ``vm_role``\n* ``OS::Nova::Server`` property metadata key value ``vf_module_index``\n* ``OS::Nova::Server`` property metadata key value ``workload_context``\n* ``OS::Nova::Server`` property metadata key value ``environment_context``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``ip_address``\n* ``OS::Neutron::Port`` property ``fixed_ips``, map property ``subnet``\n* ``OS::Neutron::Port`` property ``allowed_address_pairs``, map property\n ``ip_address``\n* ``OS::Neutron::Port`` property ``network``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_network_refs``\n* ``OS::ContrailV2::VirtualMachineInterface`` property\n ``virtual_machine_interface_allowed_address_pairs``, map property\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair``,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip``\n ,\n ``virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix``\n* ``OS::ContrailV2::InstanceIP`` property ``instance_ip_address``\n* ``OS::ContrailV2::InstanceIP`` property ``subnet_uuid``", + "keyword": "MUST NOT", "result": "PASS", "errors": [] }, @@ -6397,7 +6994,7 @@ }, { "id": "R-717227", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nECOMP definition, see Requirements R-52425 and R-46461),\nand an IPv4 Virtual IP (VIP)\naddress is assigned using the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file.\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv4 Virtual IP (VIP)\naddress is assigned using the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file.\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6418,7 +7015,7 @@ }, { "id": "R-72184", - "text": "The xNF **MUST** have routable FQDNs for all the endpoints\n(VMs) of a xNF that contain chef-clients which are used to register\nwith the Chef Server. As part of invoking xNF actions, ONAP will\ntrigger push jobs against FQDNs of endpoints for a xNF, if required.", + "text": "The VNF or PNF **MUST** have routable FQDNs for all the endpoints\n(VMs) of a VNF or PNF that contain chef-clients which are used to register\nwith the Chef Server. As part of invoking VNF or PNF actions, ONAP will\ntrigger push jobs against FQDNs of endpoints for a VNF or PNF, if required.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6460,7 +7057,7 @@ }, { "id": "R-73285", - "text": "The xNF **MUST** must encode, address and deliver the data\nas described in the previous paragraphs.", + "text": "The VNF or PNF **MUST** must encode, address and deliver the data\nas described in the previous paragraphs.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6474,21 +7071,21 @@ }, { "id": "R-73459", - "text": "The xNF **MUST** provide the ability to include a \"from=\" clause in SSH\npublic keys associated with mechanized user IDs created for an Ansible\nServer cluster to use for xNF VM authentication.", + "text": "The VNF or PNF **MUST** provide the ability to include a \"from=\" clause in\nSSH public keys associated with mechanized user IDs created for an Ansible\nServer cluster to use for VNF or PNF VM authentication.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-73468", - "text": "The xNF **MUST** allow the NETCONF server connection\nparameters to be configurable during virtual machine instantiation\nthrough Heat templates where SSH keys, usernames, passwords, SSH\nservice and SSH port numbers are Heat template parameters.", + "text": "The VNF or PNF **MUST** allow the NETCONF server connection\nparameters to be configurable during virtual machine instantiation\nthrough Heat templates where SSH keys, usernames, passwords, SSH\nservice and SSH port numbers are Heat template parameters.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-73560", - "text": "The xNF Package **MUST** include documentation about monitoring\nparameters/counters exposed for virtual resource management and xNF\napplication management.", + "text": "The VNF or PNF Package **MUST** include documentation about monitoring\nparameters/counters exposed for virtual resource management and VNF or PNF\napplication management.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6522,13 +7119,6 @@ "errors": [] }, { - "id": "R-74763", - "text": "The xNF provider **MUST** provide an artifact per xNF that contains\nall of the xNF Event Records supported. The artifact should include\nreference to the specific release of the xNF Event Stream Common Event\nData Model document it is based on. (e.g.,\n`VES Event Listener <https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/VESEventListener.html>`__)", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { "id": "R-74958", "text": "The VNF **MUST** activate security alarms automatically when\nit detects an unsuccessful attempt to gain permissions\nor assume the identity of another user.", "keyword": "MUST", @@ -6565,7 +7155,7 @@ }, { "id": "R-75608", - "text": "The xNF provider **MUST** provide playbooks to be loaded\non the appropriate Ansible Server.", + "text": "The VNF or PNF provider **MUST** provide playbooks to be loaded\non the appropriate Ansible Server.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6586,7 +7176,7 @@ }, { "id": "R-75943", - "text": "The xNF **SHOULD** support the data schema defined in 3GPP TS 32.435, when\nsupporting the event-driven bulk transfer of monitoring data.", + "text": "The VNF or PNF **SHOULD** support the data schema defined in 3GPP TS 32.435, when\nsupporting the event-driven bulk transfer of monitoring data.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -6600,7 +7190,7 @@ }, { "id": "R-76057", - "text": "VNF Heat Orchestration Template's Nested YAML file name **MUST** contain\nonly alphanumeric characters and underscores '_' and\n**MUST NOT** contain the case insensitive word ``base``.", + "text": "VNF Heat Orchestration Template's Nested YAML file name **MUST** contain\nonly alphanumeric characters and underscores '_' and\n**MUST NOT** contain the case insensitive string ``base``.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6614,7 +7204,7 @@ }, { "id": "R-763774", - "text": "The PNF **MUST** support a HTTPS connection to the DCAE VES Event\nListener.", + "text": "The VNF or PNF **MUST** support a HTTPS connection to the DCAE\nVES Event Listener.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6662,13 +7252,6 @@ "errors": [] }, { - "id": "R-77707", - "text": "The xNF provider **MUST** include a Manifest File that\ncontains a list of all the components in the xNF package.", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { "id": "R-78010", "text": "The VNF **MUST** integrate with standard identity and access management\nprotocols such as LDAP, TACACS+, Windows Integrated Authentication\n(Kerberos), SAML federation, or OAuth 2.0.", "keyword": "MUST", @@ -6677,14 +7260,14 @@ }, { "id": "R-78116", - "text": "The xNF **MUST** update status on the Chef Server\nappropriately (e.g., via a fail or raise an exception) if the\nchef-client run encounters any critical errors/failures when\nexecuting a xNF action.", + "text": "The VNF or PNF **MUST** update status on the Chef Server\nappropriately (e.g., via a fail or raise an exception) if the\nchef-client run encounters any critical errors/failures when\nexecuting a VNF or PNF action.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-78282", - "text": "The xNF **MUST** conform to the NETCONF RFC 6242,\n\"Using the Network Configuration Protocol over Secure Shell\".", + "text": "The VNF or PNF **MUST** conform to the NETCONF RFC 6242,\n\"Using the Network Configuration Protocol over Secure Shell\".", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6704,6 +7287,13 @@ "errors": [] }, { + "id": "R-787965", + "text": "If the VNF or PNF CSAR Package utilizes Option 2 for package security, then\nthe complete CSAR file **MUST** be digitally signed with the VNF or PNF\nprovider private key. The VNF or PNF provider delivers one zip file\nconsisting of the CSAR file, a signature file and a certificate file that\nincludes the VNF or PNF provider public key. The certificate may also be\nincluded in the signature container, if the signature format allows that.\nThe VNF or PNF provider creates a zip file consisting of the CSAR file with\n.csar extension, signature and certificate files. The signature and\ncertificate files must be siblings of the CSAR file with extensions .cms\nand .cert respectively.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-79107", "text": "The VNF **MUST**, if not integrated with the Operator's Identity\nand Access Management system, support the ability to disable the\nuserID after a configurable number of consecutive unsuccessful\nauthentication attempts using the same userID.", "keyword": "MUST", @@ -6712,7 +7302,7 @@ }, { "id": "R-79224", - "text": "The xNF **MUST** have the chef-client be preloaded with\nvalidator keys and configuration to register with the designated\nChef Server as part of the installation process.", + "text": "The VNF or PNF **MUST** have the chef-client be preloaded with\nvalidator keys and configuration to register with the designated\nChef Server as part of the installation process.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6726,12 +7316,19 @@ }, { "id": "R-79412", - "text": "The xNF **MAY** use another option which is expected to include TCP\nfor high volume streaming asynchronous data sets and for other high volume\ndata sets. TCP delivery can be used for either JSON or binary encoded data\nsets.", + "text": "The VNF or PNF **MAY** use another option which is expected to include TCP\nfor high volume streaming asynchronous data sets and for other high volume\ndata sets. TCP delivery can be used for either JSON or binary encoded data\nsets.", "keyword": "MAY", "result": "PASS", "errors": [] }, { + "id": "R-795126", + "text": "The VNF TOSCA CSAR package Manifest file **MUST** start with the VNF\npackage metadata in the form of a name-value pairs. Each pair shall appear\non a different line. The name is specified as following:\n\n - vnf_provider_id\n\n - vnf_product_name\n\n - vnf_release_date_time\n\n - vnf_package_version", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-79817", "text": "A VNF's Heat Orchestration Template's parameter defined\nin a non-nested YAML file as\ntype ``comma_delimited_list`` **MAY** have a parameter constraint defined.", "keyword": "MAY", @@ -6740,7 +7337,7 @@ }, { "id": "R-798933", - "text": "The xNF **SHOULD** deliver event records that fall into the event domains\nsupported by VES.", + "text": "The VNF or PNF **SHOULD** deliver event records that fall into the event domains\nsupported by VES.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -6775,12 +7372,19 @@ }, { "id": "R-805572", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nECOMP definition, see Requirements R-52425 and R-46461),\nand an IPv6 Virtual IP (VIP)\naddress is assigned\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand an IPv6 Virtual IP (VIP)\naddress is assigned\nusing the property ``allowed_address_pairs``\nmap property ``ip_address``,\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ip``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: string``\nand **MUST** be enumerated in the environment file\n\nOR\n\nthe parameter name **MUST** follow the\nnaming convention\n\n * ``{vm-type}_int_{network-role}_floating_v6_ips``\n\nwhere\n\n * ``{vm-type}`` is the {vm-type} associated with the\n OS::Nova::Server\n * ``{network-role}`` is the {network-role} of the external\n network\n\nAnd the parameter **MUST** be declared as ``type: comma_delimited_list``\nand **MUST** be enumerated in the environment file.", "keyword": "MUST", "result": "PASS", "errors": [] }, { + "id": "R-807129", + "text": "The VNF or PNF **SHOULD** report the files in FileReady for as long as they are\navailable at VNF or PNF.\n\nNote: Recommended period is at least 24 hours.", + "keyword": "SHOULD", + "result": "PASS", + "errors": [] + }, + { "id": "R-80829", "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n``{network-role}_v6_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", "keyword": "MUST NOT", @@ -6789,7 +7393,7 @@ }, { "id": "R-80898", - "text": "TThe xNF **MUST** support heartbeat via a <get> with null filter.", + "text": "TThe VNF or PNF **MUST** support heartbeat via a <get> with null filter.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6817,7 +7421,7 @@ }, { "id": "R-81339", - "text": "A VNF Heat Orchestration Template's Base Module file name **MUST** include\ncase insensitive 'base' in the filename and\n**MUST** match one of the following four\nformats:\n\n 1.) ``base_<text>.y[a]ml``\n\n 2.) ``<text>_base.y[a]ml``\n\n 3.) ``base.y[a]ml``\n\n 4.) ``<text>_base_<text>``.y[a]ml\n\nwhere ``<text>`` **MUST** contain only alphanumeric characters and\nunderscores '_' and **MUST NOT** contain the case insensitive word ``base``.", + "text": "A VNF Heat Orchestration Template's Base Module file name **MUST** include\ncase insensitive 'base' in the filename and\n**MUST** match one of the following four\nformats:\n\n 1.) ``base_<text>.y[a]ml``\n\n 2.) ``<text>_base.y[a]ml``\n\n 3.) ``base.y[a]ml``\n\n 4.) ``<text>_base_<text>``.y[a]ml\n\nwhere ``<text>`` **MUST** contain only alphanumeric characters and\nunderscores '_' and **MUST NOT** contain the case insensitive string\n``base`` or ``volume``.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6830,6 +7434,13 @@ "errors": [] }, { + "id": "R-816745", + "text": "The VNF or PNF PROVIDER *MUST* provide the Service Provider with\nPM Meta Data (PM Dictionary) to support the analysis of PM events delivered\nto DCAE. The PM Dictionary is to be provided as a separate YAML artifact at\nonboarding and must follow the VES Event Listener Specification and VES\nEvent Registration Specification which contain the format and content\nrequired.", + "keyword": "MUST", + "result": "PASS", + "errors": [] + }, + { "id": "R-81725", "text": "A VNF's Incremental Module **MUST** have a corresponding Environment File", "keyword": "MUST", @@ -6838,7 +7449,7 @@ }, { "id": "R-81777", - "text": "The xNF **MUST** be configured with initial address(es) to use\nat deployment time. Subsequently, address(es) may be changed through\nONAP-defined policies delivered from ONAP to the xNF using PUTs to a\nRESTful API, in the same manner that other controls over data reporting\nwill be controlled by policy.", + "text": "The VNF or PNF **MUST** be configured with initial address(es) to use\nat deployment time. Subsequently, address(es) may be changed through\nONAP-defined policies delivered from ONAP to the VNF or PNF using PUTs to a\nRESTful API, in the same manner that other controls over data reporting\nwill be controlled by policy.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6852,7 +7463,7 @@ }, { "id": "R-82018", - "text": "The xNF **MUST** load the Ansible Server SSH public key onto xNF\nVM(s) /root/.ssh/authorized_keys as part of instantiation. Alternative,\nis for Ansible Server SSH public key to be loaded onto xNF VM(s) under\n/home/<Mechanized user ID>/.ssh/authorized_keys as part of instantiation,\nwhen a Mechanized user ID is created during instantiation, and Configure\nand all playbooks are designed to use a mechanized user ID only for\nauthentication (never using root authentication during Configure playbook\nrun). This will allow the Ansible Server to authenticate to perform\npost-instantiation configuration without manual intervention and without\nrequiring specific xNF login IDs and passwords.\n\n*CAUTION*: For xNFs configured using Ansible, to eliminate the need\nfor manual steps, post-instantiation and pre-configuration, to\nupload of SSH public keys, SSH public keys loaded during (heat)\ninstantiation shall be preserved and not removed by (heat) embedded\n(userdata) scripts.", + "text": "The VNF or PNF **MUST** load the Ansible Server SSH public key onto VNF or\nPNF VM(s) /root/.ssh/authorized_keys as part of instantiation. Alternative,\nis for Ansible Server SSH public key to be loaded onto VNF or PNF VM(s)\nunder /home/<Mechanized user ID>/.ssh/authorized_keys as part of\ninstantiation, when a Mechanized user ID is created during instantiation,\nand Configure and all playbooks are designed to use a mechanized user ID\nonly for authentication (never using root authentication during Configure\nplaybook run). This will allow the Ansible Server to authenticate to\nperform post-instantiation configuration without manual intervention and\nwithout requiring specific VNF or PNF login IDs and passwords.\n\n*CAUTION*: For VNFs or PNFs configured using Ansible, to eliminate the need\nfor manual steps, post-instantiation and pre-configuration, to\nupload of SSH public keys, SSH public keys loaded during (heat)\ninstantiation shall be preserved and not removed by (heat) embedded\n(userdata) scripts.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6873,14 +7484,14 @@ }, { "id": "R-821473", - "text": "The xNF MUST produce heartbeat indicators consisting of events containing\nthe common event header only per the VES Listener Specification.", + "text": "The VNF or PNF MUST produce heartbeat indicators consisting of events containing\nthe common event header only per the VES Listener Specification.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-821839", - "text": "The xNF **MUST** deliver event records to ONAP using the common transport\nmechanisms and protocols defined in this document.", + "text": "The VNF or PNF **MUST** deliver event records to ONAP using the common\ntransport mechanisms and protocols defined in this specification.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6893,13 +7504,6 @@ "errors": [] }, { - "id": "R-82481", - "text": "A VNF's Heat Orchestration Template's Resource property parameter that is\nassociated with a unique Virtual Machine type **MUST** include\n``{vm-type}`` as part of the parameter name with two exceptions:\n\n 1.) The Resource ``OS::Nova::Server`` property ``availability_zone``\n parameter **MUST NOT** be prefixed with a common ``{vm-type}`` identifier,\n\n 2.) The Resource ``OS::Nova::Server`` mandatory and optional\n ``metadata`` parameters\n\n * ``vnf_name``\n * ``vnf_id``\n * ``vf_module_id``\n * ``vf_module_name``\n * ``vf_module_index``\n * ``environment_context``\n * ``workload_context``\n\n **MUST NOT** be prefixed with a common ``{vm-type}`` identifier.", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { "id": "R-82551", "text": "When a VNF's Heat Orchestration Template's resource is associated with a\nsingle ``{vm-type}`` and a single internal network, the Resource ID **MUST**\ncontain both the ``{vm-type}`` and the ``int_{network-role}`` and\n\n- the ``{vm-type}`` **MUST** appear before the ``int_{network-role}`` and\n **MUST** be separated by an underscore '_'\n\n - (e.g., ``{vm-type}_int_{network-role}``,\n ``{vm-type}_{index}_int_{network-role}``)\n\n- note that an ``{index}`` value **MAY** separate the\n ``{vm-type}`` and the ``int_{network-role}`` and when this occurs\n underscores **MUST** separate the three values.\n (e.g., ``{vm-type}_{index}_int_{network-role}``).", "keyword": "MUST", @@ -6915,14 +7519,14 @@ }, { "id": "R-82811", - "text": "The xNF **MUST** support APPC ``StartApplication`` command.", + "text": "The VNF or PNF **MUST** support APPC ``StartApplication`` command.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-83146", - "text": "The xNF **MUST** support APPC ``StopApplication`` command.", + "text": "The VNF or PNF **MUST** support APPC ``StopApplication`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6936,14 +7540,7 @@ }, { "id": "R-83412", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``allowed_address_pairs``\nmap property ``ip_address`` parameter\n``{vm-type}_{network-role}_floating_ip``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", - "keyword": "MUST NOT", - "result": "PASS", - "errors": [] - }, - { - "id": "R-83418", - "text": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``allowed_address_pairs``\nmap property ``ip_address`` parameter\n``{vm-type}_{network-role}_floating_v6_ip``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "text": "If a VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an external network (per the\nONAP definition, see Requirement R-57424), the\nproperty ``allowed_address_pairs``\nmap property ``ip_address`` parameter(s)\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", "keyword": "MUST NOT", "result": "PASS", "errors": [] @@ -6971,14 +7568,14 @@ }, { "id": "R-83790", - "text": "The xNF **MUST** implement the ``:validate`` capability.", + "text": "The VNF or PNF **MUST** implement the ``:validate`` capability.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-83873", - "text": "The xNF **MUST** support ``:rollback-on-error`` value for\nthe <error-option> parameter to the <edit-config> operation. If any\nerror occurs during the requested edit operation, then the target\ndatabase (usually the running configuration) will be left unaffected.\nThis provides an 'all-or-nothing' edit mode for a single <edit-config>\nrequest.", + "text": "The VNF or PNF **MUST** support ``:rollback-on-error`` value for\nthe <error-option> parameter to the <edit-config> operation. If any\nerror occurs during the requested edit operation, then the target\ndatabase (usually the running configuration) will be left unaffected.\nThis provides an 'all-or-nothing' edit mode for a single <edit-config>\nrequest.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -6999,7 +7596,7 @@ }, { "id": "R-841740", - "text": "The xNF **SHOULD** support FileReady VES event for event-driven bulk transfer\nof monitoring data.", + "text": "The VNF or PNF **SHOULD** support FileReady VES event for event-driven bulk transfer\nof monitoring data.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -7020,7 +7617,7 @@ }, { "id": "R-84366", - "text": "The xNF Package **MUST** include documentation describing\nxNF Functional APIs that are utilized to build network and\napplication services. This document describes the externally exposed\nfunctional inputs and outputs for the xNF, including interface\nformat and protocols supported.", + "text": "The VNF or PNF Documentation Package **MUST** describe the\nVNF or PNF Functional APIs that are utilized to build network and\napplication services. This document describes the externally exposed\nfunctional inputs and outputs for the VNF or PNF, including interface\nformat and protocols supported.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7055,7 +7652,7 @@ }, { "id": "R-84879", - "text": "The xNF **MUST** have the capability of maintaining a primary\nand backup DNS name (URL) for connecting to ONAP collectors, with the\nability to switch between addresses based on conditions defined by policy\nsuch as time-outs, and buffering to store messages until they can be\ndelivered. At its discretion, the service provider may choose to populate\nonly one collector address for a xNF. In this case, the network will\npromptly resolve connectivity problems caused by a collector or network\nfailure transparently to the xNF.", + "text": "The VNF or PNF **MUST** have the capability of maintaining a primary\nand backup DNS name (URL) for connecting to ONAP collectors, with the\nability to switch between addresses based on conditions defined by policy\nsuch as time-outs, and buffering to store messages until they can be\ndelivered. At its discretion, the service provider may choose to populate\nonly one collector address for a VNF or PNF. In this case, the network will\npromptly resolve connectivity problems caused by a collector or network\nfailure transparently to the VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7083,7 +7680,7 @@ }, { "id": "R-85653", - "text": "The xNF **MUST** provide metrics (e.g., number of sessions,\nnumber of subscribers, number of seats, etc.) to ONAP for tracking\nevery license.", + "text": "The VNF or PNF **MUST** provide metrics (e.g., number of sessions,\nnumber of subscribers, number of seats, etc.) to ONAP for tracking\nevery license.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7111,21 +7708,21 @@ }, { "id": "R-85991", - "text": "The xNF provider **MUST** provide a universal license key\nper xNF to be used as needed by services (i.e., not tied to a VM\ninstance) as the recommended solution. The xNF provider may provide\npools of Unique xNF License Keys, where there is a unique key for\neach xNF instance as an alternate solution. Licensing issues should\nbe resolved without interrupting in-service xNFs.", + "text": "The VNF or PNF provider **MUST** provide a universal license key\nper VNF or PNF to be used as needed by services (i.e., not tied to a VM\ninstance) as the recommended solution. The VNF or PNF provider may provide\npools of Unique VNF or PNF License Keys, where there is a unique key for\neach VNF or PNF instance as an alternate solution. Licensing issues should\nbe resolved without interrupting in-service VNFs or PNFs.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-86182", - "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand the internal network is created in a\ndifferent Heat Orchestration Template than the ``OS::Neutron::Port``,\nthe ``network`` parameter name **MUST**\n\n * follow the naming convention ``int_{network-role}_net_id`` if the Neutron\n network UUID value is used to reference the network\n * follow the naming convention ``int_{network-role}_net_name`` if the\n OpenStack network name in is used to reference the network.\n\nwhere ``{network-role}`` is the network-role of the internal network and\na ``get_param`` **MUST** be used as the intrinsic function.", + "text": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port``\nis in an incremental module and\nis attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nthe ``network`` parameter name **MUST**\n\n * follow the naming convention ``int_{network-role}_net_id`` if the\n network UUID value is used to reference the network\n * follow the naming convention ``int_{network-role}_net_name`` if the\n network name in is used to reference the network.\n\nwhere ``{network-role}`` is the network-role of the internal network and\na ``get_param`` **MUST** be used as the intrinsic function.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-86235", - "text": "The xNF Package **MUST** include documentation about the monitoring\nparameters that must include latencies, success rates, retry rates, load\nand quality (e.g., DPM) for the key transactions/functions supported by\nthe xNF and those that must be exercised by the xNF in order to perform\nits function.", + "text": "The VNF or PNF Package **MUST** include documentation about the monitoring\nparameters that must include latencies, success rates, retry rates, load\nand quality (e.g., DPM) for the key transactions/functions supported by\nthe VNF or PNF and those that must be exercised by the VNF or PNF in order to perform\nits function.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7153,7 +7750,7 @@ }, { "id": "R-86497", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::Cinder::VolumeAttachment``\nResource ID\n**SHOULD**\nuse the naming convention\n\n* ``{vm-type}_volume_attachment_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` starts at zero and increments by one", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::Cinder::VolumeAttachment``\nResource ID\n**SHOULD**\nuse the naming convention\n\n* ``{vm-type}_volume_attachment_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` starts at zero and increments by one (as described in R-11690)", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -7167,7 +7764,7 @@ }, { "id": "R-86586", - "text": "The xNF **MUST** use the YANG configuration models and RESTCONF\n[RFC8040] (https://tools.ietf.org/html/rfc8040).", + "text": "The VNF or PNF **MUST** use the YANG configuration models and RESTCONF\n[RFC8040] (https://tools.ietf.org/html/rfc8040).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7209,7 +7806,7 @@ }, { "id": "R-87004", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::Cinder::Volume``\nResource ID\n**SHOULD**\nuse the naming convention\n\n* ``{vm-type}_volume_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` starts at zero and increments by one", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::Cinder::Volume``\nResource ID\n**SHOULD**\nuse the naming convention\n\n* ``{vm-type}_volume_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{index}`` starts at zero and increments by one (as described in R-11690)", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -7230,14 +7827,14 @@ }, { "id": "R-87234", - "text": "The VNF package provided by a VNF vendor **MAY** be either with\nTOSCA-Metadata directory (CSAR Option 1) or without TOSCA-Metadata\ndirectory (CSAR Option 2) as specified in ETSI GS NFV-SOL004. On-boarding\nentity (ONAP SDC) must support both options.\n\n**Note:** SDC supports only the CSAR Option 1 in Casablanca. The Option 2\nwill be considered in future ONAP releases,", - "keyword": "MAY", + "text": "The VNF or PNF package provided by a VNF or PNF vendor **MUST** be with\nTOSCA-Metadata directory (CSAR Option 1) as specified in\nETSI GS NFV-SOL004.\n\n**Note:** SDC supports only the CSAR Option 1 in Dublin. The Option 2\nwill be considered in future ONAP releases.", + "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-87247", - "text": "VNF Heat Orchestration Template's Incremental Module file name\n**MUST** contain only alphanumeric characters and underscores\n'_' and **MUST NOT** contain the case insensitive word ``base``.", + "text": "VNF Heat Orchestration Template's Incremental Module file name\n**MUST** contain only alphanumeric characters and underscores\n'_' and **MUST NOT** contain the case insensitive string ``base``.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7265,14 +7862,14 @@ }, { "id": "R-87563", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv6 Address on a port attached to an internal network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` is the instance of the virtual machine interface\n (e.g., port) on the vm-type\n attached to the network of ``{network-role}``\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` is the index of the IPv6 address", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InstanceIp`` Resource ID\nthat is configuring an IPv6 Address on a virtual machine interface\n(i.e., OS::ContrailV2::VirtualMachineInterface)\nattached to an internal network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_v6_IP_{index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.\n* ``v6_IP`` signifies that an IPv6 address is being configured\n* ``{index}`` references the instance of the IPv6 address configured\n on the virtual machine interface. The ``{index}`` is a numeric value\n that **MUST** start at zero on an\n instance of a virtual machine interface and **MUST** increment by one\n each time a new IPv6 address is configured on the\n virtual machine interface.", "keyword": "MUST", "result": "SKIP", "errors": [] }, { "id": "R-87564", - "text": "The xNF **SHOULD** conform its YANG model to RFC 7317,\n\"A YANG Data Model for System Management\".", + "text": "The VNF or PNF **SHOULD** conform its YANG model to RFC 7317,\n\"A YANG Data Model for System Management\".", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -7286,14 +7883,14 @@ }, { "id": "R-88026", - "text": "The xNF **MUST** include a NETCONF server enabling\nruntime configuration and lifecycle management capabilities.", + "text": "The VNF or PNF **MUST** include a NETCONF server enabling\nruntime configuration and lifecycle management capabilities.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-88031", - "text": "The xNF **SHOULD** implement the protocol operation:\n``delete-config(target)`` - Delete the named configuration\ndata store target.", + "text": "The VNF or PNF **SHOULD** implement the protocol operation:\n``delete-config(target)`` - Delete the named configuration\ndata store target.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -7307,7 +7904,7 @@ }, { "id": "R-88482", - "text": "The xNF **SHOULD** use REST using HTTPS delivery of plain\ntext JSON for moderate sized asynchronous data sets, and for high\nvolume data sets when feasible.", + "text": "The VNF or PNF **SHOULD** use REST using HTTPS delivery of plain\ntext JSON for moderate sized asynchronous data sets, and for high\nvolume data sets when feasible.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -7335,7 +7932,7 @@ }, { "id": "R-88899", - "text": "The xNF **MUST** support simultaneous <commit> operations\nwithin the context of this locking requirements framework.", + "text": "The VNF or PNF **MUST** support simultaneous <commit> operations\nwithin the context of this locking requirements framework.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7349,7 +7946,7 @@ }, { "id": "R-894004", - "text": "When the xNF sets up a HTTP or HTTPS connection to the collector, it **MUST**\nprovide a username and password to the DCAE VES Collector for HTTP Basic\nAuthentication.\n\nNote: HTTP Basic Authentication has 4 steps: Request, Authenticate,\nAuthorization with Username/Password Credentials, and Authentication Status\nas per RFC7617 and RFC 2617.", + "text": "If the VNF or PNF is using Basic Authentication, then when the VNF\nor PNF sets up a HTTPS connection to the DCAE VES Event Listener,\nthe VNF or PNF **MUST** provide a username and password to the\nDCAE VES Event Listener in the Authorization header and the VNF\nor PNF MUST support one-way TLS authentication.\n\nNote: In one-way TLS authentication, the client (VNF or PNF)\nmust authentication the server (DCAE) certificate.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7363,7 +7960,7 @@ }, { "id": "R-89571", - "text": "The xNF **MUST** support and provide artifacts for configuration\nmanagement using at least one of the following technologies;\na) Netconf/YANG, b) Chef, or c) Ansible.\n\nNote: The requirements for Netconf/YANG, Chef, and Ansible protocols\nare provided separately and must be supported only if the corresponding\nprotocol option is provided by the xNF providor.", + "text": "The VNF or PNF **MUST** support and provide artifacts for configuration\nmanagement using at least one of the following technologies;\na) Netconf/YANG, b) Chef, or c) Ansible.\n\nNote: The requirements for Netconf/YANG, Chef, and Ansible protocols\nare provided separately and must be supported only if the corresponding\nprotocol option is provided by the VNF or PNF providor.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7384,7 +7981,7 @@ }, { "id": "R-90007", - "text": "The xNF **MUST** implement the protocol operation:\n``close-session()`` - Gracefully close the current session.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``close-session()`` - Gracefully close the current session.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7433,21 +8030,21 @@ }, { "id": "R-90632", - "text": "The xNF Package **MUST** include documentation about KPIs and\nmetrics that need to be collected at each VM for capacity planning\nand performance management purposes.", + "text": "The VNF Package **MUST** include documentation about KPIs and\nmetrics that need to be collected at each VM for capacity planning\nand performance management purposes.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-90748", - "text": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::CinderVolume``\n**MAY** be defined in an Incremental Module.", + "text": "A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume``\n**MAY** be defined in an Incremental Module.", "keyword": "MAY", "result": "PASS", "errors": [] }, { "id": "R-908291", - "text": "The XNF **MAY** leverage bulk xNF telemetry transmission mechanism, as\ndepicted in Figure 4, in instances where other transmission methods are not\npractical or advisable.", + "text": "The VNF or PNF **MAY** leverage bulk VNF or PNF telemetry transmission mechanism, as\ndepicted in Figure 4, in instances where other transmission methods are not\npractical or advisable.", "keyword": "MAY", "result": "PASS", "errors": [] @@ -7482,19 +8079,12 @@ }, { "id": "R-91745", - "text": "The xNF **MUST** update the Ansible Server and other entities\nstoring and using the SSH keys for authentication when the SSH\nkeys used by Ansible are regenerated/updated.\n\n**Note**: Ansible Server itself may be used to upload new SSH public\nkeys onto supported xNFs.", + "text": "The VNF or PNF **MUST** update the Ansible Server and other entities\nstoring and using the SSH keys for authentication when the SSH\nkeys used by Ansible are regenerated/updated.\n\n**Note**: Ansible Server itself may be used to upload new SSH public\nkeys onto supported VNFs or PNFs.", "keyword": "MUST", "result": "PASS", "errors": [] }, { - "id": "R-91810", - "text": "If a VNF requires ONAP to assign a Virtual IP (VIP) Address to\nports connected an external network, the port\n**MUST NOT** have more than one IPv4 VIP address.", - "keyword": "MUST NOT", - "result": "PASS", - "errors": [] - }, - { "id": "R-92193", "text": "A VNF's Heat Orchestration Template's parameter\n``{network-role}_net_fqdn``\n**MUST NOT** be enumerated in the VNF's Heat Orchestration Template's\nEnvironment File.", "keyword": "MUST NOT", @@ -7524,7 +8114,7 @@ }, { "id": "R-92866", - "text": "The xNF **MUST** include as part of post-instantiation configuration\ndone by Ansible Playbooks the removal/update of the SSH public key from\n/root/.ssh/authorized_keys, and update of SSH keys loaded through\ninstantiation to support Ansible. This may include creating Mechanized user\nID(s) used by the Ansible Server(s) on VNF VM(s) and uploading and\ninstalling new SSH keys used by the mechanized use ID(s).", + "text": "The VNF or PNF **MUST** include as part of post-instantiation configuration\ndone by Ansible Playbooks the removal/update of the SSH public key from\n/root/.ssh/authorized_keys, and update of SSH keys loaded through\ninstantiation to support Ansible. This may include creating Mechanized user\nID(s) used by the Ansible Server(s) on VNF VM(s) and uploading and\ninstalling new SSH keys used by the mechanized use ID(s).", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7551,22 +8141,15 @@ "errors": [] }, { - "id": "R-93177", - "text": "When the VNF's Heat Orchestration Template's resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see Requirements R-52425 and R-46461),\nand the internal network is created in the\nsame Heat Orchestration Template as the ``OS::Neutron::Port``,\nthe ``network`` property value **MUST** obtain the UUID\nof the internal network by using the intrinsic function\n``get_resource``\nand referencing the Resource ID of the internal network.", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { "id": "R-932071", - "text": "The xNF provider **MUST** reach agreement with the Service Provider on\nthe selected methods for encoding, serialization and data delivery\nprior to the on-boarding of the xNF into ONAP SDC Design Studio.", + "text": "The VNF or PNF provider **MUST** reach agreement with the Service Provider on\nthe selected methods for encoding, serialization and data delivery\nprior to the on-boarding of the VNF or PNF into ONAP SDC Design Studio.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-93443", - "text": "The xNF **MUST** define all data models in YANG [RFC6020],\nand the mapping to NETCONF shall follow the rules defined in this RFC.", + "text": "The VNF or PNF **MUST** define all data models in YANG 1.0 [RFC6020] or\nYANG 1.1 [RFC7950]. A combination of YANG 1.0 and YANG 1.1 modules is\nallowed subject to the rules in [RFC7950] section 12. The mapping to\nNETCONF shall follow the rules defined in this RFC.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7587,7 +8170,7 @@ }, { "id": "R-94084", - "text": "The xNF **MUST** support APPC/SDN-C ``ConfigScaleOut`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``ConfigScaleOut`` command.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7608,7 +8191,7 @@ }, { "id": "R-94567", - "text": "The xNF **MUST** provide Ansible playbooks that are designed to run using\nan inventory hosts file in a supported format with only IP addresses or\nIP addresses and VM/xNF names.", + "text": "The VNF or PNF **MUST** provide Ansible playbooks that are designed to run\nusing an inventory hosts file in a supported format with only IP addresses\nor IP addresses and VM/VNF or PNF names.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7664,7 +8247,7 @@ }, { "id": "R-95950", - "text": "The xNF **MUST** provide a NETCONF interface fully defined\nby supplied YANG models for the embedded NETCONF server.", + "text": "The VNF or PNF **MUST** provide a NETCONF interface fully defined\nby supplied YANG models for the embedded NETCONF server.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7678,7 +8261,7 @@ }, { "id": "R-96253", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` that is attaching to an external network\nResource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` is the instance of the ``{vm-type}``\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` is the instance of the vmi on the vm-type\n attached to the network of ``{network-role}``", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` Resource ID\nthat is attaching to an external network\n**MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{vm-type_index}`` references the instance of the ``{vm-type}`` in\n the VNF. The\n ``{vm-type_index}`` is a numeric value that **MUST** start at zero\n in the VNF and\n **MUST** increment by one each time a new instance of a ``{vm-type}``\n is referenced.\n* ``{network-role}`` is the network-role of the network\n that the port (i.e. virtual machine interface) is attached to\n* ``{vmi_index}`` references the instance of the virtual machine interface\n on the ``{vm-type}`` attached to ``{network-role}`` network. The\n ``{vmi_index}`` is a numeric value that **MUST** start at zero on an\n instance of a ``{vm-type}`` and **MUST** increment by one each time a\n new virtual machine interface is defined on the instance of the\n ``{vm-type}`` attached to ``{network-role}`` network.", "keyword": "MUST", "result": "SKIP", "errors": [] @@ -7692,14 +8275,14 @@ }, { "id": "R-96554", - "text": "The xNF **MUST** implement the protocol operation:\n``unlock(target)`` - Unlock the configuration data store target.", + "text": "The VNF or PNF **MUST** implement the protocol operation:\n``unlock(target)`` - Unlock the configuration data store target.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-96634", - "text": "The xNF provider **MUST** describe scaling capabilities\nto manage scaling characteristics of the xNF.", + "text": "The VNF or PNF Provider\u00a0**MUST**\u00a0provide human readable documentation\n(not in the on-boarding package) to describe scaling capabilities to manage\nscaling characteristics of the VNF or PNF.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7727,21 +8310,21 @@ }, { "id": "R-97293", - "text": "The xNF provider **MUST NOT** require audits\nof Service Provider's business.", + "text": "The VNF or PNF provider **MUST NOT** require audits\nof Service Provider's business.", "keyword": "MUST NOT", "result": "PASS", "errors": [] }, { "id": "R-97343", - "text": "The xNF **MUST** support APPC/SDN-C ``UpgradeBackup`` command.", + "text": "The VNF or PNF **MUST** support APPC/SDN-C ``UpgradeBackup`` command.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-97345", - "text": "The xNF **MUST** permit authentication, using root account, only right\nafter instantiation and until post-instantiation configuration is\ncompleted.", + "text": "The VNF or PNF **MUST** permit authentication, using root account, only\nright after instantiation and until post-instantiation configuration is\ncompleted.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7755,14 +8338,14 @@ }, { "id": "R-97451", - "text": "The xNF **MUST** provide the ability to remove root access once\npost-instantiation configuration (Configure) is completed.", + "text": "The VNF or PNF **MUST** provide the ability to remove root access once\npost-instantiation configuration (Configure) is completed.", "keyword": "MUST", "result": "PASS", "errors": [] }, { "id": "R-97529", - "text": "The xNF **SHOULD** implement the protocol operation:\n``get-schema(identifier, version, format)`` - Retrieve the YANG schema.", + "text": "The VNF or PNF **SHOULD** implement the protocol operation:\n``get-schema(identifier, version, format)`` - Retrieve the YANG schema.", "keyword": "SHOULD", "result": "PASS", "errors": [] @@ -7776,7 +8359,7 @@ }, { "id": "R-978752", - "text": "The xNF providers **MUST** provide the Service Provider the following\nartifacts to support the delivery of high-volume xNF telemetry to\nDCAE via GPB over TLS/TCP:\n\n * A valid VES Event .proto definition file, to be used validate and\n decode an event\n * A valid high volume measurement .proto definition file, to be used for\n processing high volume events\n * A supporting PM content metadata file to be used by analytics\n applications to process high volume measurement events", + "text": "The VNF or PNF providers **MUST** provide the Service Provider the following\nartifacts to support the delivery of high-volume VNF or PNF telemetry to\nDCAE via GPB over TLS/TCP:\n\n * A valid VES Event .proto definition file, to be used validate and\n decode an event\n * A valid high volume measurement .proto definition file, to be used for\n processing high volume events\n * A supporting PM content metadata file to be used by analytics\n applications to process high volume measurement events", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7804,7 +8387,7 @@ }, { "id": "R-98191", - "text": "The xNF **MUST** vary the frequency that asynchronous data\nis delivered based on the content and how data may be aggregated or\ngrouped together.\n\n Note:\n\n - For example, alarms and alerts are expected to be delivered as\n soon as they appear. In contrast, other content, such as performance\n measurements, KPIs or reported network signaling may have various\n ways of packaging and delivering content. Some content should be\n streamed immediately; or content may be monitored over a time\n interval, then packaged as collection of records and delivered\n as block; or data may be collected until a package of a certain\n size has been collected; or content may be summarized statistically\n over a time interval, or computed as a KPI, with the summary or KPI\n being delivered.\n - We expect the reporting frequency to be configurable depending on\n the virtual network functions needs for management. For example,\n Service Provider may choose to vary the frequency of collection\n between normal and trouble-shooting scenarios.\n - Decisions about the frequency of data reporting will affect\n the size of delivered data sets, recommended delivery method,\n and how the data will be interpreted by ONAP. These considerations\n should not affect deserialization and decoding of the data, which\n will be guided by the accompanying JSON schema or GPB definition\n files.", + "text": "The VNF or PNF **MUST** vary the frequency that asynchronous data\nis delivered based on the content and how data may be aggregated or\ngrouped together.\n\n Note:\n\n - For example, alarms and alerts are expected to be delivered as\n soon as they appear. In contrast, other content, such as performance\n measurements, KPIs or reported network signaling may have various\n ways of packaging and delivering content. Some content should be\n streamed immediately; or content may be monitored over a time\n interval, then packaged as collection of records and delivered\n as block; or data may be collected until a package of a certain\n size has been collected; or content may be summarized statistically\n over a time interval, or computed as a KPI, with the summary or KPI\n being delivered.\n - We expect the reporting frequency to be configurable depending on\n the virtual network functions needs for management. For example,\n Service Provider may choose to vary the frequency of collection\n between normal and trouble-shooting scenarios.\n - Decisions about the frequency of data reporting will affect\n the size of delivered data sets, recommended delivery method,\n and how the data will be interpreted by ONAP. These considerations\n should not affect deserialization and decoding of the data, which\n will be guided by the accompanying JSON schema or GPB definition\n files.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7817,13 +8400,6 @@ "errors": [] }, { - "id": "R-98391", - "text": "The VNF **MUST**, if not integrated with the Operator's Identity and\nAccess Management system, support Role-Based Access Control to enforce\nleast privilege.", - "keyword": "MUST", - "result": "PASS", - "errors": [] - }, - { "id": "R-98407", "text": "A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST** contain only\nalphanumeric characters and/or underscores '_' and **MUST NOT**\ncontain any of the following strings:\n``_int`` or ``int_`` or ``_int_``.", "keyword": "MUST NOT", @@ -7832,7 +8408,7 @@ }, { "id": "R-98450", - "text": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``availability_zone`` parameter name\n**MUST** follow the naming convention\n\n* ``availability_zone_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at zero\nin a VNF's Heat Orchestration Templates and **MUST**\nincrement by one.", + "text": "A VNF's Heat Orchestration Template's base module or incremental module\nresource ``OS::Nova::Server``\nproperty ``availability_zone`` parameter\n**MUST** follow the naming convention\n\n* ``availability_zone_{index}``\n\nwhere ``{index}`` is a numeric value that **MUST** start at zero\nin a VNF's Heat Orchestration Templates and **MUST**\nincrement by one.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7846,7 +8422,7 @@ }, { "id": "R-98617", - "text": "The xNF provider **MUST** provide information regarding any\ndependency (e.g., affinity, anti-affinity) with other xNFs and resources.", + "text": "The VNF Provider **MUST** provide documentation regarding any dependency\n(e.g. affinity, anti-affinity) the VNF has on other VNFs and resources.", "keyword": "MUST", "result": "PASS", "errors": [] @@ -7860,7 +8436,7 @@ }, { "id": "R-98911", - "text": "The xNF **MUST NOT** use any instance specific parameters\nfor the xNF in roles/cookbooks/recipes invoked for a xNF action.", + "text": "The VNF or PNF **MUST NOT** use any instance specific parameters\nfor the VNF or PNF in roles/cookbooks/recipes invoked for a VNF or PNF\naction.", "keyword": "MUST NOT", "result": "PASS", "errors": [] @@ -7874,7 +8450,7 @@ }, { "id": "R-99110", - "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualNetwork`` Resource ID **MUST** use the naming convention\n\n1) ``int_{network-role}_network``\n\nor\n\n2) ``int_{network-role}_RVN`` where RVN represents Resource Virtual\n Network\n\nVNF Heat Orchestration Templates can only create internal networks.\nThere is no ``{index}`` after ``{network-role}`` because ``{network-role}``\n**MUST** be unique in the scope of the VNF's\nHeat Orchestration Template.\n\nNote that option 1 is preferred.", + "text": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualNetwork`` Resource ID **MUST** use the naming\nconvention\n\n* ``int_{network-role}_network``\n\nVNF Heat Orchestration Templates can only create internal networks.\nThere is no ``{index}`` after ``{network-role}`` because ``{network-role}``\n**MUST** be unique in the scope of the VNF's\nHeat Orchestration Template.", "keyword": "MUST", "result": "SKIP", "errors": [] @@ -7922,6 +8498,13 @@ "errors": [] }, { + "id": "R-997907", + "text": "The VNF or PNF **SHOULD** support TLS as secure transport for the NETCONF\nprotocol according to [RFC7589].", + "keyword": "SHOULD", + "result": "PASS", + "errors": [] + }, + { "id": "R-99794", "text": "An external network **MUST** have one subnet. An external network\n**MAY** have more than one subnet.", "keyword": "MUST", @@ -7943,4 +8526,4 @@ "errors": [] } ] -}
\ No newline at end of file +} |