diff options
Diffstat (limited to 'docs/data/needs.json')
| -rw-r--r-- | docs/data/needs.json | 1628 |
1 files changed, 1604 insertions, 24 deletions
diff --git a/docs/data/needs.json b/docs/data/needs.json index 8bea014..01d2b9e 100644 --- a/docs/data/needs.json +++ b/docs/data/needs.json @@ -1,5 +1,5 @@ { - "created": "2018-11-07T08:30:07.777388", + "created": "2018-11-07T12:53:57.615885", "current_version": "casablanca", "project": "", "versions": { @@ -21858,10 +21858,11 @@ "needs_amount": 750 }, "casablanca": { - "created": "2018-11-07T08:30:07.777357", + "created": "2018-11-07T12:53:57.615875", "needs": { "R-00011": { "description": "A VNF's Heat Orchestration Template's parameter defined\nin a nested YAML file\n**MUST NOT** have a parameter constraint defined.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-00011", @@ -21870,6 +21871,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "constraints", "sections": [ "constraints", @@ -21892,6 +21894,7 @@ }, "R-00068": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-00068", @@ -21900,6 +21903,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Description", "sections": [ "Resource Description", @@ -21920,6 +21924,7 @@ }, "R-00098": { "description": "The VNF **MUST NOT** impact the ability of the VNF to provide\nservice/function due to a single container restart.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-00098", @@ -21928,6 +21933,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "All Layer Redundancy", "sections": [ "All Layer Redundancy", @@ -21948,6 +21954,7 @@ }, "R-00156": { "description": "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).", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-00156", @@ -21956,6 +21963,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Description", "sections": [ "Resource Description", @@ -21976,6 +21984,7 @@ }, "R-00228": { "description": "A VNF's Heat Orchestration Template **MAY**\nreference the nested heat statically by repeated definition.", + "docname": "Chapter5/Heat/ONAP Heat Template Constructs", "full_title": "", "hide_links": "", "id": "R-00228", @@ -21984,6 +21993,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Nested Heat Template Requirements", "sections": [ "Nested Heat Template Requirements", @@ -22005,6 +22015,7 @@ }, "R-00606": { "description": "A VNF **MAY** be connected to zero, one or more than one external\nnetwork.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-00606", @@ -22013,6 +22024,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "External Networks", "sections": [ "External Networks", @@ -22033,6 +22045,7 @@ }, "R-00977": { "description": "A VNF's Heat Orchestration Template's ``{network-role}``\n**MUST NOT** be a substring of ``{vm-type}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}", "full_title": "", "hide_links": "", "id": "R-00977", @@ -22041,6 +22054,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "{network-role}", "sections": [ "{network-role}" @@ -22060,6 +22074,7 @@ }, "R-01033": { "description": "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.)", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-01033", @@ -22068,6 +22083,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Addressing and Delivery Protocol", "sections": [ "Addressing and Delivery Protocol", @@ -22089,6 +22105,7 @@ }, "R-01101": { "description": "A VNF's Heat Orchestration Template **MAY**\nreference the nested heat dynamically using the resource\n``OS::Heat::ResourceGroup``.", + "docname": "Chapter5/Heat/ONAP Heat Template Constructs", "full_title": "", "hide_links": "", "id": "R-01101", @@ -22097,6 +22114,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Nested Heat Template Requirements", "sections": [ "Nested Heat Template Requirements", @@ -22118,6 +22136,7 @@ }, "R-01123": { "description": "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.", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-01123", @@ -22126,6 +22145,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Package Contents", "sections": [ "VNF Package Contents", @@ -22147,6 +22167,7 @@ }, "R-01334": { "description": "The xNF **MUST** conform to the NETCONF RFC 5717,\n\"Partial Lock Remote Procedure Call\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-01334", @@ -22155,6 +22176,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -22177,6 +22199,7 @@ }, "R-01359": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-01359", @@ -22185,6 +22208,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Property: availability_zone", "sections": [ "Property: availability_zone", @@ -22205,6 +22229,7 @@ }, "R-01382": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-01382", @@ -22213,6 +22238,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -22235,6 +22261,7 @@ }, "R-01427": { "description": "The PNF **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.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-01427", @@ -22243,6 +22270,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -22263,6 +22291,7 @@ }, "R-01455": { "description": "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 the identical number of\n ports connecting to the identical networks and requiring the identical\n IP address configuration.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}", "full_title": "", "hide_links": "", "id": "R-01455", @@ -22271,6 +22300,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "{vm-type}", "sections": [ "{vm-type}" @@ -22290,6 +22320,7 @@ }, "R-01478": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-01478", @@ -22298,6 +22329,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -22318,6 +22350,7 @@ }, "R-01556": { "description": "The xNF Package **MUST** include documentation describing the\nfault, performance, capacity events/alarms and other event records\nthat are made available by the xNF.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-01556", @@ -22326,6 +22359,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -22346,6 +22380,7 @@ }, "R-01896": { "description": "A VNF's Heat Orchestration Template's parameter values that are constant\nacross all deployments **MUST** be declared in a Heat Orchestration\nTemplate Environment File.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-01896", @@ -22354,6 +22389,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Scope of a Heat Orchestration Template", "sections": [ "Scope of a Heat Orchestration Template", @@ -22374,6 +22410,7 @@ }, "R-02164": { "description": "When a VNF's Heat Orchestration Template's Contrail resource\nhas a property that\nreferences an external network that requires the network's\nFully Qualified Domain Name (FQDN), the property parameter\n\n* **MUST** follow the format ``{network-role}_net_fqdn``\n* **MUST** be declared as type ``string``\n* **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's\n Environment File", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters", "full_title": "", "hide_links": "", "id": "R-02164", @@ -22382,6 +22419,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "External Networks", "sections": [ "External Networks", @@ -22403,6 +22441,7 @@ }, "R-02170": { "description": "The VNF **MUST** use, whenever possible, standard implementations\nof security applications, protocols, and formats, e.g., S/MIME, TLS, SSH,\nIPSec, X.509 digital certificates for cryptographic implementations.\nThese implementations must be purchased from reputable vendors or obtained\nfrom reputable open source communities and must not be developed in-house.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-02170", @@ -22411,6 +22450,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Data Protection Requirements", "sections": [ "VNF Data Protection Requirements", @@ -22431,6 +22471,7 @@ }, "R-02360": { "description": "The VNFC **MUST** be designed as a standalone, executable process.", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-02360", @@ -22439,6 +22480,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -22458,6 +22500,7 @@ }, "R-02454": { "description": "The VNF **MUST** support the existence of multiple major/minor\nversions of the VNF software and/or sub-components and interfaces that\nsupport both forward and backward compatibility to be transparent to\nthe Service Provider usage.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-02454", @@ -22466,6 +22509,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Deployment Optimization", "sections": [ "Deployment Optimization", @@ -22486,6 +22530,7 @@ }, "R-02597": { "description": "The xNF **MUST** implement the protocol operation:\n``lock(target)`` - Lock the configuration data store target.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-02597", @@ -22494,6 +22539,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -22510,12 +22556,13 @@ "title": "", "title_from_content": "", "type_name": "Requirement", - "updated": "", + "updated": "casablanca", "validated_by": "", "validation_mode": "" }, "R-02616": { "description": "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).", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-02616", @@ -22524,6 +22571,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -22546,6 +22594,7 @@ }, "R-02651": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-02651", @@ -22554,6 +22603,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Playbook Requirements", "sections": [ "Ansible Playbook Requirements", @@ -22576,6 +22626,7 @@ }, "R-02691": { "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``workload_context``\nparameter ``workload_context`` **MUST NOT**\nbe enumerated in the Heat Orchestration Template's environment file.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-02691", @@ -22584,6 +22635,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "workload_context", "sections": [ "workload_context", @@ -22604,6 +22656,7 @@ }, "R-02997": { "description": "The VNF **MUST** preserve their persistent data. Running VMs\nwill not be backed up in the Network Cloud infrastructure.", + "docname": "Chapter4/Devops", "full_title": "", "hide_links": "", "id": "R-02997", @@ -22612,6 +22665,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Devops", "sections": [ "VNF Devops" @@ -22631,6 +22685,7 @@ }, "R-03070": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-03070", @@ -22639,6 +22694,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Addressing and Delivery Protocol", "sections": [ "Addressing and Delivery Protocol", @@ -22660,6 +22716,7 @@ }, "R-03251": { "description": "A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume\n**MAY** be defined in a Cinder Volume Module.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-03251", @@ -22668,6 +22725,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -22688,6 +22746,7 @@ }, "R-03324": { "description": "A VNF's Heat Orchestration template's Environment File **MUST**\ncontain the ``parameters:`` section.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-03324", @@ -22696,6 +22755,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Environment File Format", "sections": [ "Environment File Format", @@ -22716,6 +22776,7 @@ }, "R-03465": { "description": "The xNF **MUST** release locks to prevent permanent lock-outs\nwhen the corresponding <partial-unlock> operation succeeds.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-03465", @@ -22724,6 +22785,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -22746,6 +22808,7 @@ }, "R-03595": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::SecurityGroup`` that\nis applicable to more than one ``{vm-type}`` and one external network Resource ID\n**SHOULD** use the naming convention\n\n* ``{network-role}_security_group``\n\nwhere\n\n* ``{network-role}`` is the network-role", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-03595", @@ -22754,6 +22817,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Neutron::SecurityGroup", "sections": [ "OS::Neutron::SecurityGroup", @@ -22775,6 +22839,7 @@ }, "R-03656": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::SoftwareConfig``\nResource ID **MAY** use the naming convention\n\n* ``{vm-type}_RSC``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``RSC`` signifies that it is the Resource Software Config", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-03656", @@ -22783,6 +22848,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Heat::SoftwareConfig", "sections": [ "OS::Heat::SoftwareConfig", @@ -22804,6 +22870,7 @@ }, "R-03954": { "description": "The VNF **MUST** survive any single points of failure within\nthe Network Cloud (e.g., virtual NIC, VM, disk failure).", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-03954", @@ -22812,6 +22879,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "All Layer Redundancy", "sections": [ "All Layer Redundancy", @@ -22832,6 +22900,7 @@ }, "R-04158": { "description": "The xNF **MUST** conform to the NETCONF RFC 4742,\n\"Using the NETCONF Configuration Protocol over Secure Shell (SSH)\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-04158", @@ -22840,6 +22909,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -22862,6 +22932,7 @@ }, "R-04298": { "description": "The xNF provider **MUST** provide their testing scripts to\nsupport testing.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-04298", @@ -22870,6 +22941,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Testing", "sections": [ "Testing", @@ -22890,6 +22962,7 @@ }, "R-04344": { "description": "A VNF's Nested YAML file **MAY** be invoked by more than one of\na VNF's Heat Orchestration Templates (when the VNF is composed of two\nor more Heat Orchestration Templates).", + "docname": "Chapter5/Heat/ONAP Heat Template Constructs", "full_title": "", "hide_links": "", "id": "R-04344", @@ -22898,6 +22971,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Nested Heat Template Requirements", "sections": [ "Nested Heat Template Requirements", @@ -22919,6 +22993,7 @@ }, "R-04492": { "description": "The VNF **MUST** generate security audit logs that can be sent\nto Security Analytics Tools for analysis.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-04492", @@ -22927,6 +23002,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -22947,6 +23023,7 @@ }, "R-04697": { "description": "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\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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-04697", @@ -22955,6 +23032,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -22975,6 +23053,7 @@ }, "R-04747": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::CloudConfig``\nResource ID **MUST** contain the ``{vm-type}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-04747", @@ -22983,6 +23062,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Heat::CloudConfig", "sections": [ "OS::Heat::CloudConfig", @@ -23004,6 +23084,7 @@ }, "R-04982": { "description": "The VNF **MUST NOT** include an authentication credential,\ne.g., password, in the security audit logs, even if encrypted.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-04982", @@ -23012,6 +23093,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -23032,6 +23114,7 @@ }, "R-05050": { "description": "A VNF's Heat Orchestration Templates intrinsic function\n``get_file`` <content key> **MAY** be used:\n\n * more than once in a VNF's Heat Orchestration Template\n * in two or more of a VNF's Heat Orchestration Templates\n * in a VNF's Heat Orchestration Templates nested YAML file", + "docname": "Chapter5/Heat/ONAP Heat Template Constructs", "full_title": "", "hide_links": "", "id": "R-05050", @@ -23040,6 +23123,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Heat Files Support (get_file)", "sections": [ "Heat Files Support (get_file)", @@ -23060,6 +23144,7 @@ }, "R-05201": { "description": "When a VNF connects to two or more external networks, each external\nnetwork **MUST** be assigned a unique ``{network-role}``\nin the context of the VNF for use in the VNF's Heat Orchestration\nTemplate.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-05201", @@ -23068,6 +23153,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "External Networks", "sections": [ "External Networks", @@ -23088,6 +23174,7 @@ }, "R-05257": { "description": "A VNF's Heat Orchestration Template's **MUST NOT**\ncontain the Resource ``OS::Neutron::FloatingIP``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-05257", @@ -23096,6 +23183,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VIP Assignment, External Networks, Supported by Automation", "sections": [ "VIP Assignment, External Networks, Supported by Automation", @@ -23117,6 +23205,7 @@ }, "R-06327": { "description": "The VNF **MUST** respond to a \"drain VNFC\" [#4.5.2]_ command against\na specific VNFC, preventing new session from reaching the targeted VNFC,\nwith no disruption to active sessions on the impacted VNFC, if a VNF\nprovides a load balancing function across multiple instances of its VNFCs.\nThis is used to support scenarios such as proactive maintenance with no\nuser impact.", + "docname": "Chapter4/Devops", "full_title": "", "hide_links": "", "id": "R-06327", @@ -23125,6 +23214,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Devops", "sections": [ "VNF Devops" @@ -23144,6 +23234,7 @@ }, "R-06413": { "description": "The VNF **MUST** log the field \"service or program used for access\"\nin the security audit logs.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-06413", @@ -23152,6 +23243,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -23172,6 +23264,7 @@ }, "R-06613": { "description": "A VNF's Heat Orchestration Template's parameter defined\nin a non-nested YAML file as type\n``boolean`` **MAY** have a parameter constraint defined.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-06613", @@ -23180,6 +23273,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "constraints", "sections": [ "constraints", @@ -23202,6 +23296,7 @@ }, "R-06668": { "description": "The VNF **MUST** handle the start or restart of VNFC instances\nin any order with each VNFC instance establishing or re-establishing\nrequired connections or relationships with other VNFC instances and/or\nVNFs required to perform the VNF function/role without requiring VNFC\ninstance(s) to be started/restarted in a particular order.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-06668", @@ -23210,6 +23305,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Application Resilient Error Handling", "sections": [ "Application Resilient Error Handling", @@ -23230,6 +23326,7 @@ }, "R-06885": { "description": "The VNF **SHOULD** support the ability to scale down a VNFC pool\nwithout jeopardizing active sessions. Ideally, an active session should\nnot be tied to any particular VNFC instance.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-06885", @@ -23238,6 +23335,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "System Resource Optimization", "sections": [ "System Resource Optimization", @@ -23258,6 +23356,7 @@ }, "R-06924": { "description": "The xNF **MUST** deliver asynchronous data as data becomes\navailable, or according to the configured frequency.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-06924", @@ -23266,6 +23365,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Asynchronous and Synchronous Data Delivery", "sections": [ "Asynchronous and Synchronous Data Delivery", @@ -23287,6 +23387,7 @@ }, "R-07251": { "description": "The xNF **MUST** support APPC/SDN-C ``ResumeTraffic`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-07251", @@ -23295,6 +23396,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Lifecycle Management Related Commands", "sections": [ "Lifecycle Management Related Commands", @@ -23316,6 +23418,7 @@ }, "R-07443": { "description": "A VNF's Heat Orchestration Templates' Cinder Volume Module Output\nParameter's name and type **MUST** match the input parameter name and type\nin the corresponding Base Module or Incremental Module unless the Output\nParameter is of the type ``comma_delimited_list``, then the corresponding\ninput parameter **MUST** be declared as type ``json``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-07443", @@ -23324,6 +23427,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP Volume Module Output Parameters", "sections": [ "ONAP Volume Module Output Parameters", @@ -23345,6 +23449,7 @@ }, "R-07507": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-07507", @@ -23353,6 +23458,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "vnf_id", "sections": [ "vnf_id", @@ -23373,6 +23479,7 @@ }, "R-07545": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-07545", @@ -23381,6 +23488,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -23403,6 +23511,7 @@ }, "R-07577": { "description": "If the VNF's ports connected to a unique network (internal or external)\nand the port's IP addresses are cloud assigned IP Addresses,\nall the IPv4 Addresses **MUST** be from\nthe same subnet and all the IPv6 Addresses **MUST** be from the\nsame subnet.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-07577", @@ -23411,6 +23520,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Items to Note", "sections": [ "Items to Note", @@ -23432,6 +23542,7 @@ }, "R-07617": { "description": "The VNF **MUST** log success and unsuccessful creation, removal, or\nchange to the inherent privilege level of users.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-07617", @@ -23440,6 +23551,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -23460,6 +23572,7 @@ }, "R-08134": { "description": "The xNF **MUST** conform to the NETCONF RFC 6241,\n\"NETCONF Configuration Protocol\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-08134", @@ -23468,6 +23581,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -23490,6 +23604,7 @@ }, "R-08312": { "description": "The xNF **MAY** use another option which is expected to include REST\ndelivery of binary encoded data sets.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-08312", @@ -23498,6 +23613,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Addressing and Delivery Protocol", "sections": [ "Addressing and Delivery Protocol", @@ -23519,6 +23635,7 @@ }, "R-08315": { "description": "The VNF **SHOULD** use redundant connection pooling to connect\nto any backend data source that can be switched between pools in an\nautomated/scripted fashion to ensure high availability of the connection\nto the data source.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-08315", @@ -23527,6 +23644,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Intelligent Transaction Distribution & Management", "sections": [ "Intelligent Transaction Distribution & Management", @@ -23547,6 +23665,7 @@ }, "R-08775": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::SecurityGroup``\nthat is applicable to one ``{vm-type}`` and more than one network (internal\nand/or external) Resource ID **SHOULD** use the naming convention\n\n* ``{vm-type}_security_group``\n\nwhere\n\n* ``{vm-type}`` is the vm-type", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-08775", @@ -23555,6 +23674,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Neutron::SecurityGroup", "sections": [ "OS::Neutron::SecurityGroup", @@ -23576,6 +23696,7 @@ }, "R-08975": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::SoftwareConfig``\nResource ID **MUST** contain the ``{vm-type}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-08975", @@ -23584,6 +23705,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Heat::SoftwareConfig", "sections": [ "OS::Heat::SoftwareConfig", @@ -23605,6 +23727,7 @@ }, "R-09467": { "description": "The VNF **MUST** utilize only NCSP standard compute flavors. [#4.5.1]_", + "docname": "Chapter4/Devops", "full_title": "", "hide_links": "", "id": "R-09467", @@ -23613,6 +23736,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Devops", "sections": [ "VNF Devops" @@ -23632,6 +23756,7 @@ }, "R-09811": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-09811", @@ -23640,6 +23765,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_index", "sections": [ "vf_module_index", @@ -23660,6 +23786,7 @@ }, "R-10087": { "description": "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**", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-10087", @@ -23668,6 +23795,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Package Contents", "sections": [ "VNF Package Contents", @@ -23689,6 +23817,7 @@ }, "R-10129": { "description": "The xNF **SHOULD** conform its YANG model to RFC 7223,\n\"A YANG Data Model for Interface Management\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-10129", @@ -23697,6 +23826,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -23719,6 +23849,7 @@ }, "R-10173": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-10173", @@ -23727,6 +23858,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -23749,6 +23881,7 @@ }, "R-10353": { "description": "The xNF **MUST** conform its YANG model to RFC 6244,\n\"An Architecture for Network Management Using NETCONF and YANG\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-10353", @@ -23757,6 +23890,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -23779,6 +23913,7 @@ }, "R-106240": { "description": "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.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-106240", @@ -23787,6 +23922,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -23807,6 +23943,7 @@ }, "R-10716": { "description": "The xNF **MUST** support parallel and simultaneous\nconfiguration of separate objects within itself.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-10716", @@ -23815,6 +23952,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -23837,6 +23975,7 @@ }, "R-10754": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-10754", @@ -23845,6 +23984,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VIP Assignment, External Networks, Supported by Automation", "sections": [ "VIP Assignment, External Networks, Supported by Automation", @@ -23866,6 +24006,7 @@ }, "R-10834": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-10834", @@ -23874,6 +24015,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "properties", "sections": [ "properties", @@ -23896,6 +24038,7 @@ }, "R-11041": { "description": "All parameters defined in a VNFs Nested YAML file\n**MUST** be passed in as properties of the resource calling\nthe nested yaml file.", + "docname": "Chapter5/Heat/ONAP Heat Template Constructs", "full_title": "", "hide_links": "", "id": "R-11041", @@ -23904,6 +24047,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Nested Heat Template Requirements", "sections": [ "Nested Heat Template Requirements", @@ -23925,6 +24069,7 @@ }, "R-11168": { "description": "A VNF's Heat Orchestration Template's Resource ID that is associated with\nan external network **MUST** include the ``{network-role}`` as part\nof the resource ID.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}", "full_title": "", "hide_links": "", "id": "R-11168", @@ -23933,6 +24078,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "{network-role}", "sections": [ "{network-role}" @@ -23952,6 +24098,7 @@ }, "R-11200": { "description": "A VNF's Cinder Volume Module, when it exists, **MUST** be 1:1\nwith a Base module or Incremental module.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-11200", @@ -23960,6 +24107,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -23980,6 +24128,7 @@ }, "R-11235": { "description": "The xNF **MUST** implement the protocol operation:\n``kill-session(session``- Force the termination of **session**.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-11235", @@ -23988,6 +24137,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -24004,12 +24154,13 @@ "title": "", "title_from_content": "", "type_name": "Requirement", - "updated": "", + "updated": "casablanca", "validated_by": "", "validation_mode": "" }, "R-11240": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-11240", @@ -24018,6 +24169,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Asynchronous and Synchronous Data Delivery", "sections": [ "Asynchronous and Synchronous Data Delivery", @@ -24039,6 +24191,7 @@ }, "R-11441": { "description": "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``", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-11441", @@ -24047,6 +24200,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "type", "sections": [ "type", @@ -24069,6 +24223,7 @@ }, "R-11499": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-11499", @@ -24077,6 +24232,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -24099,6 +24255,7 @@ }, "R-11690": { "description": "When a VNF's Heat Orchestration Template's Resource ID contains an\n``{index}`` value (e.g. multiple VMs of same ``{vm-type}``), the ``{index}``\n**MUST** start at zero and increment by one.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-11690", @@ -24107,6 +24264,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource IDs", "sections": [ "Resource IDs" @@ -24126,6 +24284,7 @@ }, "R-11790": { "description": "The VNF **MUST** support ONAP Controller's\n**Restart (stop/start or reboot)** command.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-11790", @@ -24134,6 +24293,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Virtual Function - Container Recovery Requirements", "sections": [ "Virtual Function - Container Recovery Requirements", @@ -24154,6 +24314,7 @@ }, "R-118669": { "description": "Login access (e.g., shell access) to the operating system layer, whether\ninteractive or as part of an automated process, **MUST** be through an\nencrypted protocol such as SSH or TLS.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-118669", @@ -24162,6 +24323,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -24182,6 +24344,7 @@ }, "R-120182": { "description": "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/module.git/files/VESEventRegistration_3_0>`.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-120182", @@ -24190,6 +24353,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Data Structure Specification of the Event Record", "sections": [ "Data Structure Specification of the Event Record", @@ -24210,6 +24374,7 @@ }, "R-12110": { "description": "The VNF **MUST NOT** use keys generated or derived from\npredictable functions or values, e.g., values considered predictable\ninclude user identity information, time of day, stored/transmitted data.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-12110", @@ -24218,6 +24383,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Data Protection Requirements", "sections": [ "VNF Data Protection Requirements", @@ -24238,6 +24404,7 @@ }, "R-12271": { "description": "The xNF **SHOULD** conform its YANG model to RFC 7223,\n\"IANA Interface Type YANG Module\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-12271", @@ -24246,6 +24413,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -24268,6 +24436,7 @@ }, "R-123044": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-123044", @@ -24276,6 +24445,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Data Structure Specification of the Event Record", "sections": [ "Data Structure Specification of the Event Record", @@ -24296,6 +24466,7 @@ }, "R-12467": { "description": "The VNF **MUST NOT** use compromised encryption algorithms.\nFor example, SHA, DSS, MD5, SHA-1 and Skipjack algorithms.\nAcceptable algorithms can be found in the NIST FIPS publications\n(https://csrc.nist.gov/publications/fips) and in the\nNIST Special Publications (https://csrc.nist.gov/publications/sp).", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-12467", @@ -24304,6 +24475,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Data Protection Requirements", "sections": [ "VNF Data Protection Requirements", @@ -24324,6 +24496,7 @@ }, "R-12538": { "description": "The VNF **SHOULD** support load balancing and discovery\nmechanisms in resource pools containing VNFC instances.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-12538", @@ -24332,6 +24505,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "System Resource Optimization", "sections": [ "System Resource Optimization", @@ -24352,6 +24526,7 @@ }, "R-12678": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-12678", @@ -24360,6 +24535,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Description", "sections": [ "Resource Description", @@ -24380,6 +24556,7 @@ }, "R-12706": { "description": "The xNF **MUST** support APPC/SDN-C ``QuiesceTraffic`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-12706", @@ -24388,6 +24565,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Lifecycle Management Related Commands", "sections": [ "Lifecycle Management Related Commands", @@ -24409,6 +24587,7 @@ }, "R-12709": { "description": "The VNFC **SHOULD** be independently deployed, configured,\nupgraded, scaled, monitored, and administered by ONAP.", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-12709", @@ -24417,6 +24596,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -24436,6 +24616,7 @@ }, "R-13151": { "description": "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.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-13151", @@ -24444,6 +24625,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Data Protection Requirements", "sections": [ "VNF Data Protection Requirements", @@ -24464,6 +24646,7 @@ }, "R-13194": { "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``environment_context`` **MUST NOT**\nbe enumerated in the Heat Orchestration Template's environment file.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-13194", @@ -24472,6 +24655,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "environment_context", "sections": [ "environment_context", @@ -24492,6 +24676,7 @@ }, "R-13196": { "description": "A VNF **MAY** be composed of zero to many Incremental Modules.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-13196", @@ -24500,6 +24685,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -24520,6 +24706,7 @@ }, "R-13344": { "description": "The VNF **MUST** log starting and stopping of security\nlogging.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-13344", @@ -24528,6 +24715,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -24548,6 +24736,7 @@ }, "R-13390": { "description": "The xNF provider **MUST** provide cookbooks to be loaded\non the appropriate Chef Server.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-13390", @@ -24556,6 +24745,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Management via Chef", "sections": [ "Configuration Management via Chef", @@ -24577,6 +24767,7 @@ }, "R-13613": { "description": "The VNF **MUST** provide clear measurements for licensing\npurposes to allow automated scale up/down by the management system.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-13613", @@ -24585,6 +24776,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Licensing Requirements", "sections": [ "Licensing Requirements", @@ -24605,6 +24797,7 @@ }, "R-13627": { "description": "The VNF **MUST** monitor API invocation patterns to detect\nanomalous access patterns that may represent fraudulent access or other\ntypes of attacks, or integrate with tools that implement anomaly and\nabuse detection.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-13627", @@ -24613,6 +24806,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -24633,6 +24827,7 @@ }, "R-13800": { "description": "The xNF **MUST** conform to the NETCONF RFC 5277,\n\"NETCONF Event Notification\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-13800", @@ -24641,6 +24836,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -24663,6 +24859,7 @@ }, "R-13841": { "description": "A VNF **MAY** have one or more ports connected to a unique\ninternal network. All VNF ports connected to the unique internal\nnetwork **MUST** have cloud assigned IP Addresses\nor **MUST** have statically assigned IP addresses.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-13841", @@ -24671,6 +24868,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Items to Note", "sections": [ "Items to Note", @@ -24692,6 +24890,7 @@ }, "R-14198": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::SecurityGroup`` that\nis applicable to one {vm-type} and one internal network Resource ID **SHOULD**\nuse the naming convention\n\n* ``{vm-type}_int_{network-role}_security_group``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{network-role}`` is the network-role", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-14198", @@ -24700,6 +24899,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Neutron::SecurityGroup", "sections": [ "OS::Neutron::SecurityGroup", @@ -24721,6 +24921,7 @@ }, "R-14447": { "description": "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 is the index", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-14447", @@ -24729,6 +24930,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::ServiceTemplate", "sections": [ "OS::ContrailV2::ServiceTemplate", @@ -24750,6 +24952,7 @@ }, "R-146931": { "description": "The xNF **MUST** report exactly one Measurement event per period\nper source name.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-146931", @@ -24758,6 +24961,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Reporting Frequency", "sections": [ "Reporting Frequency", @@ -24779,6 +24983,7 @@ }, "R-14853": { "description": "The VNF **MUST** respond to a \"move traffic\" [#4.5.2]_ command\nagainst a specific VNFC, moving all existing session elsewhere with\nminimal disruption if a VNF provides a load balancing function across\nmultiple instances of its VNFCs.\n\nNote: Individual VNF performance aspects (e.g., move duration or\ndisruption scope) may require further constraints.", + "docname": "Chapter4/Devops", "full_title": "", "hide_links": "", "id": "R-14853", @@ -24787,6 +24992,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Devops", "sections": [ "VNF Devops" @@ -24806,6 +25012,7 @@ }, "R-15189": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::ServerGroup`` Resource ID\n**MAY** use the naming convention\n\n* ``{vm-type}_RSG``\n\nor\n\n* ``{vm-type}_Server_Grp``\n\nor\n\n* ``{vm-type}_ServerGroup``\n\nor\n\n* ``{vm-type}_servergroup``", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-15189", @@ -24814,6 +25021,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Nova::ServerGroup", "sections": [ "OS::Nova::ServerGroup", @@ -24835,6 +25043,7 @@ }, "R-15287": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-15287", @@ -24843,6 +25052,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ "Property: fixed_ips, Map Property: subnet", @@ -24863,6 +25073,7 @@ }, "R-15325": { "description": "The VNF **MUST** log the field \"success/failure\" in the\nsecurity audit logs.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-15325", @@ -24871,6 +25082,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -24891,6 +25103,7 @@ }, "R-15480": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-15480", @@ -24899,6 +25112,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_name", "sections": [ "vf_module_name", @@ -24919,6 +25133,7 @@ }, "R-15671": { "description": "The VNF **MUST** provide access controls that allow the Operator\nto restrict access to VNF functions and data to authorized entities.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-15671", @@ -24927,6 +25142,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -24947,6 +25163,7 @@ }, "R-15837": { "description": "The following table defines the major TOSCA Types specified in\nETSI NFV-SOL001 standard draft. The VNFD provided by a VNF vendor\n**MUST** comply with the below definitions:", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-15837", @@ -24955,6 +25172,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "General", "sections": [ "General", @@ -24976,6 +25194,7 @@ }, "R-15884": { "description": "The VNF **MUST** include the field \"date\" in the Security alarms\n(where applicable and technically feasible).", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-15884", @@ -24984,6 +25203,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -25004,6 +25224,7 @@ }, "R-15885": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-15885", @@ -25012,6 +25233,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Chef Roles/Requirements", "sections": [ "Chef Roles/Requirements", @@ -25034,6 +25256,7 @@ }, "R-16039": { "description": "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.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-16039", @@ -25042,6 +25265,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Deployment Optimization", "sections": [ "Deployment Optimization", @@ -25062,6 +25286,7 @@ }, "R-16065": { "description": "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).", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-16065", @@ -25070,6 +25295,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Management via Ansible", "sections": [ "Configuration Management via Ansible", @@ -25091,6 +25317,7 @@ }, "R-16241": { "description": "A VNF's internal network **MUST** have one subnet.\nA VNF's internal network **MAY** have more than one subnet.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-16241", @@ -25099,6 +25326,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Internal Networks", "sections": [ "Internal Networks", @@ -25119,6 +25347,7 @@ }, "R-16437": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::ServiceTemplate``\nResource ID **MUST** contain the ``{vm-type}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-16437", @@ -25127,6 +25356,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::ServiceTemplate", "sections": [ "OS::ContrailV2::ServiceTemplate", @@ -25148,6 +25378,7 @@ }, "R-16447": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-16447", @@ -25156,6 +25387,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "resource ID", "sections": [ "resource ID", @@ -25178,6 +25410,7 @@ }, "R-16496": { "description": "The VNF **MUST** enable instantiating only the functionality that\nis needed for the decomposed VNF (e.g., if transcoding is not needed it\nshould not be instantiated).", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-16496", @@ -25186,6 +25419,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -25205,6 +25439,7 @@ }, "R-16560": { "description": "The VNF **SHOULD** conduct a resiliency impact assessment for all\ninter/intra-connectivity points in the VNF to provide an overall resiliency\nrating for the VNF to be incorporated into the software design and\ndevelopment of the VNF.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-16560", @@ -25213,6 +25448,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Monitoring & Dashboard", "sections": [ "Monitoring & Dashboard", @@ -25233,6 +25469,7 @@ }, "R-16576": { "description": "If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vnf_name`` is passed into a Nested YAML\nfile, the key/value pair name ``vnf_name`` **MUST NOT** change.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-16576", @@ -25241,6 +25478,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vnf_name", "sections": [ "vnf_name", @@ -25261,6 +25499,7 @@ }, "R-16777": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-16777", @@ -25269,6 +25508,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Management via Ansible", "sections": [ "Configuration Management via Ansible", @@ -25290,6 +25530,7 @@ }, "R-16875": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-16875", @@ -25298,6 +25539,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -25318,6 +25560,7 @@ }, "R-16968": { "description": "A VNF's Heat Orchestration Templates **MUST NOT** include heat\nresources to create external networks.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-16968", @@ -25326,6 +25569,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "External Networks", "sections": [ "External Networks", @@ -25346,6 +25590,7 @@ }, "R-17334": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::SecurityGroup``\nthat is applicable to one ``{vm-type}`` and one external network Resource ID\n**SHOULD** use the naming convention\n\n* ``{vm-type}_{network-role}_security_group``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``{network-role}`` is the network-role", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-17334", @@ -25354,6 +25599,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Neutron::SecurityGroup", "sections": [ "OS::Neutron::SecurityGroup", @@ -25375,6 +25621,7 @@ }, "R-17528": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Template Constructs", "full_title": "", "hide_links": "", "id": "R-17528", @@ -25383,6 +25630,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Nested Heat Template Requirements", "sections": [ "Nested Heat Template Requirements", @@ -25404,6 +25652,7 @@ }, "R-17624": { "description": "The PNF **MAY** support the optional parameters for Service\nConfiguration Parameters.\n\nNote: These are detailed in the Stage 5 PnP\n\nNote: These parameters are optional, and not all PNFs will support any\nor all of these parameters, it is up to the vendor and service provider\nto ascertain which ones are supported up to an including all of the ones\nthat have been defined. Note: It is expected that there will be a growing\nlist of supported configuration parameters in future releases of ONAP.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-17624", @@ -25412,6 +25661,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -25432,6 +25682,7 @@ }, "R-17852": { "description": "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.", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-17852", @@ -25440,6 +25691,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "General", "sections": [ "General", @@ -25461,6 +25713,7 @@ }, "R-18001": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-18001", @@ -25469,6 +25722,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Items to Note", "sections": [ "Items to Note", @@ -25490,6 +25744,7 @@ }, "R-18008": { "description": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``network`` parameter **MUST** be declared as type: ``string``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-18008", @@ -25498,6 +25753,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: network", "sections": [ "Property: network", @@ -25518,6 +25774,7 @@ }, "R-18202": { "description": "A VNF's Heat Orchestration Template's Resource\n``OS::Heat::MultipartMime``\nResource ID\n**MAY**\nuse the naming convention\n\n* ``{vm-type}_RMM``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``RMM`` signifies that it is the Resource Multipart Mime", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-18202", @@ -25526,6 +25783,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Heat::MultipartMime", "sections": [ "OS::Heat::MultipartMime", @@ -25547,6 +25805,7 @@ }, "R-18525": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-18525", @@ -25555,6 +25814,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Management via Chef", "sections": [ "Configuration Management via Chef", @@ -25576,6 +25836,7 @@ }, "R-18683": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names", "full_title": "", "hide_links": "", "id": "R-18683", @@ -25584,6 +25845,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OAM Management IP Addresses", "sections": [ "OAM Management IP Addresses", @@ -25605,6 +25867,7 @@ }, "R-18725": { "description": "The VNF **MUST** handle the restart of a single VNFC instance\nwithout requiring all VNFC instances to be restarted.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-18725", @@ -25613,6 +25876,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Application Resilient Error Handling", "sections": [ "Application Resilient Error Handling", @@ -25633,6 +25897,7 @@ }, "R-18733": { "description": "The xNF **MUST** implement the protocol operation:\n``discard-changes()`` - Revert the candidate configuration\ndata store to the running configuration.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-18733", @@ -25641,6 +25906,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -25657,12 +25923,13 @@ "title": "", "title_from_content": "", "type_name": "Requirement", - "updated": "", + "updated": "casablanca", "validated_by": "", "validation_mode": "" }, "R-18864": { "description": "The VNF **MUST NOT** use technologies that bypass virtualization\nlayers (such as SR-IOV) unless approved by the NCSP (e.g., if necessary\nto meet functional or performance requirements).", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-18864", @@ -25671,6 +25938,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -25690,6 +25958,7 @@ }, "R-19082": { "description": "The VNF **MUST** allow the Operator to disable or remove any security\ntesting tools or programs included in the VNF, e.g., password cracker,\nport scanner.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-19082", @@ -25698,6 +25967,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -25718,6 +25988,7 @@ }, "R-19366": { "description": "The xNF **MUST** support APPC ``ConfigModify`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-19366", @@ -25726,6 +25997,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Commands", "sections": [ "Configuration Commands", @@ -25747,6 +26019,7 @@ }, "R-19624": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-19624", @@ -25755,6 +26028,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "JSON", "sections": [ "JSON", @@ -25776,6 +26050,7 @@ }, "R-19756": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters", "full_title": "", "hide_links": "", "id": "R-19756", @@ -25784,6 +26059,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Interface Route Table Prefixes for Contrail InterfaceRoute Table", "sections": [ "Interface Route Table Prefixes for Contrail InterfaceRoute Table", @@ -25804,6 +26080,7 @@ }, "R-19768": { "description": "The VNF **SHOULD** support network segregation, i.e., separation of OA&M\ntraffic from signaling and payload traffic, using technologies such as\nVPN and VLAN.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-19768", @@ -25812,6 +26089,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -25832,6 +26110,7 @@ }, "R-19922": { "description": "The xNF **MUST** support APPC/SDN-C ``UpgradePrecheck`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-19922", @@ -25840,6 +26119,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Lifecycle Management Related Commands", "sections": [ "Lifecycle Management Related Commands", @@ -25861,6 +26141,7 @@ }, "R-20065": { "description": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::PortTuple``\nResource ID **MUST** contain the ``{vm-type}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-20065", @@ -25869,6 +26150,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::PortTuple", "sections": [ "OS::ContrailV2::PortTuple", @@ -25890,6 +26172,7 @@ }, "R-20204": { "description": "The VNF Package **MUST** include VM requirements via a Heat\ntemplate that provides the necessary data for network connections,\ninterface connections, internal and external to VNF.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-20204", @@ -25898,6 +26181,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Compute, Network, and Storage Requirements", "sections": [ "Compute, Network, and Storage Requirements", @@ -25918,6 +26202,7 @@ }, "R-20308": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-20308", @@ -25926,6 +26211,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "environment_context", "sections": [ "environment_context", @@ -25946,6 +26232,7 @@ }, "R-20319": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::CloudConfig``\nResource ID **MAY** use the naming convention\n\n* ``{vm-type}_RCC``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``RCC`` signifies that it is the Resource Cloud Config", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-20319", @@ -25954,6 +26241,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Heat::CloudConfig", "sections": [ "OS::Heat::CloudConfig", @@ -25975,6 +26263,7 @@ }, "R-20353": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-20353", @@ -25983,6 +26272,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -26005,6 +26295,7 @@ }, "R-20453": { "description": "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 the port on the vm-type\n attached to the network of ``{network-role}``", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-20453", @@ -26013,6 +26304,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Neutron::Port", "sections": [ "OS::Neutron::Port", @@ -26034,6 +26326,7 @@ }, "R-20547": { "description": "When an ONAP Volume Module Output Parameter is declared as an input\nparameter in a base or an incremental module Heat Orchestration\nTemplate, parameter constraints **MUST NOT** be declared.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-20547", @@ -26042,6 +26335,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP Volume Module Output Parameters", "sections": [ "ONAP Volume Module Output Parameters", @@ -26063,6 +26357,7 @@ }, "R-20741": { "description": "The xNF **MUST** support APPC/SDN-C ``Configure`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-20741", @@ -26071,6 +26366,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Commands", "sections": [ "Configuration Commands", @@ -26092,6 +26388,7 @@ }, "R-20856": { "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property\n``metadata`` key/value pair ``vnf_id`` parameter ``vnf_id`` **MUST NOT**\nbe enumerated in the Heat Orchestration Template's environment file.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-20856", @@ -26100,6 +26397,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vnf_id", "sections": [ "vnf_id", @@ -26120,6 +26418,7 @@ }, "R-20860": { "description": "The VNF **MUST** be agnostic to the underlying infrastructure\n(such as hardware, host OS, Hypervisor), any requirements should be\nprovided as specification to be fulfilled by any hardware.", + "docname": "Chapter4/Devops", "full_title": "", "hide_links": "", "id": "R-20860", @@ -26128,6 +26427,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Devops", "sections": [ "VNF Devops" @@ -26147,6 +26447,7 @@ }, "R-20947": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv4 Address on a sub-interface port attached to a\nsub-interface network Resource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_subint_{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 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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-20947", @@ -26155,6 +26456,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::InstanceIp", "sections": [ "OS::ContrailV2::InstanceIp", @@ -26176,6 +26478,7 @@ }, "R-20974": { "description": "At orchestration time, the VNF's Base Module **MUST**\nbe deployed first, prior to any incremental modules.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-20974", @@ -26184,6 +26487,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -26204,6 +26508,7 @@ }, "R-21210": { "description": "The VNF **MUST** implement the following input validation control\non APIs: Validate that any input file has a correct and valid\nMultipurpose Internet Mail Extensions (MIME) type. Input files\nshould be tested for spoofed MIME types.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-21210", @@ -26212,6 +26517,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF API Security Requirements", "sections": [ "VNF API Security Requirements", @@ -26232,6 +26538,7 @@ }, "R-21322": { "description": "The VNF provider **MUST** provide their testing scripts to support\ntesting as specified in ETSI NFV-SOL004 - Testing directory in CSAR", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-21322", @@ -26240,6 +26547,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Package Contents", "sections": [ "VNF Package Contents", @@ -26261,6 +26569,7 @@ }, "R-21330": { "description": "A VNF's Heat Orchestration Template's Resource property parameter that is\nassociated with external network **MUST** include the ``{network-role}``\nas part of the parameter name.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}", "full_title": "", "hide_links": "", "id": "R-21330", @@ -26269,6 +26578,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "{network-role}", "sections": [ "{network-role}" @@ -26288,6 +26598,7 @@ }, "R-21511": { "description": "A VNF's Heat Orchestration Template's use of ``{network-role}``\nin all Resource IDs **MUST** be the same case.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}", "full_title": "", "hide_links": "", "id": "R-21511", @@ -26296,6 +26607,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "{network-role}", "sections": [ "{network-role}" @@ -26315,6 +26627,7 @@ }, "R-21558": { "description": "The VNF **SHOULD** use intelligent routing by having knowledge\nof multiple downstream/upstream endpoints that are exposed to it, to\nensure there is no dependency on external services (such as load balancers)\nto switch to alternate endpoints.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-21558", @@ -26323,6 +26636,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Intelligent Transaction Distribution & Management", "sections": [ "Intelligent Transaction Distribution & Management", @@ -26343,6 +26657,7 @@ }, "R-21652": { "description": "The VNF **MUST** implement the following input validation\ncontrol: Check the size (length) of all input. Do not permit an amount\nof input so great that it would cause the VNF to fail. Where the input\nmay be a file, the VNF API must enforce a size limit.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-21652", @@ -26351,6 +26666,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF API Security Requirements", "sections": [ "VNF API Security Requirements", @@ -26371,6 +26687,7 @@ }, "R-21819": { "description": "The VNF **MUST** provide functionality that enables the Operator to comply\nwith requests for information from law enforcement and government agencies.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-21819", @@ -26379,6 +26696,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -26399,6 +26717,7 @@ }, "R-22059": { "description": "The VNF **MUST NOT** execute long running tasks (e.g., IO,\ndatabase, network operations, service calls) in a critical section\nof code, so as to minimize blocking of other operations and increase\nconcurrent throughput.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-22059", @@ -26407,6 +26726,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "System Resource Optimization", "sections": [ "System Resource Optimization", @@ -26427,6 +26747,7 @@ }, "R-22286": { "description": "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.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-22286", @@ -26435,6 +26756,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -26455,6 +26777,7 @@ }, "R-22288": { "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n``int_{network-role}_v6_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-22288", @@ -26463,6 +26786,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ "Property: fixed_ips, Map Property: subnet", @@ -26483,6 +26807,7 @@ }, "R-22346": { "description": "The VNF package MUST provide :doc:`VES Event Registration <../../../../vnfsdk/module.git/files/VESEventRegistration_3_0>`\nfor all VES events provided by that xNF.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-22346", @@ -26491,6 +26816,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Description", "sections": [ "Resource Description", @@ -26511,6 +26837,7 @@ }, "R-22367": { "description": "The VNF **MUST** support detection of malformed packets due to software\nmisconfiguration or software vulnerability, and generate an error to the\nsyslog console facility.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-22367", @@ -26519,6 +26846,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -26539,6 +26867,7 @@ }, "R-22441": { "description": "If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vf_module_index`` is passed into a\nNested YAML file, the key/value pair\n``vf_module_index`` **MUST NOT** change.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-22441", @@ -26547,6 +26876,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_index", "sections": [ "vf_module_index", @@ -26567,6 +26897,7 @@ }, "R-22589": { "description": "A VNF's Heat Orchestration Template parameter declaration\n**MAY** contain the attribute ``immutable:``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-22589", @@ -26575,6 +26906,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "immutable", "sections": [ "immutable", @@ -26597,6 +26929,7 @@ }, "R-22608": { "description": "When a VNF's Heat Orchestration Template's Base Module's output\nparameter is declared as an input parameter in an Incremental Module,\nthe parameter attribute ``constraints:`` **MUST NOT** be declared.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-22608", @@ -26605,6 +26938,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP Base Module Output Parameters", "sections": [ "ONAP Base Module Output Parameters", @@ -26626,6 +26960,7 @@ }, "R-22680": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-22680", @@ -26634,6 +26969,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -26654,6 +26990,7 @@ }, "R-22688": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-22688", @@ -26662,6 +26999,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Internal Networks", "sections": [ "Internal Networks", @@ -26682,6 +27020,7 @@ }, "R-22700": { "description": "The xNF **MUST** conform its YANG model to RFC 6470,\n\"NETCONF Base Notifications\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-22700", @@ -26690,6 +27029,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -26712,6 +27052,7 @@ }, "R-22838": { "description": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``name`` parameter **MUST NOT** be enumerated in the Heat Orchestration\nTemplate's Environment File.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-22838", @@ -26720,6 +27061,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Property: Name", "sections": [ "Property: Name", @@ -26740,6 +27082,7 @@ }, "R-22888": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-22888", @@ -26748,6 +27091,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -26768,6 +27112,7 @@ }, "R-22946": { "description": "The xNF **SHOULD** conform its YANG model to RFC 6536,\n\"NETCONF Access Control Model\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-22946", @@ -26776,6 +27121,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -26798,6 +27144,7 @@ }, "R-23035": { "description": "The VNF **MUST** be designed to scale horizontally (more\ninstances of a VNF or VNFC) and not vertically (moving the existing\ninstances to larger VMs or increasing the resources within a VM)\nto achieve effective utilization of cloud resources.", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-23035", @@ -26806,6 +27153,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -26825,6 +27173,7 @@ }, "R-23135": { "description": "The VNF **MUST**, if not integrated with the Operator's identity and\naccess management system, authenticate all access to protected GUIs, CLIs,\nand APIs.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-23135", @@ -26833,6 +27182,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -26853,6 +27203,7 @@ }, "R-231402": { "description": "The VNF **MUST** provide a means for the user to explicitly logout, thus\nending that session for that authenticated user.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-231402", @@ -26861,6 +27212,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -26881,6 +27233,7 @@ }, "R-23311": { "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Nova::Server`` property\n``availability_zone`` parameter **MUST** be declared as type: ``string``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-23311", @@ -26889,6 +27242,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: availability_zone", "sections": [ "Property: availability_zone", @@ -26909,6 +27263,7 @@ }, "R-23475": { "description": "VNFCs **SHOULD** be agnostic to the details of the Network Cloud\n(such as hardware, host OS, Hypervisor or container technology) and must run\non the Network Cloud with acknowledgement to the paradigm that the Network\nCloud will continue to rapidly evolve and the underlying components of\nthe platform will change regularly.", + "docname": "Chapter4/Devops", "full_title": "", "hide_links": "", "id": "R-23475", @@ -26917,6 +27272,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Devops", "sections": [ "VNF Devops" @@ -26936,6 +27292,7 @@ }, "R-23503": { "description": "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\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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-23503", @@ -26944,6 +27301,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -26964,6 +27322,7 @@ }, "R-23664": { "description": "A VNF's Heat Orchestration template **MUST**\ncontain the section ``resources:``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-23664", @@ -26972,6 +27331,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "resources", "sections": [ "resources", @@ -26993,6 +27353,7 @@ }, "R-23740": { "description": "The VNF **MUST** implement and enforce the principle of least privilege\non all protected interfaces.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-23740", @@ -27001,6 +27362,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -27021,6 +27383,7 @@ }, "R-23882": { "description": "The VNF **SHOULD** provide the capability for the Operator to run security\nvulnerability scans of the operating system and all application layers.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-23882", @@ -27029,6 +27392,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -27049,6 +27413,7 @@ }, "R-23957": { "description": "The VNF **MUST** include the field \"time\" in the Security alarms\n(where applicable and technically feasible).", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-23957", @@ -27057,6 +27422,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -27077,6 +27443,7 @@ }, "R-240760": { "description": "The VNF **MUST NOT** contain any backdoors.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-240760", @@ -27085,6 +27452,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -27105,14 +27473,16 @@ }, "R-24189": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-24189", "impacts": "", - "introduced": "", + "introduced": "casablanca", "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Playbook Requirements", "sections": [ "Ansible Playbook Requirements", @@ -27129,12 +27499,13 @@ "title": "", "title_from_content": "", "type_name": "Requirement", - "updated": "casablanca", + "updated": "", "validated_by": "", "validation_mode": "" }, "R-24269": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-24269", @@ -27143,6 +27514,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -27165,6 +27537,7 @@ }, "R-24359": { "description": "The VNF **MUST** provide the capability of testing the validity\nof a digital certificate by validating the date the certificate is being\nused is within the validity period for the certificate.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-24359", @@ -27173,6 +27546,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Cryptography Requirements", "sections": [ "VNF Cryptography Requirements", @@ -27193,6 +27567,7 @@ }, "R-24482": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-24482", @@ -27201,6 +27576,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Client Requirements", "sections": [ "Ansible Client Requirements", @@ -27223,6 +27599,7 @@ }, "R-24893": { "description": "A VNF's Heat Orchestration template's Environment File's\n**MAY** contain the ``event_sinks:`` section.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-24893", @@ -27231,6 +27608,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Environment File Format", "sections": [ "Environment File Format", @@ -27251,6 +27629,7 @@ }, "R-24997": { "description": "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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-24997", @@ -27259,6 +27638,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Nova::Keypair", "sections": [ "OS::Nova::Keypair", @@ -27280,6 +27660,7 @@ }, "R-25190": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Cinder::Volume``\n**SHOULD NOT** declare the property ``availability_zone``.", + "docname": "Chapter5/Heat/ONAP Heat Cinder Volumes", "full_title": "", "hide_links": "", "id": "R-25190", @@ -27288,6 +27669,7 @@ "keyword": "SHOULD NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Optional Property availability_zone", "sections": [ "Optional Property availability_zone", @@ -27308,6 +27690,7 @@ }, "R-25238": { "description": "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 $!", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-25238", @@ -27316,6 +27699,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -27338,6 +27722,7 @@ }, "R-25401": { "description": "The VNF **MUST** use asymmetric keys of at least 2048 bits in length.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-25401", @@ -27346,6 +27731,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Cryptography Requirements", "sections": [ "VNF Cryptography Requirements", @@ -27366,6 +27752,7 @@ }, "R-25547": { "description": "The VNF **MUST** log the field \"protocol\" in the security audit logs.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-25547", @@ -27374,6 +27761,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -27394,6 +27782,7 @@ }, "R-256267": { "description": "If SNMP is utilized, the VNF **MUST** support at least SNMPv3 with\nmessage authentication.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-256267", @@ -27402,6 +27791,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -27422,6 +27812,7 @@ }, "R-256347": { "description": "The PNF **MUST** support the Ansible protocol for a Service Configuration\nmessage exchange between the PNF and PNF Controller (in ONAP).\n\nNote: this exchange may be either Ansible, Chef, or NetConf depending on\nthe PNF. Note: The PNF Controller may be VF-C, APP-C or SDN-C based on the\nPNF and PNF domain. Note: for R3 (Casablanca) only Ansible is supported.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-256347", @@ -27430,6 +27821,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -27450,6 +27842,7 @@ }, "R-25720": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-25720", @@ -27458,6 +27851,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Neutron::Net", "sections": [ "OS::Neutron::Net", @@ -27479,6 +27873,7 @@ }, "R-257367": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-257367", @@ -27487,6 +27882,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Google Protocol Buffers (GPB)", "sections": [ "Google Protocol Buffers (GPB)", @@ -27508,6 +27904,7 @@ }, "R-258352": { "description": "The PNF **MUST** support & accept the provisioning of an ONAP contact IP\naddress (in IPv4 or IPv6 format).\n\nNote: For example, it a possibility is that an external EMS would configure\n& provision the ONAP contact IP address to the PNF (in either IPv4 or\nIPv6 format). For the PNF Plug and Play Use Case, this IP address is the\nservice provider's \"point of entry\" to the DCAE VES Listener.\n\nNote: different service provider's network architecture may also require\nspecial setup to allow an external PNF to contact the ONAP installation.\nFor example, in the AT&T network, a maintenance tunnel is used to access\nONAP.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-258352", @@ -27516,6 +27913,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -27536,6 +27934,7 @@ }, "R-258686": { "description": "The VNF application processes **MUST NOT** run as root.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-258686", @@ -27544,6 +27943,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -27564,6 +27964,7 @@ }, "R-25877": { "description": "A VNF's Heat Orchestration Template's parameter name\n(i.e., <param name>) **MUST** contain only alphanumeric\ncharacters and underscores ('_').", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-25877", @@ -27572,6 +27973,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "<param name>", "sections": [ "<param name>", @@ -27594,6 +27996,7 @@ }, "R-26115": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-26115", @@ -27602,6 +28005,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -27624,6 +28028,7 @@ }, "R-26124": { "description": "If a VNF Heat Orchestration Template parameter has a default value,\nit **MUST** be enumerated in the environment file.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-26124", @@ -27632,6 +28037,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "default", "sections": [ "default", @@ -27654,6 +28060,7 @@ }, "R-26351": { "description": "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 the port on the vm-type\n attached to the network of ``{network-role}``", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-26351", @@ -27662,6 +28069,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Neutron::Port", "sections": [ "OS::Neutron::Port", @@ -27683,6 +28091,7 @@ }, "R-26371": { "description": "The VNF **MUST** detect communication failure for inter VNFC\ninstance and intra/inter VNF and re-establish communication\nautomatically to maintain the VNF without manual intervention to\nprovide service continuity.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-26371", @@ -27691,6 +28100,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Application Resilient Error Handling", "sections": [ "Application Resilient Error Handling", @@ -27711,6 +28121,7 @@ }, "R-26506": { "description": "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_``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}", "full_title": "", "hide_links": "", "id": "R-26506", @@ -27719,6 +28130,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "{network-role}", "sections": [ "{network-role}" @@ -27738,6 +28150,7 @@ }, "R-26508": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-26508", @@ -27746,6 +28159,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -27768,6 +28182,7 @@ }, "R-26567": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-26567", @@ -27776,6 +28191,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Chef Roles/Requirements", "sections": [ "Chef Roles/Requirements", @@ -27792,12 +28208,13 @@ "title": "", "title_from_content": "", "type_name": "Requirement", - "updated": "", + "updated": "casablanca", "validated_by": "", "validation_mode": "" }, "R-26881": { "description": "The xNF provider **MUST** provide the binaries and images\nneeded to instantiate the xNF (xNF and VNFC images).", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-26881", @@ -27806,6 +28223,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Compute, Network, and Storage Requirements", "sections": [ "Compute, Network, and Storage Requirements", @@ -27826,6 +28244,7 @@ }, "R-26885": { "description": "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.", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-26885", @@ -27834,6 +28253,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Package Contents", "sections": [ "VNF Package Contents", @@ -27855,6 +28275,7 @@ }, "R-270358": { "description": "A VNF's Heat Orchestration Template's Cinder Volume Template **MUST**\ncontain either\n\n* An ``OS::Cinder::Volume`` resource\n* An ``OS::Heat::ResourceGroup`` resource that references a Nested YAML\n file that contains an ``OS::Cinder::Volume`` resource\n* A resource that defines the property ``type`` as a Nested YAML file\n (i.e., static nesting) and the Nested YAML contains\n an ``OS::Cinder::Volume`` resource", + "docname": "Chapter5/Heat/ONAP Heat Cinder Volumes", "full_title": "", "hide_links": "", "id": "R-270358", @@ -27863,6 +28284,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP Heat Cinder Volumes", "sections": [ "ONAP Heat Cinder Volumes" @@ -27882,6 +28304,7 @@ }, "R-27078": { "description": "A VNF's Heat Orchestration template **MUST** contain the\nsection ``heat_template_version:``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-27078", @@ -27890,6 +28313,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "heat_template_version", "sections": [ "heat_template_version", @@ -27911,6 +28335,7 @@ }, "R-27310": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-27310", @@ -27919,6 +28344,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Chef Roles/Requirements", "sections": [ "Chef Roles/Requirements", @@ -27941,6 +28367,7 @@ }, "R-27469": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is creating a *Reserve Port* with an IPv4 address Resource ID **MUST**\nuse 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}``", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-27469", @@ -27949,6 +28376,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Neutron::Port", "sections": [ "OS::Neutron::Port", @@ -27970,6 +28398,7 @@ }, "R-27511": { "description": "The VNF provider **MUST** provide the ability to scale\nup a VNF provider supplied product during growth and scale down a\nVNF provider supplied product during decline without \"real-time\"\nrestrictions based upon VNF provider permissions.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-27511", @@ -27978,6 +28407,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Licensing Requirements", "sections": [ "Licensing Requirements", @@ -27998,6 +28428,7 @@ }, "R-27711": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-27711", @@ -28006,6 +28437,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -28026,6 +28458,7 @@ }, "R-27818": { "description": "When the VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` is attaching to an internal network (per the\nONAP definition, see RRequirements 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\n ``OS::Nova::Server``\n * ``{network-role}`` is the {network-role} of the internal\n network\n * the value for ``{index}`` must start at zero (0) and increment by one", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-27818", @@ -28034,6 +28467,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -28054,6 +28488,7 @@ }, "R-27970": { "description": "When a VNF's Heat Orchestration Template's resource is associated with\nmore than one ``{vm-type}`` and/or more than one internal and/or external\nnetwork, the Resource ID **MAY** contain the term ``shared`` and/or **MAY**\ncontain text that identifies the VNF.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-27970", @@ -28062,6 +28497,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Resource IDs", "sections": [ "Resource IDs" @@ -28081,6 +28517,7 @@ }, "R-27995": { "description": "The VNF **SHOULD** include control loop mechanisms to notify\nthe consumer of the VNF of their exceeding SLA thresholds so the consumer\nis able to control its load against the VNF.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-27995", @@ -28089,6 +28526,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Intelligent Transaction Distribution & Management", "sections": [ "Intelligent Transaction Distribution & Management", @@ -28109,6 +28547,7 @@ }, "R-28168": { "description": "The VNF **SHOULD** use an appropriately configured logging\nlevel that can be changed dynamically, so as to not cause performance\ndegradation of the VNF due to excessive logging.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-28168", @@ -28117,6 +28556,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Monitoring & Dashboard", "sections": [ "Monitoring & Dashboard", @@ -28137,6 +28577,7 @@ }, "R-28189": { "description": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InterfaceRouteTable``\nResource ID **MAY** use the naming convention\n\n* ``{network-role}_RIRT``\n\nwhere\n\n* ``{network-role}`` is the network-role\n* ``RIRT`` signifies that it is the Resource Interface Route Table", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-28189", @@ -28145,6 +28586,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::InterfaceRouteTable", "sections": [ "OS::ContrailV2::InterfaceRouteTable", @@ -28166,6 +28608,7 @@ }, "R-28222": { "description": "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``", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters", "full_title": "", "hide_links": "", "id": "R-28222", @@ -28174,6 +28617,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Interface Route Table Prefixes for Contrail InterfaceRoute Table", "sections": [ "Interface Route Table Prefixes for Contrail InterfaceRoute Table", @@ -28194,6 +28638,7 @@ }, "R-283988": { "description": "The VNF, when publishing events, **MUST NOT** send information through\nextensible structures if the event specification has explicitly defined\nfields for that information.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-283988", @@ -28202,6 +28647,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Miscellaneous", "sections": [ "Miscellaneous", @@ -28223,6 +28669,7 @@ }, "R-284934": { "description": "If the PNF encounters an error authenticating, reaching the ONAP DCAE VES\nEvent listener or recieves an error response from sending the pnfRegistration\nVES Event, it **MAY** log the error, and notify the operator.\n\nNote: the design of how errors are logged, retrieved and reported\nwill be a vendor-specific architecture. Reporting faults and errors\nis also a vendor specific design. It is expected that the PNF shall\nhave a means to log an error and notify a user when a fault condition\noccurs in trying to contact ONAP, authenticate or send a pnfRegistration\nevent.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-284934", @@ -28231,6 +28678,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -28251,6 +28699,7 @@ }, "R-28545": { "description": "The xNF **MUST** conform its YANG model to RFC 6060,\n\"YANG - A Data Modeling Language for the Network Configuration\nProtocol (NETCONF)\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-28545", @@ -28259,6 +28708,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -28281,6 +28731,7 @@ }, "R-28756": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-28756", @@ -28289,6 +28740,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -28311,6 +28763,7 @@ }, "R-28795": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-28795", @@ -28319,6 +28772,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -28339,6 +28793,7 @@ }, "R-28980": { "description": "A VNF's incremental module **MAY** be used for initial VNF deployment only.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-28980", @@ -28347,6 +28802,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -28367,6 +28823,7 @@ }, "R-29324": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-29324", @@ -28375,6 +28832,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -28391,12 +28849,13 @@ "title": "", "title_from_content": "", "type_name": "Requirement", - "updated": "", + "updated": "casablanca", "validated_by": "", "validation_mode": "" }, "R-29488": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-29488", @@ -28405,6 +28864,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -28421,12 +28881,13 @@ "title": "", "title_from_content": "", "type_name": "Requirement", - "updated": "", + "updated": "casablanca", "validated_by": "", "validation_mode": "" }, "R-29495": { "description": "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).", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-29495", @@ -28435,6 +28896,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -28457,6 +28919,7 @@ }, "R-29705": { "description": "The VNF **MUST** restrict changing the criticality level of a\nsystem security alarm to users with administrative privileges.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-29705", @@ -28465,6 +28928,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -28485,6 +28949,7 @@ }, "R-29751": { "description": "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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-29751", @@ -28493,6 +28958,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Nova::Server", "sections": [ "OS::Nova::Server", @@ -28514,6 +28980,7 @@ }, "R-29760": { "description": "The VNFC **MUST** be installed on non-root file systems,\nunless software is specifically included with the operating system\ndistribution of the guest image.", + "docname": "Chapter4/Devops", "full_title": "", "hide_links": "", "id": "R-29760", @@ -28522,6 +28989,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Devops", "sections": [ "VNF Devops" @@ -28541,6 +29009,7 @@ }, "R-29765": { "description": "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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-29765", @@ -28549,6 +29018,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -28569,6 +29039,7 @@ }, "R-29872": { "description": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``network``\nparameter **MUST NOT** be enumerated in the Heat Orchestration\nTemplate's Environment File.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-29872", @@ -28577,6 +29048,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Property: network", "sections": [ "Property: network", @@ -28597,6 +29069,7 @@ }, "R-29977": { "description": "The VNF **MUST** provide the capability of testing the validity\nof a digital certificate by validating the CA signature on the certificate.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-29977", @@ -28605,6 +29078,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Cryptography Requirements", "sections": [ "VNF Cryptography Requirements", @@ -28625,6 +29099,7 @@ }, "R-30005": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::SecurityGroup`` that\nis applicable to more than one ``{vm-type}`` and more than one network\n(internal and/or external) Resource ID **MAY**\nuse the naming convention\n\n* ``shared_security_group``\n\nor\n\n* ``{vnf-type}_security_group``\n\nwhere\n\n* ``{vnf-type}`` describes the VNF", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-30005", @@ -28633,6 +29108,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Neutron::SecurityGroup", "sections": [ "OS::Neutron::SecurityGroup", @@ -28654,6 +29130,7 @@ }, "R-30278": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-30278", @@ -28662,6 +29139,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Management via NETCONF/YANG", "sections": [ "Configuration Management via NETCONF/YANG", @@ -28683,6 +29161,7 @@ }, "R-303569": { "description": "The VNF **MUST** log the Source IP address in the security audit logs.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-303569", @@ -28691,6 +29170,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -28711,6 +29191,7 @@ }, "R-30395": { "description": "A VNF's Cinder Volume Module **MAY** utilize nested heat.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-30395", @@ -28719,6 +29200,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Nested Heat Orchestration Templates Overview", "sections": [ "Nested Heat Orchestration Templates Overview", @@ -28739,6 +29221,7 @@ }, "R-304011": { "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's\n\n* Resource ID\n* property ``image`` parameter name\n* property ``flavor`` parameter name\n* property ``name`` parameter name\n\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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-304011", @@ -28747,6 +29230,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource: OS::Nova::Server - Parameters", "sections": [ "Resource: OS::Nova::Server - Parameters" @@ -28766,6 +29250,7 @@ }, "R-30650": { "description": "The VNF **MUST** utilize cloud provided infrastructure and\nVNFs (e.g., virtualized Local Load Balancer) as part of the VNF so\nthat the cloud can manage and provide a consistent service resiliency\nand methods across all VNF's.", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-30650", @@ -28774,6 +29259,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -28793,6 +29279,7 @@ }, "R-30654": { "description": "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).", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-30654", @@ -28801,6 +29288,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Chef Roles/Requirements", "sections": [ "Chef Roles/Requirements", @@ -28823,6 +29311,7 @@ }, "R-30753": { "description": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::NetworkIpam``\nResource ID\n**MUST**\ncontain the ``{network-role}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-30753", @@ -28831,6 +29320,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::NetworkIpam", "sections": [ "OS::ContrailV2::NetworkIpam", @@ -28852,6 +29342,7 @@ }, "R-30804": { "description": "A VNF's Heat Orchestration Template's Resource\n``OS::Heat::MultipartMime``\nResource ID\n**MUST**\ncontain the ``{vm-type}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-30804", @@ -28860,6 +29351,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Heat::MultipartMime", "sections": [ "OS::Heat::MultipartMime", @@ -28881,6 +29373,7 @@ }, "R-30932": { "description": "The VNF **MUST** log successful and unsuccessful access to VNF\nresources, including data.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-30932", @@ -28889,6 +29382,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -28909,6 +29403,7 @@ }, "R-31141": { "description": "VNF Heat Orchestration Template's Cinder Volume Module's Environment File\n**MUST** be named identical to the VNF Heat Orchestration Template's\nCinder Volume Module with ``.y[a]ml`` replaced with ``.env``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-31141", @@ -28917,6 +29412,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Cinder Volume Modules", "sections": [ "Cinder Volume Modules", @@ -28938,6 +29434,7 @@ }, "R-31614": { "description": "The VNF **MUST** log the field \"event type\" in the security audit\nlogs.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-31614", @@ -28946,6 +29443,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -28966,6 +29464,7 @@ }, "R-31809": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-31809", @@ -28974,6 +29473,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "REST APIs", "sections": [ "REST APIs", @@ -28995,6 +29495,7 @@ }, "R-32025": { "description": "When a VNF creates two or more internal networks, each internal\nnetwork **MUST** be assigned a unique ``{network-role}`` in the context\nof the VNF for use in the VNF's Heat Orchestration Template.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-32025", @@ -29003,6 +29504,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Internal Networks", "sections": [ "Internal Networks", @@ -29023,6 +29525,7 @@ }, "R-32094": { "description": "A VNF's Heat Orchestration Template parameter declaration **MAY**\ncontain the attribute ``label:``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-32094", @@ -29031,6 +29534,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "label", "sections": [ "label", @@ -29053,6 +29557,7 @@ }, "R-32155": { "description": "The VNFD provided by VNF vendor may use the below described TOSCA\ninterface types. An on-boarding entity (ONAP SDC) **MUST** support them.\n\n **tosca.interfaces.nfv.vnf.lifecycle.Nfv** supports LCM operations", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-32155", @@ -29061,6 +29566,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Interface Types", "sections": [ "Interface Types", @@ -29082,6 +29588,7 @@ }, "R-32217": { "description": "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]_.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-32217", @@ -29090,6 +29597,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Client Requirements", "sections": [ "Ansible Client Requirements", @@ -29112,6 +29620,7 @@ }, "R-32394": { "description": "A VNF's Heat Orchestration Template's use of ``{vm-type}`` in all Resource\nproperty parameter names **MUST** be the same case.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}", "full_title": "", "hide_links": "", "id": "R-32394", @@ -29120,6 +29629,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "{vm-type}", "sections": [ "{vm-type}" @@ -29139,6 +29649,7 @@ }, "R-32408": { "description": "If a VNF's Heat Orchestration Template property ``name``\nfor a non ``OS::Nova::Server`` resource uses the intrinsic function\n``str_replace`` in conjunction with the ONAP\nsupplied metadata parameter ``vnf_name`` and does not create\na unique value, additional data **MUST** be used in the\n``str_replace`` to create a unique value, such as ``OS::stack_name``\nand/or the ``OS::Heat::ResourceGroup`` ``index``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource Property", "full_title": "", "hide_links": "", "id": "R-32408", @@ -29147,6 +29658,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Property \u201cname\u201d", "sections": [ "Resource Property \u201cname\u201d" @@ -29166,6 +29678,7 @@ }, "R-32557": { "description": "A VNF's Heat Orchestration Template parameter declaration **MAY**\ncontain the attribute ``hidden:``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-32557", @@ -29174,6 +29687,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "hidden", "sections": [ "hidden", @@ -29196,6 +29710,7 @@ }, "R-32636": { "description": "The VNF **MUST** support API-based monitoring to take care of\nthe scenarios where the control interfaces are not exposed, or are\noptimized and proprietary in nature.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-32636", @@ -29204,6 +29719,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -29224,6 +29740,7 @@ }, "R-32641": { "description": "The VNF **MUST** provide the capability to encrypt data on\nnon-volatile memory.Non-volative memory is storage that is\ncapable of retaining data without electrical power, e.g.\nComplementary metal-oxide-semiconductor (CMOS) or hard drives.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-32641", @@ -29232,6 +29749,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Data Protection Requirements", "sections": [ "VNF Data Protection Requirements", @@ -29252,6 +29770,7 @@ }, "R-32695": { "description": "The VNF **MUST** provide the ability to modify the number of\nretries, the time between retries and the behavior/action taken after\nthe retries have been exhausted for exception handling to allow the\nNCSP to control that behavior, where the interface and/or functional\nspecification allows for altering behaviour.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-32695", @@ -29260,6 +29779,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Application Resilient Error Handling", "sections": [ "Application Resilient Error Handling", @@ -29280,6 +29800,7 @@ }, "R-328086": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-328086", @@ -29288,6 +29809,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Lifecycle Management Related Commands", "sections": [ "Lifecycle Management Related Commands", @@ -29309,6 +29831,7 @@ }, "R-32981": { "description": "The xNF **MUST** support APPC ``ConfigBackup`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-32981", @@ -29317,6 +29840,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Commands", "sections": [ "Configuration Commands", @@ -29338,6 +29862,7 @@ }, "R-33132": { "description": "A VNF's Heat Orchestration Template **MAY** be\n 1.) Base Module Heat Orchestration Template (also referred to as a\n Base Module),\n 2.) Incremental Module Heat Orchestration Template (referred to as\n an Incremental Module), or\n 3.) a Cinder Volume Module Heat Orchestration Template (referred to as\n Cinder Volume Module).", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-33132", @@ -29346,6 +29871,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -29366,6 +29892,7 @@ }, "R-332680": { "description": "The xNF **SHOULD** deliver all syslog messages to the VES Collector per the\nspecifications in Monitoring and Management chapter.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-332680", @@ -29374,6 +29901,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Asynchronous and Synchronous Data Delivery", "sections": [ "Asynchronous and Synchronous Data Delivery", @@ -29395,6 +29923,7 @@ }, "R-33280": { "description": "The xNF **MUST NOT** use any instance specific parameters\nin a playbook.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-33280", @@ -29403,6 +29932,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Playbook Requirements", "sections": [ "Ansible Playbook Requirements", @@ -29425,6 +29955,7 @@ }, "R-33488": { "description": "The VNF **MUST** protect against all denial of service\nattacks, both volumetric and non-volumetric, or integrate with external\ndenial of service protection tools.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-33488", @@ -29433,6 +29964,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -29453,6 +29985,7 @@ }, "R-33694": { "description": "The xNF Package **MUST** include documentation to when applicable,\nprovide calculators needed to convert raw data into appropriate reporting\nartifacts.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-33694", @@ -29461,6 +29994,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -29481,6 +30015,7 @@ }, "R-33846": { "description": "The VNF **MUST** install the NCSP required software on Guest OS\nimages when not using the NCSP provided Guest OS images. [#4.5.1]_", + "docname": "Chapter4/Devops", "full_title": "", "hide_links": "", "id": "R-33846", @@ -29489,6 +30024,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Devops", "sections": [ "VNF Devops" @@ -29508,6 +30044,7 @@ }, "R-33904": { "description": "The xNF Package **MUST** include documentation for each KPI, provide\nlower and upper limits.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-33904", @@ -29516,6 +30053,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -29536,6 +30074,7 @@ }, "R-33946": { "description": "The xNF **MUST** conform to the NETCONF RFC 4741,\n\"NETCONF Configuration Protocol\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-33946", @@ -29544,6 +30083,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -29566,6 +30106,7 @@ }, "R-33955": { "description": "The xNF **SHOULD** conform its YANG model to RFC 6991,\n\"Common YANG Data Types\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-33955", @@ -29574,6 +30115,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -29596,6 +30138,7 @@ }, "R-34037": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-34037", @@ -29604,6 +30147,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -29624,6 +30168,7 @@ }, "R-34055": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-34055", @@ -29632,6 +30177,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "workload_context", "sections": [ "workload_context", @@ -29652,6 +30198,7 @@ }, "R-343842": { "description": "The VNF **MUST**, after a successful login at command line or a GUI,\ndisplay the last valid login date and time and the number of unsuccessful\nattempts since then made with that user's ID. This requirement is only\napplicable when the user account is defined locally in the VNF.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-343842", @@ -29660,6 +30207,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -29680,6 +30228,7 @@ }, "R-34484": { "description": "The VNF **SHOULD** create a single component VNF for VNFCs\nthat can be used by other VNFs.", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-34484", @@ -29688,6 +30237,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -29707,6 +30257,7 @@ }, "R-34552": { "description": "The VNF **MUST** be implemented so that it is not vulnerable to OWASP\nTop 10 web application security risks.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-34552", @@ -29715,6 +30266,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -29735,6 +30287,7 @@ }, "R-34660": { "description": "The xNF **MUST** use the RESTCONF/NETCONF framework used by\nthe ONAP configuration subsystem for synchronous communication.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-34660", @@ -29743,6 +30296,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Asynchronous and Synchronous Data Delivery", "sections": [ "Asynchronous and Synchronous Data Delivery", @@ -29764,6 +30318,7 @@ }, "R-34957": { "description": "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.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-34957", @@ -29772,6 +30327,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Monitoring & Dashboard", "sections": [ "Monitoring & Dashboard", @@ -29788,11 +30344,11 @@ "type_name": "Requirement", "updated": "", "validated_by": "", - "validation_mode": "" }, "R-35291": { "description": "The VNF **MUST** support the ability to failover a VNFC\nautomatically to other geographically redundant sites if not\ndeployed active-active to increase the overall resiliency of the VNF.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-35291", @@ -29801,6 +30357,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "All Layer Redundancy", "sections": [ "All Layer Redundancy", @@ -29821,6 +30378,7 @@ }, "R-35401": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-35401", @@ -29829,6 +30387,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Client Requirements", "sections": [ "Ansible Client Requirements", @@ -29851,6 +30410,7 @@ }, "R-35414": { "description": "A VNF Heat Orchestration's template **MUST** contain the\nsection ``parameters:``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-35414", @@ -29859,6 +30419,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "parameters", "sections": [ "parameters", @@ -29880,6 +30441,7 @@ }, "R-35532": { "description": "The VNF **SHOULD** release and clear all shared assets (memory,\ndatabase operations, connections, locks, etc.) as soon as possible,\nespecially before long running sync and asynchronous operations, so as\nto not prevent use of these assets by other entities.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-35532", @@ -29888,6 +30450,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "System Resource Optimization", "sections": [ "System Resource Optimization", @@ -29908,6 +30471,7 @@ }, "R-35666": { "description": "If a VNF has an internal network, the VNF Heat Orchestration Template\n**MUST** include the heat resources to create the internal network.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-35666", @@ -29916,6 +30480,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Internal Networks", "sections": [ "Internal Networks", @@ -29936,6 +30501,7 @@ }, "R-35735": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-35735", @@ -29944,6 +30510,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VIP Assignment, External Networks, Supported by Automation", "sections": [ "VIP Assignment, External Networks, Supported by Automation", @@ -29965,6 +30532,7 @@ }, "R-35851": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-35851", @@ -29973,6 +30541,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Compute, Network, and Storage Requirements", "sections": [ "Compute, Network, and Storage Requirements", @@ -29993,6 +30562,7 @@ }, "R-35854": { "description": "The VNF Descriptor (VNFD) provided by VNF vendor **MUST** comply with\nTOSCA/YAML based Service template for VNF descriptor specified in\nETSI NFV-SOL001.\n\n**Note**: As the ETSI NFV-SOL001 is work in progress the below tables\nsummarizes the TOSCA definitions agreed to be part of current version\nof NFV profile and that VNFD MUST comply with in ONAP Release 2+\nRequirements.", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-35854", @@ -30001,6 +30571,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "General", "sections": [ "General", @@ -30022,6 +30593,7 @@ }, "R-35960": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-35960", @@ -30030,6 +30602,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -30050,6 +30623,7 @@ }, "R-36280": { "description": "The xNF provider **MUST** provide documentation describing\nxNF Functional Capabilities that are utilized to operationalize the\nxNF and compose complex services.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-36280", @@ -30058,6 +30632,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Description", "sections": [ "Resource Description", @@ -30078,6 +30653,7 @@ }, "R-36542": { "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vnf_name`` parameter\n``vnf_name`` **MUST NOT**\nbe enumerated in the Heat Orchestration Template's environment file.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-36542", @@ -30086,6 +30662,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vnf_name", "sections": [ "vnf_name", @@ -30106,6 +30683,7 @@ }, "R-36582": { "description": "A VNF's Base Module **MAY** utilize nested heat.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-36582", @@ -30114,6 +30692,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Nested Heat Orchestration Templates Overview", "sections": [ "Nested Heat Orchestration Templates Overview", @@ -30134,6 +30713,7 @@ }, "R-36687": { "description": "A VNF's Heat Orchestration Template's ``{vm-type}`` case in Resource\nproperty parameter names **SHOULD** match the case of ``{vm-type}``\nin Resource IDs and vice versa.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}", "full_title": "", "hide_links": "", "id": "R-36687", @@ -30142,6 +30722,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "{vm-type}", "sections": [ "{vm-type}" @@ -30161,6 +30742,7 @@ }, "R-36772": { "description": "A VNF's Heat Orchestration Template's parameter **MUST** include the\nattribute ``type:``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-36772", @@ -30169,6 +30751,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "type", "sections": [ "type", @@ -30191,6 +30774,7 @@ }, "R-36792": { "description": "The VNF **MUST** automatically retry/resubmit failed requests\nmade by the software to its downstream system to increase the success rate.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-36792", @@ -30199,6 +30783,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Application Resilient Error Handling", "sections": [ "Application Resilient Error Handling", @@ -30219,6 +30804,7 @@ }, "R-36843": { "description": "The VNF **MUST** support the ability of the VNFC to be deployable\nin multi-zoned cloud sites to allow for site support in the event of cloud\nzone failure or upgrades.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-36843", @@ -30227,6 +30813,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "All Layer Redundancy", "sections": [ "All Layer Redundancy", @@ -30247,6 +30834,7 @@ }, "R-36982": { "description": "A VNF's Heat Orchestration template **MAY** contain the ``outputs:``\nsection.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-36982", @@ -30255,6 +30843,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "outputs", "sections": [ "outputs", @@ -30276,6 +30865,7 @@ }, "R-37028": { "description": "A VNF **MUST** be composed of one Base Module", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-37028", @@ -30284,6 +30874,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -30304,6 +30895,7 @@ }, "R-37039": { "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vf_module_index`` parameter\n``vf_module_index`` **MUST NOT**\nbe enumerated in the Heat Orchestration Template's environment file.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-37039", @@ -30312,6 +30904,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_index", "sections": [ "vf_module_index", @@ -30332,6 +30925,7 @@ }, "R-37437": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-37437", @@ -30340,6 +30934,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "vnf_id", "sections": [ "vnf_id", @@ -30360,6 +30955,7 @@ }, "R-37692": { "description": "The VNFC **MUST** provide API versioning to allow for\nindependent upgrades of VNFC.", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-37692", @@ -30368,6 +30964,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -30387,6 +30984,7 @@ }, "R-378131": { "description": "(Error Case) - If an error is encountered by the PNF during a\nService Configuration exchange with ONAP, the PNF **MAY** log the\nerror and notify an operator.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-378131", @@ -30395,6 +30993,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -30415,6 +31014,7 @@ }, "R-37929": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-37929", @@ -30423,6 +31023,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Chef Roles/Requirements", "sections": [ "Chef Roles/Requirements", @@ -30445,6 +31046,7 @@ }, "R-38001": { "description": "The VNF **MUST** support ONAP Controller's **Rebuild** command.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-38001", @@ -30453,6 +31055,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Virtual Function - Container Recovery Requirements", "sections": [ "Virtual Function - Container Recovery Requirements", @@ -30473,6 +31076,7 @@ }, "R-38236": { "description": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n**MUST** be declared type ``string``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-38236", @@ -30481,6 +31085,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ "Property: fixed_ips, Map Property: subnet", @@ -30498,8 +31103,10 @@ "updated": "casablanca", "validated_by": "", "validation_mode": "static" - }, "R-384337": { + }, + "R-384337": { "description": "The VNF documentation **MUST** contain a list of the files within the VNF\npackage that are static during the VNF's runtime.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-384337", @@ -30508,6 +31115,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Description", "sections": [ "Resource Description", @@ -30528,6 +31136,7 @@ }, "R-38474": { "description": "A VNF's Base Module **MUST** have a corresponding Environment File.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-38474", @@ -30536,6 +31145,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -30556,6 +31166,7 @@ }, "R-39067": { "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vf_module_name`` parameter **MUST** be\ndeclared as ``vf_module_name`` and the parameter **MUST**\nbe defined as type: ``string``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-39067", @@ -30564,6 +31175,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_name", "sections": [ "vf_module_name", @@ -30584,6 +31196,7 @@ }, "R-39349": { "description": "A VNF Heat Orchestration Template **MUST NOT** be designed to utilize the\nOpenStack ``heat stack-update`` command for scaling (growth/de-growth).", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-39349", @@ -30592,6 +31205,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Support of heat stack update", "sections": [ "Support of heat stack update", @@ -30612,6 +31226,7 @@ }, "R-39402": { "description": "A VNF's Heat Orchestration Template **MUST** contain the\nsection ``description:``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-39402", @@ -30620,6 +31235,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "description", "sections": [ "description", @@ -30641,6 +31257,7 @@ }, "R-39562": { "description": "The VNF **MUST** disable unnecessary or vulnerable cgi-bin programs.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-39562", @@ -30649,6 +31266,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -30669,6 +31287,7 @@ }, "R-39604": { "description": "The VNF **MUST** provide the capability of testing the\nvalidity of a digital certificate by checking the Certificate Revocation\nList (CRL) for the certificates of that type to ensure that the\ncertificate has not been revoked.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-39604", @@ -30677,6 +31296,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Cryptography Requirements", "sections": [ "VNF Cryptography Requirements", @@ -30697,6 +31317,7 @@ }, "R-39650": { "description": "The VNF **SHOULD** provide the ability to test incremental\ngrowth of the VNF.", + "docname": "Chapter4/Devops", "full_title": "", "hide_links": "", "id": "R-39650", @@ -30705,6 +31326,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Devops", "sections": [ "VNF Devops" @@ -30724,6 +31346,7 @@ }, "R-39841": { "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_{network-role}_ip_{index}``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-39841", @@ -30732,6 +31355,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -30752,6 +31376,7 @@ }, "R-40293": { "description": "The xNF **MUST** make available playbooks that conform\nto the ONAP requirement.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-40293", @@ -30760,6 +31385,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Playbook Requirements", "sections": [ "Ansible Playbook Requirements", @@ -30782,6 +31408,7 @@ }, "R-40499": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-40499", @@ -30790,6 +31417,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: flavor", "sections": [ "Property: flavor", @@ -30810,6 +31438,7 @@ }, "R-40518": { "description": "A VNF's Heat Orchestration Template's parameter defined\nin a non-nested YAML file as type\n``string`` **MAY** have a parameter constraint defined.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-40518", @@ -30818,6 +31447,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "constraints", "sections": [ "constraints", @@ -30840,6 +31470,7 @@ }, "R-40551": { "description": "A VNF's Heat Orchestration Template's Nested YAML files **MAY**\n(or **MAY NOT**) contain the section ``resources:``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-40551", @@ -30848,6 +31479,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "resources", "sections": [ "resources", @@ -30869,6 +31501,7 @@ }, "R-40813": { "description": "The VNF **SHOULD** support the use of virtual trusted platform\nmodule.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-40813", @@ -30877,6 +31510,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -30897,6 +31531,7 @@ }, "R-40820": { "description": "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**", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-40820", @@ -30905,6 +31540,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Package Contents", "sections": [ "VNF Package Contents", @@ -30926,6 +31562,7 @@ }, "R-40827": { "description": "The xNF provider **MUST** enumerate all of the open\nsource licenses their xNF(s) incorporate.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-40827", @@ -30934,6 +31571,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Licensing Requirements", "sections": [ "Licensing Requirements", @@ -30954,6 +31592,7 @@ }, "R-408813": { "description": "The VNF, when publishing events, **MUST** pass all information it is\nable to collect even if the information field is identified as optional.\nHowever, if the data cannot be collected, then optional fields can be\nomitted.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-408813", @@ -30962,6 +31601,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Miscellaneous", "sections": [ "Miscellaneous", @@ -30983,6 +31623,7 @@ }, "R-40899": { "description": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``string``, a parameter\n**MUST** be delcared for\neach ``OS::Nova::Server`` resource associated with the ``{vm-type}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-40899", @@ -30991,6 +31632,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: Name", "sections": [ "Property: Name", @@ -31011,6 +31653,7 @@ }, "R-40971": { "description": "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\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\n * the value for ``{index}`` must start at zero (0) and increment by one", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-40971", @@ -31019,6 +31662,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -31039,6 +31683,7 @@ }, "R-41159": { "description": "The VNF **MUST** deliver any and all functionality from any\nVNFC in the pool (where pooling is the most suitable solution). The\nVNFC pool member should be transparent to the client. Upstream and\ndownstream clients should only recognize the function being performed,\nnot the member performing it.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-41159", @@ -31047,6 +31692,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "System Resource Optimization", "sections": [ "System Resource Optimization", @@ -31067,6 +31713,7 @@ }, "R-41215": { "description": "The VNF **MAY** have zero to many \"incremental\" modules.", + "docname": "Chapter4/Modularity", "full_title": "", "hide_links": "", "id": "R-41215", @@ -31075,6 +31722,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -31095,6 +31743,7 @@ }, "R-41252": { "description": "The VNF **MUST** support the capability of online storage of\nsecurity audit logs.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-41252", @@ -31103,6 +31752,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -31123,6 +31773,7 @@ }, "R-41430": { "description": "The xNF **MUST** support APPC/SDN-C ``HealthCheck`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-41430", @@ -31131,6 +31782,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "HealthCheck and Failure Related Commands", "sections": [ "HealthCheck and Failure Related Commands", @@ -31152,6 +31804,7 @@ }, "R-41492": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-41492", @@ -31160,6 +31813,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VIP Assignment, External Networks, Supported by Automation", "sections": [ "VIP Assignment, External Networks, Supported by Automation", @@ -31181,6 +31835,7 @@ }, "R-41825": { "description": "The VNF **MUST** activate security alarms automatically when\na configurable number of consecutive unsuccessful login attempts\nis reached.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-41825", @@ -31189,6 +31844,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -31209,6 +31865,7 @@ }, "R-41829": { "description": "The xNF **MUST** be able to specify the granularity of the\nlock via a restricted or full XPath expression.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-41829", @@ -31217,6 +31874,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -31239,6 +31897,7 @@ }, "R-41888": { "description": "A VNF's Heat Orchestration Template intrinsic function\n``get_file`` **MUST NOT** utilize URL-based file retrieval.", + "docname": "Chapter5/Heat/ONAP Heat Template Constructs", "full_title": "", "hide_links": "", "id": "R-41888", @@ -31247,6 +31906,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Heat Files Support (get_file)", "sections": [ "Heat Files Support (get_file)", @@ -31267,6 +31927,7 @@ }, "R-41956": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-41956", @@ -31275,6 +31936,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VIP Assignment, External Networks, Supported by Automation", "sections": [ "VIP Assignment, External Networks, Supported by Automation", @@ -31296,6 +31958,7 @@ }, "R-41994": { "description": "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.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-41994", @@ -31304,6 +31967,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Cryptography Requirements", "sections": [ "VNF Cryptography Requirements", @@ -31324,6 +31988,7 @@ }, "R-42018": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-42018", @@ -31332,6 +31997,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -31352,6 +32018,7 @@ }, "R-42140": { "description": "The xNF **MUST** respond to data requests from ONAP as soon\nas those requests are received, as a synchronous response.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-42140", @@ -31360,6 +32027,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Asynchronous and Synchronous Data Delivery", "sections": [ "Asynchronous and Synchronous Data Delivery", @@ -31381,6 +32049,7 @@ }, "R-42207": { "description": "The VNF **MUST** design resiliency into a VNF such that the\nresiliency deployment model (e.g., active-active) can be chosen at\nrun-time.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-42207", @@ -31389,6 +32058,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "All Layer Redundancy", "sections": [ "All Layer Redundancy", @@ -31409,6 +32079,7 @@ }, "R-42366": { "description": "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>`_.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-42366", @@ -31417,6 +32088,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Security", "sections": [ "Security", @@ -31438,6 +32110,7 @@ }, "R-42685": { "description": "A VNF's Heat Orchestration template's Environment File's\n**MAY** contain the ``parameter_merge_strategies:`` section.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-42685", @@ -31446,6 +32119,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Environment File Format", "sections": [ "Environment File Format", @@ -31466,6 +32140,7 @@ }, "R-42874": { "description": "The VNF **MUST** allow the Operator to restrict access based on\nthe assigned permissions associated with an ID in order to support\nLeast Privilege (no more privilege than required to perform job\nfunctions).", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-42874", @@ -31474,6 +32149,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -31494,6 +32170,7 @@ }, "R-43253": { "description": "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).", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-43253", @@ -31502,6 +32179,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Playbook Requirements", "sections": [ "Ansible Playbook Requirements", @@ -31524,6 +32202,7 @@ }, "R-43327": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-43327", @@ -31532,6 +32211,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Asynchronous and Synchronous Data Delivery", "sections": [ "Asynchronous and Synchronous Data Delivery", @@ -31553,6 +32233,7 @@ }, "R-43332": { "description": "The VNF **MUST** activate security alarms automatically when\nit detects the successful modification of a critical system or\napplication file.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-43332", @@ -31561,6 +32242,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -31581,6 +32263,7 @@ }, "R-43353": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-43353", @@ -31589,6 +32272,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Playbook Requirements", "sections": [ "Ansible Playbook Requirements", @@ -31611,6 +32295,7 @@ }, "R-43413": { "description": "A VNF **MUST** utilize a modular Heat Orchestration Template design to\nsupport scaling (growth/de-growth).", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-43413", @@ -31619,6 +32304,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Support of heat stack update", "sections": [ "Support of heat stack update", @@ -31639,6 +32325,7 @@ }, "R-43740": { "description": "VNF's Heat Orchestration Template's Resource **MAY** declare the\nattribute ``deletion_policy:``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-43740", @@ -31647,6 +32334,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "deletion_policy", "sections": [ "deletion_policy", @@ -31669,6 +32357,7 @@ }, "R-43884": { "description": "The VNF **SHOULD** integrate with the Operator's authentication and\nauthorization services (e.g., IDAM).", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-43884", @@ -31677,6 +32366,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF API Security Requirements", "sections": [ "VNF API Security Requirements", @@ -31697,6 +32387,7 @@ }, "R-43958": { "description": "The xNF Package **MUST** include documentation describing\nthe tests that were conducted by the xNF provider and the test results.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-43958", @@ -31705,6 +32396,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Testing", "sections": [ "Testing", @@ -31725,6 +32417,7 @@ }, "R-44001": { "description": "A VNF's Heat Orchestration Template parameter declaration **MUST**\ncontain the attribute ``description``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-44001", @@ -31733,6 +32426,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "description", "sections": [ "description", @@ -31755,6 +32449,7 @@ }, "R-44013": { "description": "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).", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-44013", @@ -31763,6 +32458,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Chef Roles/Requirements", "sections": [ "Chef Roles/Requirements", @@ -31785,6 +32481,7 @@ }, "R-440220": { "description": "The xNF **SHOULD** support File transferring protocol, such as FTPES or SFTP,\nwhen supporting the event-driven bulk transfer of monitoring data.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-440220", @@ -31793,6 +32490,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Bulk Performance Measurement", "sections": [ "Bulk Performance Measurement", @@ -31814,6 +32512,7 @@ }, "R-44125": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-44125", @@ -31822,6 +32521,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Licensing Requirements", "sections": [ "Licensing Requirements", @@ -31842,6 +32542,7 @@ }, "R-44271": { "description": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``name`` parameter value **SHOULD NOT** contain special characters\nsince the Contrail GUI has a limitation displaying special characters.\n\nHowever, if special characters must be used, the only special characters\nsupported are: --- \\\" ! $ ' (\\ \\ ) = ~ ^ | @ ` { } [ ] > , . _", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-44271", @@ -31850,6 +32551,7 @@ "keyword": "SHOULD NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Contrail Issue with Values for OS::Nova::Server Property Name", "sections": [ "Contrail Issue with Values for OS::Nova::Server Property Name", @@ -31871,6 +32573,7 @@ }, "R-44281": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-44281", @@ -31879,6 +32582,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -31895,12 +32599,13 @@ "title": "", "title_from_content": "", "type_name": "Requirement", - "updated": "", + "updated": "casablanca", "validated_by": "", "validation_mode": "" }, "R-44290": { "description": "The xNF **MUST** control access to ONAP and to xNFs, and creation\nof connections, through secure credentials, log-on and exchange mechanisms.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-44290", @@ -31909,6 +32614,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Security", "sections": [ "Security", @@ -31930,6 +32636,7 @@ }, "R-44318": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-44318", @@ -31938,6 +32645,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vnf_name", "sections": [ "vnf_name", @@ -31958,6 +32666,7 @@ }, "R-44491": { "description": "If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vnf_id`` is passed into a Nested YAML\nfile, the key/value pair name ``vnf_id`` **MUST NOT** change.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-44491", @@ -31966,6 +32675,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vnf_id", "sections": [ "vnf_id", @@ -31986,6 +32696,7 @@ }, "R-44569": { "description": "The xNF provider **MUST NOT** require additional\ninfrastructure such as a xNF provider license server for xNF provider\nfunctions and metrics.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-44569", @@ -31994,6 +32705,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Licensing Requirements", "sections": [ "Licensing Requirements", @@ -32014,6 +32726,7 @@ }, "R-44723": { "description": "The VNF **MUST** use symmetric keys of at least 112 bits in length.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-44723", @@ -32022,6 +32735,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Cryptography Requirements", "sections": [ "VNF Cryptography Requirements", @@ -32042,6 +32756,7 @@ }, "R-44896": { "description": "The VNF Package **MUST** include VM requirements via a Heat\ntemplate that provides the necessary data for high availability\nredundancy model.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-44896", @@ -32050,6 +32765,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Compute, Network, and Storage Requirements", "sections": [ "Compute, Network, and Storage Requirements", @@ -32070,6 +32786,7 @@ }, "R-45188": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-45188", @@ -32078,6 +32795,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: flavor", "sections": [ "Property: flavor", @@ -32098,6 +32816,7 @@ }, "R-45197": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-45197", @@ -32106,6 +32825,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Client Requirements", "sections": [ "Ansible Client Requirements", @@ -32128,6 +32848,7 @@ }, "R-45602": { "description": "If a VNF's Port is attached to a network (internal or external)\nand the port's IP addresses are cloud assigned by OpenStack's DHCP\nService, the ``OS::Neutron::Port`` Resource's\n\n* property ``fixed_ips`` map property ``ip_address`` **MUST NOT** be used\n* property ``fixed_ips`` map property ``subnet``\n **MAY** be used", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-45602", @@ -32136,6 +32857,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Items to Note", "sections": [ "Items to Note", @@ -32157,6 +32879,7 @@ }, "R-45719": { "description": "The VNF **MUST**, if not integrated with the Operator's Identity and Access\nManagement system, or enforce a configurable \"terminate idle sessions\"\npolicy by terminating the session after a configurable period of inactivity.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-45719", @@ -32165,6 +32888,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -32185,6 +32909,7 @@ }, "R-45856": { "description": "The xNF **MUST** support APPC/SDN-C ``UpgradePostCheck`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-45856", @@ -32193,6 +32918,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Lifecycle Management Related Commands", "sections": [ "Lifecycle Management Related Commands", @@ -32214,6 +32940,7 @@ }, "R-46096": { "description": "A VNF's Heat Orchestration template's Environment File's\n**MAY** contain the ``encrypted_parameters:`` section.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-46096", @@ -32222,6 +32949,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Environment File Format", "sections": [ "Environment File Format", @@ -32242,6 +32970,7 @@ }, "R-46119": { "description": "A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume\n**MAY** be defined in a Base Module.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-46119", @@ -32250,6 +32979,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -32270,6 +33000,7 @@ }, "R-46128": { "description": "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 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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-46128", @@ -32278,6 +33009,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::InstanceIp", "sections": [ "OS::ContrailV2::InstanceIp", @@ -32299,6 +33031,7 @@ }, "R-46290": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-46290", @@ -32307,6 +33040,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Asynchronous and Synchronous Data Delivery", "sections": [ "Asynchronous and Synchronous Data Delivery", @@ -32328,6 +33062,7 @@ }, "R-46461": { "description": "A VNF's port connected to an internal network **MUST NOT** use the port\nfor the purpose of reaching VMs in another VNF and/or an\nexternal gateway and/or\nexternal router.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-46461", @@ -32336,6 +33071,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Internal Networks", "sections": [ "Internal Networks", @@ -32356,6 +33092,7 @@ }, "R-465236": { "description": "The VNF **SHOULD** provide the capability of maintaining the integrity of\nits static files using a cryptographic method.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-465236", @@ -32364,6 +33101,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -32384,6 +33122,7 @@ }, "R-46527": { "description": "A VNFD is a deployment template which describes a VNF in terms of\ndeployment and operational behavior requirements. It contains\nvirtualized resources (nodes) requirements as well as connectivity\nand interfaces requirements and **MUST** comply with info elements\nspecified in ETSI GS NFV-IFA 011. The main parts of the VNFD are\nthe following:\n\n - VNF topology: it is modeled in a cloud agnostic way using virtualized\n containers and their connectivity. Virtual Deployment Units (VDU)\n describe the capabilities of the virtualized containers, such as\n virtual CPU, RAM, disks; their connectivity is modeled with VDU\n Connection Point Descriptors (VduCpd), Virtual Link Descriptors\n (VnfVld) and VNF External Connection Point Descriptors\n (VnfExternalCpd);\n\n - VNF deployment aspects: they are described in one or more\n deployment flavours, including configurable parameters, instantiation\n levels, placement constraints (affinity / antiaffinity), minimum and\n maximum VDU instance numbers. Horizontal scaling is modeled with\n scaling aspects and the respective scaling levels in the deployment\n flavours;\n\n**Note**: The deployment aspects (deployment flavour etc.) are postponed\nfor future ONAP releases.\n\n - VNF lifecycle management (LCM) operations: describes the LCM operations\n supported per deployment flavour, and their input parameters;\n Note, thatthe actual LCM implementation resides in a different layer,\n namely referring to additional template artifacts.", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-46527", @@ -32392,6 +33131,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "General", "sections": [ "General", @@ -32413,6 +33153,7 @@ }, "R-46567": { "description": "The xNF Package **MUST** include configuration scripts\nfor boot sequence and configuration.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-46567", @@ -32421,6 +33162,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Management via Ansible", "sections": [ "Configuration Management via Ansible", @@ -32442,6 +33184,7 @@ }, "R-46839": { "description": "A VNF's Heat Orchestration Template's use of ``{vm-type}``\nin all Resource IDs **MUST** be the same case.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}", "full_title": "", "hide_links": "", "id": "R-46839", @@ -32450,6 +33193,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "{vm-type}", "sections": [ "{vm-type}" @@ -32469,6 +33213,7 @@ }, "R-46851": { "description": "The VNF **MUST** support ONAP Controller's Evacuate command.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-46851", @@ -32477,6 +33222,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Virtual Function - Container Recovery Requirements", "sections": [ "Virtual Function - Container Recovery Requirements", @@ -32497,6 +33243,7 @@ }, "R-46908": { "description": "The VNF **MUST**, if not integrated with the Operator's Identity and\nAccess Management system, comply with \"password complexity\" policy. When\npasswords are used, they shall be complex and shall at least meet the\nfollowing password construction requirements: (1) be a minimum configurable\nnumber of characters in length, (2) include 3 of the 4 following types of\ncharacters: upper-case alphabetic, lower-case alphabetic, numeric, and\nspecial, (3) not be the same as the UserID with which they are associated\nor other common strings as specified by the environment, (4) not contain\nrepeating or sequential characters or numbers, (5) not to use special\ncharacters that may have command functions, and (6) new passwords must\nnot contain sequences of three or more characters from the previous\npassword.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-46908", @@ -32505,6 +33252,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -32525,6 +33273,7 @@ }, "R-46960": { "description": "NCSPs **MAY** operate a limited set of Guest OS and CPU\narchitectures and families, virtual machines, etc.", + "docname": "Chapter4/Devops", "full_title": "", "hide_links": "", "id": "R-46960", @@ -32533,6 +33282,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Devops", "sections": [ "VNF Devops" @@ -32552,6 +33302,7 @@ }, "R-46968": { "description": "VNF's Heat Orchestration Template's Resource **MAY** declare the\nattribute ``depends_on:``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-46968", @@ -32560,6 +33311,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "depends_on", "sections": [ "depends_on", @@ -32582,6 +33334,7 @@ }, "R-46986": { "description": "The VNF **SHOULD** have source code scanned using scanning\ntools (e.g., Fortify) and provide reports.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-46986", @@ -32590,6 +33343,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -32610,6 +33364,7 @@ }, "R-47061": { "description": "A VNF's Heat Orchestration Template's OS::Nova::Server\nResource **SHOULD** contain the metadata map value parameter\n'workload_context'.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-47061", @@ -32618,6 +33373,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "workload_context", "sections": [ "workload_context", @@ -32638,6 +33394,7 @@ }, "R-47068": { "description": "The xNF **MAY** expose a single endpoint that is\nresponsible for all functionality.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-47068", @@ -32646,6 +33403,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Chef Client Requirements", "sections": [ "Chef Client Requirements", @@ -32668,6 +33426,7 @@ }, "R-470963": { "description": "The VNF, when publishing events, **MUST** leverage camel case to separate\nwords and acronyms used as keys that will be sent through extensible fields.\nWhen an acronym is used as the key, then only the first letter shall be\ncapitalized.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-470963", @@ -32676,6 +33435,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Miscellaneous", "sections": [ "Miscellaneous", @@ -32697,6 +33457,7 @@ }, "R-47204": { "description": "The VNF **MUST** be capable of protecting the confidentiality and integrity\nof data at rest and in transit from unauthorized access and modification.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-47204", @@ -32705,6 +33466,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Data Protection Requirements", "sections": [ "VNF Data Protection Requirements", @@ -32725,6 +33487,7 @@ }, "R-47597": { "description": "The xNF **MUST** carry data in motion only over secure connections.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-47597", @@ -32733,6 +33496,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Security", "sections": [ "Security", @@ -32754,6 +33518,7 @@ }, "R-47849": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-47849", @@ -32762,6 +33527,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Licensing Requirements", "sections": [ "Licensing Requirements", @@ -32782,6 +33548,7 @@ }, "R-47874": { "description": "A VNF **MAY** have\n * Only an IPv4 OAM Management IP Address\n * Only an IPv6 OAM Management IP Address\n * Both a IPv4 and IPv6 OAM Management IP Addresses", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names", "full_title": "", "hide_links": "", "id": "R-47874", @@ -32790,6 +33557,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "OAM Management IP Addresses", "sections": [ "OAM Management IP Addresses", @@ -32811,6 +33579,7 @@ }, "R-479386": { "description": "The VNF **MUST NOT** display \"Welcome\" notices or messages that could\nbe misinterpreted as extending an invitation to unauthorized users.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-479386", @@ -32819,6 +33588,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -32839,6 +33609,7 @@ }, "R-48067": { "description": "A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST NOT** be a\nsubstring\nof ``{network-role}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}", "full_title": "", "hide_links": "", "id": "R-48067", @@ -32847,6 +33618,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "{vm-type}", "sections": [ "{vm-type}" @@ -32866,6 +33638,7 @@ }, "R-48080": { "description": "The VNF **SHOULD** support an automated certificate management protocol\nsuch as CMPv2, Simple Certificate Enrollment Protocol (SCEP) or\nAutomated Certificate Management Environment (ACME).", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-48080", @@ -32874,6 +33647,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Cryptography Requirements", "sections": [ "VNF Cryptography Requirements", @@ -32894,6 +33668,7 @@ }, "R-481670": { "description": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``flavor`` value **MUST** be be obtained via a ``get_param``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-481670", @@ -32902,6 +33677,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: flavor", "sections": [ "Property: flavor", @@ -32922,6 +33698,7 @@ }, "R-48247": { "description": "The xNF **MUST** support APPC ``ConfigRestore`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-48247", @@ -32930,6 +33707,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Commands", "sections": [ "Configuration Commands", @@ -32951,6 +33729,7 @@ }, "R-48356": { "description": "The VNF **MUST** fully exploit exception handling to the extent\nthat resources (e.g., threads and memory) are released when no longer\nneeded regardless of programming language.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-48356", @@ -32959,6 +33738,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Application Resilient Error Handling", "sections": [ "Application Resilient Error Handling", @@ -32979,6 +33759,7 @@ }, "R-48470": { "description": "The VNF **MUST** support Real-time detection and\nnotification of security events.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-48470", @@ -32987,6 +33768,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -33007,6 +33789,7 @@ }, "R-48596": { "description": "The xNF Package **MUST** include documentation describing\nthe characteristics for the xNF reliability and high availability.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-48596", @@ -33015,6 +33798,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -33035,6 +33819,7 @@ }, "R-48698": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-48698", @@ -33043,6 +33828,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Playbook Requirements", "sections": [ "Ansible Playbook Requirements", @@ -33065,6 +33851,7 @@ }, "R-48761": { "description": "The VNF **MUST** support ONAP Controller's Snapshot command.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-48761", @@ -33073,6 +33860,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Virtual Function - Container Recovery Requirements", "sections": [ "Virtual Function - Container Recovery Requirements", @@ -33093,6 +33881,7 @@ }, "R-48880": { "description": "If a VNF's Port is attached to an external network and the port's\nIP addresses are assigned by ONAP's SDN-Controller,\nthe ``OS::Neutron::Port`` Resource's\n\n* property ``fixed_ips`` map property ``ip_address`` **MUST** be used\n* property ``fixed_ips`` map property ``subnet``\n **MUST NOT** be used", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-48880", @@ -33101,6 +33890,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Items to Note", "sections": [ "Items to Note", @@ -33122,6 +33912,7 @@ }, "R-48917": { "description": "The VNF **MUST** monitor for and alert on (both sender and\nreceiver) errant, running longer than expected and missing file transfers,\nso as to minimize the impact due to file transfer errors.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-48917", @@ -33130,6 +33921,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Monitoring & Dashboard", "sections": [ "Monitoring & Dashboard", @@ -33150,6 +33942,7 @@ }, "R-48987": { "description": "If the VNF's OAM Management IP Address is cloud assigned and\nand the OAM IP Address is required to be inventoried in ONAP A&AI,\nthen the parameter **MUST** be obtained by the\nresource ``OS::Neutron::Port``\nattribute ``ip_address``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names", "full_title": "", "hide_links": "", "id": "R-48987", @@ -33158,6 +33951,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OAM Management IP Addresses", "sections": [ "OAM Management IP Addresses", @@ -33179,6 +33973,7 @@ }, "R-49036": { "description": "The xNF **SHOULD** conform its YANG model to RFC 7277,\n\"A YANG Data Model for IP Management\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-49036", @@ -33187,6 +33982,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -33209,6 +34005,7 @@ }, "R-49109": { "description": "The VNF **MUST** support HTTP/S using TLS v1.2 or higher\nwith strong cryptographic ciphers.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-49109", @@ -33217,6 +34014,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Cryptography Requirements", "sections": [ "VNF Cryptography Requirements", @@ -33237,6 +34035,7 @@ }, "R-49145": { "description": "The xNF **MUST** implement ``:confirmed-commit`` If\n``:candidate`` is supported.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-49145", @@ -33245,6 +34044,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -33267,6 +34067,7 @@ }, "R-49177": { "description": "If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vf_module_name`` is passed into a\nNested YAML\nfile, the key/value pair name ``vf_module_name`` **MUST NOT** change.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-49177", @@ -33275,6 +34076,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_name", "sections": [ "vf_module_name", @@ -33295,6 +34097,7 @@ }, "R-49224": { "description": "The VNF **MUST** provide unique traceability of a transaction\nthrough its life cycle to ensure quick and efficient troubleshooting.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-49224", @@ -33303,6 +34106,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Monitoring & Dashboard", "sections": [ "Monitoring & Dashboard", @@ -33323,6 +34127,7 @@ }, "R-49308": { "description": "The VNF **SHOULD** test for adherence to the defined resiliency\nrating recommendation at each layer, during each delivery cycle with\ndelivered results, so that the resiliency rating is measured and the\ncode is adjusted to meet software resiliency requirements.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-49308", @@ -33331,6 +34136,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Deployment Optimization", "sections": [ "Deployment Optimization", @@ -33351,6 +34157,7 @@ }, "R-49396": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-49396", @@ -33359,6 +34166,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Playbook Requirements", "sections": [ "Ansible Playbook Requirements", @@ -33381,6 +34189,7 @@ }, "R-49466": { "description": "The xNF **MUST** support APPC/SDN-C ``UpgradeSoftware`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-49466", @@ -33389,6 +34198,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Lifecycle Management Related Commands", "sections": [ "Lifecycle Management Related Commands", @@ -33410,14 +34220,16 @@ }, "R-49751": { "description": "The xNF **MUST** support Ansible playbooks that are compatible with\nAnsible version 2.6 or later.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-49751", "impacts": "", - "introduced": "", + "introduced": "casablanca", "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Playbook Requirements", "sections": [ "Ansible Playbook Requirements", @@ -33440,14 +34252,16 @@ }, "R-49911": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-49911", "impacts": "", - "introduced": "", + "introduced": "casablanca", "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Playbook Requirements", "sections": [ "Ansible Playbook Requirements", @@ -33470,6 +34284,7 @@ }, "R-50011": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Template Constructs", "full_title": "", "hide_links": "", "id": "R-50011", @@ -33478,6 +34293,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Heat::ResourceGroup Property count", "sections": [ "OS::Heat::ResourceGroup Property count", @@ -33500,6 +34316,7 @@ }, "R-50252": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-50252", @@ -33508,6 +34325,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Playbook Requirements", "sections": [ "Ansible Playbook Requirements", @@ -33530,6 +34348,7 @@ }, "R-50436": { "description": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``flavor`` parameter **MUST** be declared as type: ``string``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-50436", @@ -33538,6 +34357,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: flavor", "sections": [ "Property: flavor", @@ -33558,6 +34378,7 @@ }, "R-50468": { "description": "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 the vmi on the vm-type\n attached to the network of ``{network-role}``", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-50468", @@ -33566,6 +34387,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::VirtualMachineInterface", "sections": [ "OS::ContrailV2::VirtualMachineInterface", @@ -33587,6 +34409,7 @@ }, "R-50816": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-50816", @@ -33595,6 +34418,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_index", "sections": [ "vf_module_index", @@ -33615,6 +34439,7 @@ }, "R-51347": { "description": "The VNF package **MUST** be arranged as a CSAR archive as specified in\nTOSCA Simple Profile in YAML 1.2.", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-51347", @@ -33623,6 +34448,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Package Structure and Format", "sections": [ "VNF Package Structure and Format", @@ -33644,6 +34470,7 @@ }, "R-51430": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-51430", @@ -33652,6 +34479,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: Name", "sections": [ "Property: Name", @@ -33672,6 +34500,7 @@ }, "R-51442": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-51442", @@ -33680,6 +34509,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Playbook Requirements", "sections": [ "Ansible Playbook Requirements", @@ -33702,6 +34532,7 @@ }, "R-52060": { "description": "The VNF **MUST** provide the capability to configure encryption\nalgorithms or devices so that they comply with the laws of the jurisdiction\nin which there are plans to use data encryption.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-52060", @@ -33710,6 +34541,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Cryptography Requirements", "sections": [ "VNF Cryptography Requirements", @@ -33730,6 +34562,7 @@ }, "R-520802": { "description": "The xNF provider **MUST** provide a YAML file formatted in adherence with\nthe :doc:`VES Event Registration specification<../../../../vnfsdk/module.git/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", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-520802", @@ -33738,6 +34571,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Data Structure Specification of the Event Record", "sections": [ "Data Structure Specification of the Event Record", @@ -33758,6 +34592,7 @@ }, "R-52425": { "description": "A VNF's port connected to an internal network **MUST**\nuse the port for the purpose of reaching VMs in the same VNF.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-52425", @@ -33766,6 +34601,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Internal Networks", "sections": [ "Internal Networks", @@ -33786,6 +34622,7 @@ }, "R-52499": { "description": "The VNF **MUST** meet their own resiliency goals and not rely\non the Network Cloud.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-52499", @@ -33794,6 +34631,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "All Layer Redundancy", "sections": [ "All Layer Redundancy", @@ -33814,6 +34652,7 @@ }, "R-52530": { "description": "A VNF's Heat Orchestration Template's Nested YAML file\n**MUST** be in the same directory hierarchy as the VNF's Heat\nOrchestration Templates.", + "docname": "Chapter5/Heat/ONAP Heat Template Constructs", "full_title": "", "hide_links": "", "id": "R-52530", @@ -33822,6 +34661,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Nested Heat Template Requirements", "sections": [ "Nested Heat Template Requirements", @@ -33843,6 +34683,7 @@ }, "R-52753": { "description": "VNF's Heat Orchestration Template's Base Module's output parameter's\nname and type **MUST** match the VNF's Heat Orchestration Template's\nincremental Module's name and type unless the output parameter is of\ntype ``comma_delimited_list``, then the corresponding input parameter\n**MUST** be declared as type ``json``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-52753", @@ -33851,6 +34692,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP Base Module Output Parameters", "sections": [ "ONAP Base Module Output Parameters", @@ -33872,6 +34714,7 @@ }, "R-52870": { "description": "The VNF **MUST** provide a method of metrics gathering\nand analysis to evaluate the resiliency of the software from both\na granular as well as a holistic standpoint. This includes, but is\nnot limited to thread utilization, errors, timeouts, and retries.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-52870", @@ -33880,6 +34723,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Monitoring & Dashboard", "sections": [ "Monitoring & Dashboard", @@ -33900,6 +34744,7 @@ }, "R-528866": { "description": "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", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-528866", @@ -33908,6 +34753,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Common Event Header", "sections": [ "Common Event Header", @@ -33929,6 +34775,7 @@ }, "R-53015": { "description": "The xNF **MUST** apply locking based on the sequence of\nNETCONF operations, with the first configuration operation locking\nout all others until completed.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-53015", @@ -33937,6 +34784,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -33959,6 +34807,7 @@ }, "R-53310": { "description": "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 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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-53310", @@ -33967,6 +34816,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::InstanceIp", "sections": [ "OS::ContrailV2::InstanceIp", @@ -33988,6 +34838,7 @@ }, "R-53317": { "description": "The xNF **MUST** conform its YANG model to RFC 6087,\n\"Guidelines for Authors and Reviewers of YANG Data Model Documents\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-53317", @@ -33996,6 +34847,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -34018,6 +34870,7 @@ }, "R-53433": { "description": "A VNF's Cinder Volume Module **MUST** have a corresponding environment file", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-53433", @@ -34026,6 +34879,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -34046,6 +34900,7 @@ }, "R-53598": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-53598", @@ -34054,6 +34909,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -34074,6 +34930,7 @@ }, "R-53952": { "description": "A VNF's Heat Orchestration Template's Resource\n**MUST NOT** reference a HTTP-based resource definitions.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-53952", @@ -34082,6 +34939,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "type", "sections": [ "type", @@ -34104,6 +34962,7 @@ }, "R-54171": { "description": "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``{vm-type}_name_{index}``, where ``{index}`` is a numeric\nvalue that starts at\nzero and increments by one.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-54171", @@ -34112,6 +34971,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: Name", "sections": [ "Property: Name", @@ -34132,6 +34992,7 @@ }, "R-54190": { "description": "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).", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-54190", @@ -34140,6 +35001,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -34162,6 +35024,7 @@ }, "R-54340": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-54340", @@ -34170,6 +35033,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_index", "sections": [ "vf_module_index", @@ -34190,6 +35054,7 @@ }, "R-54356": { "description": "The below table includes the data types used by NFV node and is based\non TOSCA/YAML constructs specified in draft GS NFV-SOL 001. The node\ndata definitions/attributes used in VNFD **MUST** comply with the below\ntable.", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-54356", @@ -34198,6 +35063,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Data Types", "sections": [ "Data Types", @@ -34219,6 +35085,7 @@ }, "R-54373": { "description": "The xNF **MUST** have Python >= 2.6 on the endpoint VM(s)\nof a xNF on which an Ansible playbook will be executed.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-54373", @@ -34227,6 +35094,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Client Requirements", "sections": [ "Ansible Client Requirements", @@ -34249,6 +35117,7 @@ }, "R-54430": { "description": "The VNF **MUST** use the NCSP's supported library and compute\nflavor that supports DPDK to optimize network efficiency if using DPDK. [#4.1.1]_", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-54430", @@ -34257,6 +35126,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -34276,6 +35146,7 @@ }, "R-54458": { "description": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::VirtualMachineInterface`` that is attaching to a sub-interface\nnetwork Resource ID **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_subint_{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 the vmi on the vm-type\n attached to the network of ``{network-role}``", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-54458", @@ -34284,6 +35155,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::VirtualMachineInterface", "sections": [ "OS::ContrailV2::VirtualMachineInterface", @@ -34305,6 +35177,7 @@ }, "R-54517": { "description": "When a VNF's Heat Orchestration Template's resource is associated with\na single ``{vm-type}``, the Resource ID **MUST** contain the\n``{vm-type}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-54517", @@ -34313,6 +35186,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource IDs", "sections": [ "Resource IDs" @@ -34332,6 +35206,7 @@ }, "R-54520": { "description": "The VNF **MUST** log successful and unsuccessful authentication\nattempts, e.g., authentication associated with a transaction,\nauthentication to create a session, authentication to assume elevated\nprivilege.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-54520", @@ -34340,6 +35215,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -34360,6 +35236,7 @@ }, "R-54816": { "description": "The VNF **MUST** support the storage of security audit logs for a\nconfigurable period of time.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-54816", @@ -34368,6 +35245,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -34388,6 +35266,7 @@ }, "R-54876": { "description": "The below table describes the data types used for LCM configuration\nand is based on TOSCA constructs specified in draft GS NFV-SOL 001.\nThe LCM configuration data elements used in VNFD **MUST** comply\nwith the below table.", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-54876", @@ -34396,6 +35275,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Data Types", "sections": [ "Data Types", @@ -34417,6 +35297,7 @@ }, "R-54930": { "description": "The VNF **MUST** implement the following input validation controls:\nDo not permit input that contains content or characters inappropriate\nto the input expected by the design. Inappropriate input, such as\nSQL expressions, may cause the system to execute undesirable and\nunauthorized transactions against the database or allow other\ninappropriate access to the internal network (injection attacks).", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-54930", @@ -34425,6 +35306,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF API Security Requirements", "sections": [ "VNF API Security Requirements", @@ -34445,6 +35327,7 @@ }, "R-55218": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-55218", @@ -34453,6 +35336,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vnf_id", "sections": [ "vnf_id", @@ -34473,6 +35357,7 @@ }, "R-55306": { "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vf_module_index`` **MUST NOT**\nbe used in a ``OS::Cinder::Volume`` resource and **MUST NOT** be\nused in VNF's Volume template;\nit is not supported.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-55306", @@ -34481,6 +35366,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_index", "sections": [ "vf_module_index", @@ -34501,6 +35387,7 @@ }, "R-55345": { "description": "The VNF **SHOULD** use techniques such as \"lazy loading\" when\ninitialization includes loading catalogues and/or lists which can grow\nover time, so that the VNF startup time does not grow at a rate\nproportional to that of the list.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-55345", @@ -34509,6 +35396,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "System Resource Optimization", "sections": [ "System Resource Optimization", @@ -34529,6 +35417,7 @@ }, "R-55478": { "description": "The VNF **MUST** log logoffs.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-55478", @@ -34537,6 +35426,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -34557,6 +35447,7 @@ }, "R-55802": { "description": "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*.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-55802", @@ -34565,6 +35456,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Compute, Network, and Storage Requirements", "sections": [ "Compute, Network, and Storage Requirements", @@ -34585,6 +35477,7 @@ }, "R-56183": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-56183", @@ -34593,6 +35486,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "environment_context", "sections": [ "environment_context", @@ -34613,6 +35507,7 @@ }, "R-56218": { "description": "The VNF **MUST** support ONAP Controller's Migrate command that\nmoves container (VM) from a live Physical Server / Compute Node to\nanother live Physical Server / Compute Node.\n\n Note: Container migrations MUST be transparent to the VNF and no more intrusive than a stop,\n followed by some down time for the migration to be performed from one Compute Node / Physical\n Server to another, followed by a start of the same VM with same configuration on the new\n Compute Node / Physical Server.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-56218", @@ -34621,6 +35516,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Virtual Function - Container Recovery Requirements", "sections": [ "Virtual Function - Container Recovery Requirements", @@ -34641,6 +35537,7 @@ }, "R-56287": { "description": "If the VNF's OAM Management IP Address is assigned by ONAP SDN-C and\nassigned in the VNF's Heat Orchestration Template's via a heat resource\n``OS::Neutron::Port`` property ``fixed_ips`` map property\n``ip_adress`` parameter (e.g., ``{vm-type}_{network-role}_ip_{index}``,\n``{vm-type}_{network-role}_v6_ip_{index}``)\nand the OAM IP Address is required to be inventoried in ONAP A&AI,\nthen the parameter **MUST** be echoed in an output statement.\n\n.. code-block:: yaml\n\n outputs:\n oam_management_v4_address:\n value: {get_param: {vm-type}_{network-role}_ip_{index} }\n oam_management_v6_address:\n value: {get_param: {vm-type}_{network-role}_v6_ip_{index} }", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names", "full_title": "", "hide_links": "", "id": "R-56287", @@ -34649,6 +35546,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OAM Management IP Addresses", "sections": [ "OAM Management IP Addresses", @@ -34670,6 +35568,7 @@ }, "R-56385": { "description": "The xNF **MUST** support APPC ``Audit`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-56385", @@ -34678,6 +35577,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Commands", "sections": [ "Configuration Commands", @@ -34699,6 +35599,7 @@ }, "R-56438": { "description": "A VNF's Heat Orchestration Template's Nested YAML file extension **MUST**\nbe in the lower case format ``.yaml`` or ``.yml``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-56438", @@ -34707,6 +35608,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP Heat Orchestration Template Filenames", "sections": [ "ONAP Heat Orchestration Template Filenames", @@ -34727,6 +35629,7 @@ }, "R-56718": { "description": "The PNF Vendor **MAY** provide software version(s) to be supported by PNF\nfor SDC Design Studio PNF Model. This is set in the PNF Model property\nsoftware_versions.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-56718", @@ -34735,6 +35638,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -34755,6 +35659,7 @@ }, "R-56721": { "description": "A VNF's Incremental Module **MAY** utilize nested heat.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-56721", @@ -34763,6 +35668,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Nested Heat Orchestration Templates Overview", "sections": [ "Nested Heat Orchestration Templates Overview", @@ -34783,6 +35689,7 @@ }, "R-56793": { "description": "The VNF **MUST** test for adherence to the defined performance\nbudgets at each layer, during each delivery cycle with delivered\nresults, so that the performance budget is measured and the code\nis adjusted to meet performance budget.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-56793", @@ -34791,6 +35698,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Deployment Optimization", "sections": [ "Deployment Optimization", @@ -34811,6 +35719,7 @@ }, "R-56815": { "description": "The xNF Package **MUST** include documentation describing\nsupported xNF scaling capabilities and capacity limits (e.g., number\nof users, bandwidth, throughput, concurrent calls).", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-56815", @@ -34819,6 +35728,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -34839,6 +35749,7 @@ }, "R-56904": { "description": "The VNF **MUST** interoperate with the ONAP (SDN) Controller so that\nit can dynamically modify the firewall rules, ACL rules, QoS rules, virtual\nrouting and forwarding rules.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-56904", @@ -34847,6 +35758,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -34867,6 +35779,7 @@ }, "R-56920": { "description": "The VNF **MUST** protect all security audit logs (including\nAPI, OS and application-generated logs), security audit software, data,\nand associated documentation from modification, or unauthorized viewing,\nby standard OS access control mechanisms, by sending to a remote system,\nor by encryption.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-56920", @@ -34875,6 +35788,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -34895,6 +35809,7 @@ }, "R-570134": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-570134", @@ -34903,6 +35818,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Data Structure Specification of the Event Record", "sections": [ "Data Structure Specification of the Event Record", @@ -34923,6 +35839,7 @@ }, "R-57282": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-57282", @@ -34931,6 +35848,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: image", "sections": [ "Property: image", @@ -34951,6 +35869,7 @@ }, "R-57424": { "description": "A VNF's port connected to an external network **MUST**\nuse the port for the purpose of reaching\nVMs in another VNF and/or an external gateway and/or external router.\nA VNF's port connected to an external network **MAY**\nuse the port for the purpose of reaching VMs in the same VNF.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-57424", @@ -34959,6 +35878,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "External Networks", "sections": [ "External Networks", @@ -34979,6 +35899,7 @@ }, "R-57617": { "description": "The VNF **MUST** include the field \"success/failure\" in the\nSecurity alarms (where applicable and technically feasible).", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-57617", @@ -34987,6 +35908,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -35007,6 +35929,7 @@ }, "R-57855": { "description": "The VNF **MUST** support hitless staggered/rolling deployments\nbetween its redundant instances to allow \"soak-time/burn in/slow roll\"\nwhich can enable the support of low traffic loads to validate the\ndeployment prior to supporting full traffic loads.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-57855", @@ -35015,6 +35938,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Deployment Optimization", "sections": [ "Deployment Optimization", @@ -35035,6 +35959,7 @@ }, "R-579051": { "description": "The PNF **MAY** support a HTTP connection to the DCAE VES Event Listener.\n\nNote: HTTP is allowed but not recommended.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-579051", @@ -35043,6 +35968,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -35063,6 +35989,7 @@ }, "R-581188": { "description": "A failed authentication attempt **MUST NOT** identify the reason for the\nfailure to the user, only that the authentication failed.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-581188", @@ -35071,6 +35998,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -35091,6 +36019,7 @@ }, "R-58301": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-58301", @@ -35099,6 +36028,7 @@ "keyword": "SHOULD NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Playbook Requirements", "sections": [ "Ansible Playbook Requirements", @@ -35121,6 +36051,7 @@ }, "R-58358": { "description": "The xNF **MUST** implement the ``:with-defaults`` capability\n[RFC6243].", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-58358", @@ -35129,6 +36060,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -35151,6 +36083,7 @@ }, "R-58370": { "description": "The VNF **SHOULD** operate with anti-virus software which produces alarms\nevery time a virus is detected.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-58370", @@ -35159,6 +36092,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -35179,6 +36113,7 @@ }, "R-58421": { "description": "The VNF **SHOULD** be decomposed into granular re-usable VNFCs.", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-58421", @@ -35187,6 +36122,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -35206,6 +36142,7 @@ }, "R-58424": { "description": "A VNF's Heat Orchestration Template's use of ``{network-role}``\nin all Resource property parameter names **MUST** be the same case.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}", "full_title": "", "hide_links": "", "id": "R-58424", @@ -35214,6 +36151,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "{network-role}", "sections": [ "{network-role}" @@ -35233,6 +36171,7 @@ }, "R-58670": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-58670", @@ -35241,6 +36180,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: image", "sections": [ "Property: image", @@ -35261,6 +36201,7 @@ }, "R-58775": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-58775", @@ -35269,6 +36210,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Testing", "sections": [ "Testing", @@ -35289,6 +36231,7 @@ }, "R-58964": { "description": "The VNF **MUST** provide the capability to restrict read\nand write access to data handled by the VNF.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-58964", @@ -35297,6 +36240,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Data Protection Requirements", "sections": [ "VNF Data Protection Requirements", @@ -35317,6 +36261,7 @@ }, "R-59391": { "description": "The VNF **MUST NOT** allow the assumption of the permissions of another\naccount to mask individual accountability. For example, use SUDO when a\nuser requires elevated permissions such as root or admin.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-59391", @@ -35325,6 +36270,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -35345,6 +36291,7 @@ }, "R-59434": { "description": "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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-59434", @@ -35353,6 +36300,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Neutron::Subnet", "sections": [ "OS::Neutron::Subnet", @@ -35374,6 +36322,7 @@ }, "R-59482": { "description": "A VNF's Heat Orchestration Template **MUST NOT** be VNF instance\nspecific or cloud site specific.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-59482", @@ -35382,6 +36331,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Scope of a Heat Orchestration Template", "sections": [ "Scope of a Heat Orchestration Template", @@ -35402,6 +36352,7 @@ }, "R-59568": { "description": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``availability_zone`` parameter **MUST NOT** be enumerated in the Heat\nOrchestration\nTemplate's Environment File.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-59568", @@ -35410,6 +36361,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Property: availability_zone", "sections": [ "Property: availability_zone", @@ -35430,6 +36382,7 @@ }, "R-59610": { "description": "The xNF **MUST** implement the data model discovery and\ndownload as defined in [RFC6022].", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-59610", @@ -35438,6 +36391,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -35460,6 +36414,7 @@ }, "R-59930": { "description": "A VNF's Heat Orchestration template's Environment File's\n**MAY** contain the ``parameter_defaults:`` section.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-59930", @@ -35468,6 +36423,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Environment File Format", "sections": [ "Environment File Format", @@ -35488,6 +36444,7 @@ }, "R-60011": { "description": "A VNF's Heat Orchestration Template **MUST** have no more than\ntwo levels of nesting.", + "docname": "Chapter5/Heat/ONAP Heat Template Constructs", "full_title": "", "hide_links": "", "id": "R-60011", @@ -35496,6 +36453,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Nested Heat Template Requirements", "sections": [ "Nested Heat Template Requirements", @@ -35517,6 +36475,7 @@ }, "R-60106": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-60106", @@ -35525,6 +36484,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -35547,6 +36507,7 @@ }, "R-60656": { "description": "The xNF **MUST** support sub tree filtering.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-60656", @@ -35555,6 +36516,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -35577,6 +36539,7 @@ }, "R-61001": { "description": "A shared Heat Orchestration Template resource is a resource that **MUST**\nbe defined in the base module and will be referenced by one or\nmore resources in one or more incremental modules.\n\nThe UUID of the shared resource (created in the base module) **MUST** be\nexposed by declaring a parameter in the\n``outputs`` section of the base module.\n\nFor ECOMP to provided the UUID value of the shared resource to the\nincremental module, the parameter name defined in the ``outputs``\nsection of the base module **MUST** be defined as a parameter\nin the ``parameters`` section of the incremental module.\n\nECOMP will capture the output parameter name and value in the base module\nand provide the value to the corresponding parameter(s) in the\nincremental module(s).", + "docname": "Chapter5/Heat/ONAP Heat VNF Modularity", "full_title": "", "hide_links": "", "id": "R-61001", @@ -35585,6 +36548,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP Heat VNF Modularity", "sections": [ "ONAP Heat VNF Modularity" @@ -35604,6 +36568,7 @@ }, "R-61354": { "description": "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.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-61354", @@ -35612,6 +36577,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -35632,6 +36598,7 @@ }, "R-62170": { "description": "The xNF **MUST** over-ride any default values for\nconfigurable parameters that can be set by ONAP in the roles,\ncookbooks and recipes.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-62170", @@ -35640,6 +36607,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Chef Roles/Requirements", "sections": [ "Chef Roles/Requirements", @@ -35662,6 +36630,7 @@ }, "R-62187": { "description": "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 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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-62187", @@ -35670,6 +36639,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::InstanceIp", "sections": [ "OS::ContrailV2::InstanceIp", @@ -35691,6 +36661,7 @@ }, "R-62300": { "description": "If a VNF has two or more ports that require a Virtual IP Address (VIP),\na VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``allowed_address_pairs``\nmap property ``ip_address`` parameter\n**MUST** be used.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-62300", @@ -35699,6 +36670,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: allowed_address_pairs, Map Property: ip_address", "sections": [ "Property: allowed_address_pairs, Map Property: ip_address", @@ -35719,6 +36691,7 @@ }, "R-62428": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-62428", @@ -35727,6 +36700,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "vnf_name", "sections": [ "vnf_name", @@ -35747,6 +36721,7 @@ }, "R-62468": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-62468", @@ -35755,6 +36730,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -35777,6 +36753,7 @@ }, "R-62498": { "description": "The VNF **MUST** support encrypted access protocols, e.g., TLS,\nSSH, SFTP.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-62498", @@ -35785,6 +36762,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -35805,6 +36783,7 @@ }, "R-62590": { "description": "The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nproperty ``fixed_ips``\nmap property ``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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-62590", @@ -35813,6 +36792,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -35833,6 +36813,7 @@ }, "R-62802": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-62802", @@ -35841,6 +36822,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ "Property: fixed_ips, Map Property: subnet", @@ -35861,6 +36843,7 @@ }, "R-629534": { "description": "The VNF **MUST** be capable of automatically synchronizing the system clock\ndaily with the Operator's trusted time source, to assure accurate time\nreporting in log files. It is recommended that Coordinated Universal Time\n(UTC) be used where possible, so as to eliminate ambiguity owing to daylight\nsavings time.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-629534", @@ -35869,6 +36852,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -35889,6 +36873,7 @@ }, "R-62954": { "description": "If a VNF's Heat Orchestration Template's ``OS::Nova::Server Resource``\n``metadata`` map value parameter ``environment_context`` is passed into a\nNested YAML\nfile, the parameter name ``environment_context`` **MUST NOT** change.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-62954", @@ -35897,6 +36882,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "environment_context", "sections": [ "environment_context", @@ -35917,6 +36903,7 @@ }, "R-62983": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-62983", @@ -35925,6 +36912,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: network", "sections": [ "Property: network", @@ -35945,6 +36933,7 @@ }, "R-63137": { "description": "VNF's Heat Orchestration Template's Resource **MAY** declare the\nattribute ``update_policy:``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-63137", @@ -35953,6 +36942,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "update_policy", "sections": [ "update_policy", @@ -35975,6 +36965,7 @@ }, "R-63229": { "description": "The xNF **MAY** use another option which is expected to include REST\nfor synchronous data, using RESTCONF (e.g., for xNF state polling).", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-63229", @@ -35983,6 +36974,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Addressing and Delivery Protocol", "sections": [ "Addressing and Delivery Protocol", @@ -36004,6 +36996,7 @@ }, "R-63330": { "description": "The VNF **MUST** detect when its security audit log storage\nmedium is approaching capacity (configurable) and issue an alarm.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-63330", @@ -36012,6 +37005,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -36032,6 +37026,7 @@ }, "R-63473": { "description": "The VNF **MUST** automatically advertise newly scaled\ncomponents so there is no manual intervention required.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-63473", @@ -36040,6 +37035,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "System Resource Optimization", "sections": [ "System Resource Optimization", @@ -36060,6 +37056,7 @@ }, "R-638216": { "description": "(Error Case) - The PNF **MUST** support a configurable timer to stop the\nperiodicity sending of the pnfRegistration VES event. If this timer expires\nduring a Service Configuration exchange between the PNF and ONAP, it\nMAY log a time-out error and notify an operator.\n\nNote: It is expected that each vendor will enforce and define a PNF\nservice configuration timeout period. This is because the PNF cannot\nwait indefinitely as there may also be a technician on-site trying to\ncomplete installation & commissioning. The management of the VES event\nexchange is also a requirement on the PNF to be developed by the PNF\nvendor.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-638216", @@ -36068,6 +37065,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -36088,6 +37086,7 @@ }, "R-638682": { "description": "The VNF **MUST** log any security event required by the VNF Requirements to\nSyslog using LOG_AUTHPRIV for any event that would contain sensitive\ninformation and LOG_AUTH for all other relevant events.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-638682", @@ -36096,6 +37095,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -36116,6 +37116,7 @@ }, "R-63935": { "description": "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).", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-63935", @@ -36124,6 +37125,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -36146,6 +37148,7 @@ }, "R-63953": { "description": "The xNF **MUST** have the echo command return a zero value\notherwise the validation has failed.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-63953", @@ -36154,6 +37157,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -36176,6 +37180,7 @@ }, "R-63956": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-63956", @@ -36184,6 +37189,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Items to Note", "sections": [ "Items to Note", @@ -36205,6 +37211,7 @@ }, "R-64197": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Heat::ResourceGroup``\nResource ID that creates sub-interfaces **MUST** use the naming convention\n\n* ``{vm-type}_{vm-type_index}_subint_{network-role}_port_{port-index}_subinterfaces``\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 networks\n that the sub-interfaces attach to\n* ``{port-index}`` is the instance of the the port on the vm-type\n attached to the network of ``{network-role}``", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-64197", @@ -36213,6 +37220,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Heat::ResourceGroup", "sections": [ "OS::Heat::ResourceGroup", @@ -36234,6 +37242,7 @@ }, "R-64445": { "description": "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.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-64445", @@ -36242,6 +37251,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Deployment Optimization", "sections": [ "Deployment Optimization", @@ -36258,11 +37268,11 @@ "type_name": "Requirement", "updated": "", "validated_by": "", - "validation_mode": "" }, "R-64713": { "description": "The VNF **SHOULD** support a software promotion methodology\nfrom dev/test -> pre-prod -> production in software, development &\ntesting and operations.", + "docname": "Chapter4/Devops", "full_title": "", "hide_links": "", "id": "R-64713", @@ -36271,6 +37281,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Devops", "sections": [ "VNF Devops" @@ -36290,6 +37301,7 @@ }, "R-64768": { "description": "The VNF **MUST** limit the size of application data packets\nto no larger than 9000 bytes for SDN network-based tunneling when\nguest data packets are transported between tunnel endpoints that\nsupport guest logical networks.", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-64768", @@ -36298,6 +37310,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -36317,6 +37330,7 @@ }, "R-65134": { "description": "The VNF **SHOULD** maintain state in a geographically\nredundant datastore that may, in fact, be its own VNFC.", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-65134", @@ -36325,6 +37339,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -36344,6 +37359,7 @@ }, "R-65486": { "description": "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.", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-65486", @@ -36352,6 +37368,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "General", "sections": [ "General", @@ -36373,6 +37390,7 @@ }, "R-65515": { "description": "The VNF **MUST** provide a mechanism and tool to start VNF\ncontainers (VMs) without impacting service or service quality assuming\nanother VNF in same or other geographical location is processing service\nrequests.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-65515", @@ -36381,6 +37399,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Application Resilient Error Handling", "sections": [ "Application Resilient Error Handling", @@ -36401,6 +37420,7 @@ }, "R-65516": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Nova::Keypair`` applies to\nall Virtual Machines in the the VNF, the Resource ID **SHOULD** use the naming\nconvention\n\n* ``{vnf-type}_keypair``\n\nwhere\n\n* ``{vnf-type}`` describes the VNF", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-65516", @@ -36409,6 +37429,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Nova::Keypair", "sections": [ "OS::Nova::Keypair", @@ -36430,6 +37451,7 @@ }, "R-65618": { "description": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::ServiceHealthCheck`` Resource ID **MAY** use the naming convention\n\n* ``{vm-type}_RSHC_{LEFT|RIGHT}``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``RSHC`` signifies that it is the Resource Service Health Check\n* ``LEFT`` is used if the Service Health Check is on the left interface\n* ``RIGHT`` is used if the Service Health Check is on the right interface", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-65618", @@ -36438,6 +37460,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::ServiceHealthCheck", "sections": [ "OS::ContrailV2::ServiceHealthCheck", @@ -36459,6 +37482,7 @@ }, "R-65641": { "description": "The xNF **MUST** support APPC/SDN-C ``UpgradeBackOut`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-65641", @@ -36467,6 +37491,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Lifecycle Management Related Commands", "sections": [ "Lifecycle Management Related Commands", @@ -36488,6 +37513,7 @@ }, "R-65755": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-65755", @@ -36496,6 +37522,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Chef Roles/Requirements", "sections": [ "Chef Roles/Requirements", @@ -36518,6 +37545,7 @@ }, "R-659655": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-659655", @@ -36526,6 +37554,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "xNF Telemetry using VES/JSON Model", "sections": [ "xNF Telemetry using VES/JSON Model", @@ -36547,6 +37576,7 @@ }, "R-66070": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-66070", @@ -36555,6 +37585,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Description", "sections": [ "Resource Description", @@ -36575,6 +37606,7 @@ }, "R-663631": { "description": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` value **MUST** be be obtained via a ``get_param``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-663631", @@ -36583,6 +37615,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: Name", "sections": [ "Property: Name", @@ -36603,6 +37636,7 @@ }, "R-66729": { "description": "A VNF's Heat Orchestration Template's Resource that is associated with a\nunique Virtual Machine type **MUST** include ``{vm-type}`` as part of the\nresource ID.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}", "full_title": "", "hide_links": "", "id": "R-66729", @@ -36611,6 +37645,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "{vm-type}", "sections": [ "{vm-type}" @@ -36630,6 +37665,7 @@ }, "R-66793": { "description": "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).", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-66793", @@ -36638,6 +37674,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -36660,6 +37697,7 @@ }, "R-67114": { "description": "The xNF **MUST** be installed with Chef-Client >= 12.0 and Chef\npush jobs client >= 2.0.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-67114", @@ -36668,6 +37706,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Chef Client Requirements", "sections": [ "Chef Client Requirements", @@ -36690,6 +37729,7 @@ }, "R-67124": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-67124", @@ -36698,6 +37738,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Client Requirements", "sections": [ "Ansible Client Requirements", @@ -36720,6 +37761,7 @@ }, "R-67231": { "description": "A VNF's Heat Orchestration template's Environment File's\n**MUST NOT** contain the ``resource_registry:`` section.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-67231", @@ -36728,6 +37770,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Environment File Format", "sections": [ "Environment File Format", @@ -36748,6 +37791,7 @@ }, "R-67386": { "description": "A VNF's Heat Orchestration Template's Resource **MAY** declare the\nattribute ``metadata``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-67386", @@ -36756,6 +37800,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "metadata", "sections": [ "metadata", @@ -36778,6 +37823,7 @@ }, "R-67597": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-67597", @@ -36786,6 +37832,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vm_role", "sections": [ "vm_role", @@ -36806,6 +37853,7 @@ }, "R-67709": { "description": "The VNF **MUST** be designed, built and packaged to enable\ndeployment across multiple fault zones (e.g., VNFCs deployed in\ndifferent servers, racks, OpenStack regions, geographies) so that\nin the event of a planned/unplanned downtime of a fault zone, the\noverall operation/throughput of the VNF is maintained.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-67709", @@ -36814,6 +37862,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "All Layer Redundancy", "sections": [ "All Layer Redundancy", @@ -36834,6 +37883,7 @@ }, "R-67793": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-67793", @@ -36842,6 +37892,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Resource IDs", "sections": [ "Resource IDs" @@ -36861,6 +37912,7 @@ }, "R-67895": { "description": "The VNFD provided by VNF vendor may use the below described TOSCA\ncapabilities. An on-boarding entity (ONAP SDC) **MUST** support them.\n\n **tosca.capabilities.nfv.VirtualBindable**\n\n A node type that includes the VirtualBindable capability indicates\n that it can be pointed by **tosca.relationships.nfv.VirtualBindsTo**\n relationship type.\n\n **tosca.capabilities.nfv.VirtualLinkable**\n\n A node type that includes the VirtualLinkable capability indicates\n that it can be pointed by **tosca.relationships.nfv.VirtualLinksTo**\n relationship.\n\n **tosca.capabilities.nfv.ExtVirtualLinkable**\n\n A node type that includes the ExtVirtualLinkable capability\n indicates that it can be pointed by\n **tosca.relationships.nfv.VirtualLinksTo** relationship.\n\n **Note**: This capability type is used in Casablanca how it does\n not exist in the last SOL001 draft\n\n **tosca.capabilities.nfv.VirtualCompute** and\n **tosca.capabilities.nfv.VirtualStorage** includes flavours of VDU", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-67895", @@ -36869,6 +37921,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Capability Types", "sections": [ "Capability Types", @@ -36890,6 +37943,7 @@ }, "R-67918": { "description": "The VNF **MUST** handle replication race conditions both locally\nand geo-located in the event of a data base instance failure to maintain\nservice continuity.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-67918", @@ -36898,6 +37952,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Application Resilient Error Handling", "sections": [ "Application Resilient Error Handling", @@ -36918,6 +37973,7 @@ }, "R-68023": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-68023", @@ -36926,6 +37982,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_name", "sections": [ "vf_module_name", @@ -36946,6 +38003,7 @@ }, "R-68122": { "description": "A VNF's incremental module **MAY** be deployed more than once,\neither during initial VNF deployment and/or scale out.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-68122", @@ -36954,6 +38012,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -36974,6 +38033,7 @@ }, "R-68165": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-68165", @@ -36982,6 +38042,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Security", "sections": [ "Security", @@ -37003,6 +38064,7 @@ }, "R-68198": { "description": "A VNF's Heat Orchestration template's Environment File's\n``parameters:`` section **MAY** (or **MAY NOT**) enumerate parameters.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-68198", @@ -37011,6 +38073,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Environment File Format", "sections": [ "Environment File Format", @@ -37031,6 +38094,7 @@ }, "R-68200": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-68200", @@ -37039,6 +38103,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -37061,6 +38126,7 @@ }, "R-68520": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``\nthat is creating a *Reserve Port* with an IPv6 address Resource ID **MUST**\nuse 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}``", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-68520", @@ -37069,6 +38135,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Neutron::Port", "sections": [ "OS::Neutron::Port", @@ -37090,6 +38157,7 @@ }, "R-686466": { "description": "The PNF **MUST** support sending a pnfRegistration VES event.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-686466", @@ -37098,6 +38166,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -37118,6 +38187,7 @@ }, "R-68936": { "description": "When a VNF creates an internal network, a network role, referred to as\nthe ``{network-role}`` **MUST** be assigned to the internal network\nfor use in the VNF's Heat Orchestration Template.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-68936", @@ -37126,6 +38196,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Internal Networks", "sections": [ "Internal Networks", @@ -37146,6 +38217,7 @@ }, "R-68990": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-68990", @@ -37154,6 +38226,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -37176,6 +38249,7 @@ }, "R-69014": { "description": "When a VNF connects to an external network, a network role, referred to\nas the ``{network-role}`` **MUST** be assigned to the external network for\nuse in the VNF's Heat Orchestration Template.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-69014", @@ -37184,6 +38258,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "External Networks", "sections": [ "External Networks", @@ -37204,6 +38279,7 @@ }, "R-69431": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-69431", @@ -37212,6 +38288,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: flavor", "sections": [ "Property: flavor", @@ -37232,6 +38309,7 @@ }, "R-69565": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-69565", @@ -37240,6 +38318,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Description", "sections": [ "Resource Description", @@ -37260,6 +38339,7 @@ }, "R-69588": { "description": "When a VNF's Heat Orchestration Template's Virtual Machine\n(i.e., ``OS::Nova::Server`` Resource) boots from Cinder Volume, the\n``OS::Nova::Server`` resource property\n``block_device_mapping`` or ``block_device_mapping_v2``\n**MUST** be used.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-69588", @@ -37268,6 +38348,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Boot Options", "sections": [ "Boot Options", @@ -37288,6 +38369,7 @@ }, "R-69610": { "description": "The VNF **MUST** provide the capability of using X.509 certificates\nissued by an external Certificate Authority.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-69610", @@ -37296,6 +38378,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Data Protection Requirements", "sections": [ "VNF Data Protection Requirements", @@ -37316,6 +38399,7 @@ }, "R-69634": { "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n``int_{network-role}_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-69634", @@ -37324,6 +38408,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ "Property: fixed_ips, Map Property: subnet", @@ -37344,6 +38429,7 @@ }, "R-69649": { "description": "The VNF Provider **MUST** have patches available for vulnerabilities\nin the VNF as soon as possible. Patching shall be controlled via change\ncontrol process with vulnerabilities disclosed along with\nmitigation recommendations.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-69649", @@ -37352,6 +38438,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -37372,6 +38459,7 @@ }, "R-69663": { "description": "A VNF **MAY** be composed from one or more Heat Orchestration\nTemplates, each of which represents a subset of the overall VNF.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-69663", @@ -37380,6 +38468,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -37400,6 +38489,7 @@ }, "R-697654": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-697654", @@ -37408,6 +38498,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "xNF Telemetry using Google Protocol Buffers", "sections": [ "xNF Telemetry using Google Protocol Buffers", @@ -37429,6 +38520,7 @@ }, "R-69874": { "description": "A VNF's ``{network-role}`` assigned to an internal network **MUST**\nbe different than the ``{network-role}`` assigned to the VNF's external\nnetworks.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-69874", @@ -37437,6 +38529,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Internal Networks", "sections": [ "Internal Networks", @@ -37457,6 +38550,7 @@ }, "R-69877": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-69877", @@ -37465,6 +38559,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -37485,6 +38580,7 @@ }, "R-70013": { "description": "The VNF **MUST NOT** require any manual steps to get it ready for\nservice after a container rebuild.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-70013", @@ -37493,6 +38589,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Application Resilient Error Handling", "sections": [ "Application Resilient Error Handling", @@ -37513,6 +38610,7 @@ }, "R-70112": { "description": "A VNF's Heat Orchestration Template **MUST** reference a Nested YAML\nfile by name. The use of ``resource_registry`` in the VNF's Heat\nOrchestration Templates Environment File **MUST NOT** be used.", + "docname": "Chapter5/Heat/ONAP Heat Template Constructs", "full_title": "", "hide_links": "", "id": "R-70112", @@ -37521,6 +38619,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Nested Heat Template Requirements", "sections": [ "Nested Heat Template Requirements", @@ -37542,6 +38641,7 @@ }, "R-70266": { "description": "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.)", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-70266", @@ -37550,6 +38650,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Asynchronous and Synchronous Data Delivery", "sections": [ "Asynchronous and Synchronous Data Delivery", @@ -37571,6 +38672,7 @@ }, "R-70276": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-70276", @@ -37579,6 +38681,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Nested Heat file", "sections": [ "Nested Heat file", @@ -37600,6 +38703,7 @@ }, "R-703767": { "description": "The VNF **MUST** have the capability to securely transmit the security logs\nand security events to a remote system before they are purged from the\nsystem.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-703767", @@ -37608,6 +38712,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -37628,6 +38733,7 @@ }, "R-70496": { "description": "The xNF **MUST** implement the protocol operation:\n``commit(confirmed, confirm-timeout)`` - Commit candidate\nconfiguration data store to the running configuration.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-70496", @@ -37636,6 +38742,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -37652,12 +38759,13 @@ "title": "", "title_from_content": "", "type_name": "Requirement", - "updated": "", + "updated": "casablanca", "validated_by": "", "validation_mode": "" }, "R-70757": { "description": "If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vm_role`` is passed into a Nested\nYAML\nfile, the key/value pair name ``vm_role`` **MUST NOT** change.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-70757", @@ -37666,6 +38774,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vm_role", "sections": [ "vm_role", @@ -37686,6 +38795,7 @@ }, "R-707977": { "description": "When the PNF receives a Service configuration from ONAP, the PNF **MUST**\ncease sending the pnfRegistration VES Event.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-707977", @@ -37694,6 +38804,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -37714,6 +38825,7 @@ }, "R-70933": { "description": "The VNF **MUST** provide the ability to migrate to newer\nversions of cryptographic algorithms and protocols with minimal impact.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-70933", @@ -37722,6 +38834,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Data Protection Requirements", "sections": [ "VNF Data Protection Requirements", @@ -37742,6 +38855,7 @@ }, "R-70964": { "description": "If a VNF's Port is attached to an internal network and the port's\nIP addresses are statically assigned by the VNF's Heat Orchestration\\\nTemplate (i.e., enumerated in the Heat Orchestration Template's\nenvironment file), the ``OS::Neutron::Port`` Resource's\n\n* property ``fixed_ips`` map property ``ip_address`` **MUST** be used\n* property ``fixed_ips`` map property ``subnet``\n **MUST NOT** be used", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-70964", @@ -37750,6 +38864,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Items to Note", "sections": [ "Items to Note", @@ -37771,6 +38886,7 @@ }, "R-71152": { "description": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``image`` parameter **MUST** be declared as type: ``string``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-71152", @@ -37779,6 +38895,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: image", "sections": [ "Property: image", @@ -37799,6 +38916,7 @@ }, "R-71493": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-71493", @@ -37807,6 +38925,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_id", "sections": [ "vf_module_id", @@ -37827,6 +38946,7 @@ }, "R-71577": { "description": "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\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\n * the value for ``{index}`` must start at zero (0) and increment by one", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-71577", @@ -37835,6 +38955,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -37855,6 +38976,7 @@ }, "R-71699": { "description": "A VNF's Heat Orchestration Template's Resource\n**MUST NOT** reference a HTTP-based Nested YAML file.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-71699", @@ -37863,6 +38985,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "type", "sections": [ "type", @@ -37885,6 +39008,7 @@ }, "R-71787": { "description": "Each architectural layer of the VNF (eg. operating system, network,\napplication) **MUST** support access restriction independently of all\nother layers so that Segregation of Duties can be implemented.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-71787", @@ -37893,6 +39017,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -37913,6 +39038,7 @@ }, "R-71842": { "description": "The VNF **MUST** include the field \"service or program used for\naccess\" in the Security alarms (where applicable and technically feasible).", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-71842", @@ -37921,6 +39047,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -37941,6 +39068,7 @@ }, "R-72184": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-72184", @@ -37949,6 +39077,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Chef Client Requirements", "sections": [ "Chef Client Requirements", @@ -37971,6 +39100,7 @@ }, "R-72483": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-72483", @@ -37979,6 +39109,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "vnf_name", "sections": [ "vnf_name", @@ -37999,6 +39130,7 @@ }, "R-72871": { "description": "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**\nbe enumerated in the Heat Orchestration Template's environment file.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-72871", @@ -38007,6 +39139,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_id", "sections": [ "vf_module_id", @@ -38027,6 +39160,7 @@ }, "R-73067": { "description": "The VNF **MUST** use NIST and industry standard cryptographic\nalgorithms and standard modes of operations when implementing\ncryptography.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-73067", @@ -38035,6 +39169,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Data Protection Requirements", "sections": [ "VNF Data Protection Requirements", @@ -38055,6 +39190,7 @@ }, "R-73213": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::Neutron::SecurityGroup`` that\nis applicable to more than one ``{vm-type}`` and one internal network Resource ID\n**SHOULD** use the naming convention\n\n* ``int_{network-role}_security_group``\n\nwhere\n\n* ``{network-role}`` is the network-role", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-73213", @@ -38063,6 +39199,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Neutron::SecurityGroup", "sections": [ "OS::Neutron::SecurityGroup", @@ -38084,6 +39221,7 @@ }, "R-73223": { "description": "The VNF **MUST** support proactive monitoring to detect and\nreport the attacks on resources so that the VNFs and associated VMs can\nbe isolated, such as detection techniques for resource exhaustion, namely\nOS resource attacks, CPU attacks, consumption of kernel memory, local\nstorage attacks.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-73223", @@ -38092,6 +39230,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -38112,6 +39251,7 @@ }, "R-73285": { "description": "The xNF **MUST** must encode, address and deliver the data\nas described in the previous paragraphs.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-73285", @@ -38120,6 +39260,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Asynchronous and Synchronous Data Delivery", "sections": [ "Asynchronous and Synchronous Data Delivery", @@ -38141,6 +39282,7 @@ }, "R-73364": { "description": "The VNF **MUST** support at least two major versions of the\nVNF software and/or sub-components to co-exist within production\nenvironments at any time so that upgrades can be applied across\nmultiple systems in a staggered manner.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-73364", @@ -38149,6 +39291,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Deployment Optimization", "sections": [ "Deployment Optimization", @@ -38169,6 +39312,7 @@ }, "R-73459": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-73459", @@ -38177,6 +39321,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Client Requirements", "sections": [ "Ansible Client Requirements", @@ -38199,6 +39344,7 @@ }, "R-73468": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-73468", @@ -38207,6 +39353,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -38229,6 +39376,7 @@ }, "R-73560": { "description": "The xNF Package **MUST** include documentation about monitoring\nparameters/counters exposed for virtual resource management and xNF\napplication management.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-73560", @@ -38237,6 +39385,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -38257,6 +39406,7 @@ }, "R-73583": { "description": "The VNF **MUST** allow changes of configuration parameters\nto be consumed by the VNF without requiring the VNF or its sub-components\nto be bounced so that the VNF availability is not effected.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-73583", @@ -38265,6 +39415,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Application Configuration Management", "sections": [ "Application Configuration Management", @@ -38285,6 +39436,7 @@ }, "R-74304": { "description": "A VNF's Heat Orchestration Template's Environment file extension **MUST**\nbe in the lower case format ``.env``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-74304", @@ -38293,6 +39445,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP Heat Orchestration Template Filenames", "sections": [ "ONAP Heat Orchestration Template Filenames", @@ -38313,6 +39466,7 @@ }, "R-74481": { "description": "The VNF **MUST NOT** require the use of a dynamic routing\nprotocol unless necessary to meet functional requirements.", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-74481", @@ -38321,6 +39475,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -38340,6 +39495,7 @@ }, "R-74712": { "description": "The VNF **MUST** utilize FQDNs (and not IP address) for\nboth Service Chaining and scaling.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-74712", @@ -38348,6 +39504,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "System Resource Optimization", "sections": [ "System Resource Optimization", @@ -38368,6 +39525,7 @@ }, "R-74763": { "description": "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>`__)", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-74763", @@ -38376,6 +39534,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -38396,6 +39555,7 @@ }, "R-74958": { "description": "The VNF **MUST** activate security alarms automatically when\nit detects an unsuccessful attempt to gain permissions\nor assume the identity of another user.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-74958", @@ -38404,6 +39564,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -38424,6 +39585,7 @@ }, "R-74978": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-74978", @@ -38432,6 +39594,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "workload_context", "sections": [ "workload_context", @@ -38452,6 +39615,7 @@ }, "R-75041": { "description": "The VNF **MUST**, if not integrated with the Operator's Identity and\nAccess Management system, support configurable password expiration.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-75041", @@ -38460,6 +39624,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -38480,6 +39645,7 @@ }, "R-75141": { "description": "A VNF's Heat Orchestration Template's resource name\n(i.e., <resource ID>) **MUST** only contain alphanumeric\ncharacters and underscores ('_').", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-75141", @@ -38488,6 +39654,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "resource ID", "sections": [ "resource ID", @@ -38510,6 +39677,7 @@ }, "R-75202": { "description": "If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``workload_context``\nis passed into a Nested YAML\nfile, the key/value pair name ``workload_context`` **MUST NOT** change.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-75202", @@ -38518,6 +39686,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "workload_context", "sections": [ "workload_context", @@ -38538,6 +39707,7 @@ }, "R-75343": { "description": "The VNF **MUST** provide the capability of testing the\nvalidity of a digital certificate by recognizing the identity represented\nby the certificate - the \"distinguished name\".", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-75343", @@ -38546,6 +39716,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Cryptography Requirements", "sections": [ "VNF Cryptography Requirements", @@ -38566,6 +39737,7 @@ }, "R-75608": { "description": "The xNF provider **MUST** provide playbooks to be loaded\non the appropriate Ansible Server.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-75608", @@ -38574,6 +39746,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Management via Ansible", "sections": [ "Configuration Management via Ansible", @@ -38595,6 +39768,7 @@ }, "R-756950": { "description": "The VNF **MUST** be operable without the use of Network File System (NFS).", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-756950", @@ -38603,6 +39777,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -38623,6 +39798,7 @@ }, "R-75850": { "description": "The VNF **SHOULD** decouple persistent data from the VNFC\nand keep it in its own datastore that can be reached by all instances\nof the VNFC requiring the data.", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-75850", @@ -38631,6 +39807,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -38650,6 +39827,7 @@ }, "R-75943": { "description": "The xNF **SHOULD** support the data schema defined in 3GPP TS 32.435, when\nsupporting the event-driven bulk transfer of monitoring data.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-75943", @@ -38658,6 +39836,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Bulk Performance Measurement", "sections": [ "Bulk Performance Measurement", @@ -38679,6 +39858,7 @@ }, "R-76014": { "description": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::ServiceHealthCheck``\nResource ID\n**MUST**\ncontain the ``{vm-type}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-76014", @@ -38687,6 +39867,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::ServiceHealthCheck", "sections": [ "OS::ContrailV2::ServiceHealthCheck", @@ -38708,6 +39889,7 @@ }, "R-76057": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-76057", @@ -38716,6 +39898,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Nested Heat file", "sections": [ "Nested Heat file", @@ -38737,6 +39920,7 @@ }, "R-76160": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-76160", @@ -38745,6 +39929,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ "Property: fixed_ips, Map Property: subnet", @@ -38765,6 +39950,7 @@ }, "R-763774": { "description": "The PNF **MUST** support a HTTPS connection to the DCAE VES Event\nListener.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-763774", @@ -38773,6 +39959,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -38793,6 +39980,7 @@ }, "R-76449": { "description": "A VNF's Heat Orchestration Template's **MUST NOT**\ncontain the Resource ``OS::Neutron::FloatingIPAssociation``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-76449", @@ -38801,6 +39989,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VIP Assignment, External Networks, Supported by Automation", "sections": [ "VIP Assignment, External Networks, Supported by Automation", @@ -38822,6 +40011,7 @@ }, "R-76682": { "description": "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 NOT** be enumerated in the VNF's Heat Orchestration Template's\nEnvironment File.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters", "full_title": "", "hide_links": "", "id": "R-76682", @@ -38830,6 +40020,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Interface Route Table Prefixes for Contrail InterfaceRoute Table", "sections": [ "Interface Route Table Prefixes for Contrail InterfaceRoute Table", @@ -38850,6 +40041,7 @@ }, "R-76718": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Template Constructs", "full_title": "", "hide_links": "", "id": "R-76718", @@ -38858,6 +40050,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Heat Files Support (get_file)", "sections": [ "Heat Files Support (get_file)", @@ -38878,6 +40071,7 @@ }, "R-76901": { "description": "The VNF **MUST** support a container rebuild mechanism based on existing\nimage (e.g. Glance image in Openstack environment) or a snapshot.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-76901", @@ -38886,6 +40080,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Virtual Function - Container Recovery Requirements", "sections": [ "Virtual Function - Container Recovery Requirements", @@ -38906,6 +40101,7 @@ }, "R-77334": { "description": "The VNF **MUST** allow configurations and configuration parameters\nto be managed under version control to ensure consistent configuration\ndeployment, traceability and rollback.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-77334", @@ -38914,6 +40110,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Application Configuration Management", "sections": [ "Application Configuration Management", @@ -38934,6 +40131,7 @@ }, "R-77667": { "description": "The VNF **MUST** test for adherence to the defined performance\nbudget at each layer, during each delivery cycle so that the performance\nbudget is measured and feedback is provided where the performance budget\nis not met.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-77667", @@ -38942,6 +40140,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Deployment Optimization", "sections": [ "Deployment Optimization", @@ -38962,6 +40161,7 @@ }, "R-77707": { "description": "The xNF provider **MUST** include a Manifest File that\ncontains a list of all the components in the xNF package.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-77707", @@ -38970,6 +40170,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Description", "sections": [ "Resource Description", @@ -38990,6 +40191,7 @@ }, "R-78010": { "description": "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.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-78010", @@ -38998,6 +40200,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -39018,6 +40221,7 @@ }, "R-78116": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-78116", @@ -39026,6 +40230,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Chef Roles/Requirements", "sections": [ "Chef Roles/Requirements", @@ -39048,6 +40253,7 @@ }, "R-78282": { "description": "The xNF **MUST** conform to the NETCONF RFC 6242,\n\"Using the Network Configuration Protocol over Secure Shell\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-78282", @@ -39056,6 +40262,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -39078,6 +40285,7 @@ }, "R-78380": { "description": "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\n network\n * the value for ``{index`` must start at zero (0) and increment by one", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-78380", @@ -39086,6 +40294,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -39106,6 +40315,7 @@ }, "R-78569": { "description": "VNF's Heat Orchestration Template's Resource **MAY** declare the\nattribute ``external_id:``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-78569", @@ -39114,6 +40324,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "external_id", "sections": [ "external_id", @@ -39136,6 +40347,7 @@ }, "R-79107": { "description": "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.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-79107", @@ -39144,6 +40356,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -39164,6 +40377,7 @@ }, "R-79224": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-79224", @@ -39172,6 +40386,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Chef Client Requirements", "sections": [ "Chef Client Requirements", @@ -39194,6 +40409,7 @@ }, "R-793716": { "description": "The PNF **MUST** have \"ONAP Aware\" software which is capable of performing\nPNF PnP registration with ONAP. The \"ONAP Aware\" software is capable of\nperforming the PNF PnP Registration with ONAP MUST either be loaded\nseparately or integrated into the PNF software upon physical delivery\nand installation of the PNF.\n\nNote: It is up to the specific vendor to design the software management\nfunctions.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-793716", @@ -39202,6 +40418,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -39222,6 +40439,7 @@ }, "R-79412": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-79412", @@ -39230,6 +40448,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Addressing and Delivery Protocol", "sections": [ "Addressing and Delivery Protocol", @@ -39251,6 +40470,7 @@ }, "R-79817": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-79817", @@ -39259,6 +40479,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "constraints", "sections": [ "constraints", @@ -39281,6 +40502,7 @@ }, "R-798933": { "description": "The xNF **SHOULD** deliver event records that fall into the event domains\nsupported by VES.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-798933", @@ -39289,6 +40511,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Transports and Protocols Supporting Resource Interfaces", "sections": [ "Transports and Protocols Supporting Resource Interfaces", @@ -39309,6 +40532,7 @@ }, "R-79952": { "description": "The VNF **SHOULD** support container snapshots if not for rebuild\nand evacuate for rollback or back out mechanism.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-79952", @@ -39317,6 +40541,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "All Layer Redundancy", "sections": [ "All Layer Redundancy", @@ -39337,6 +40562,7 @@ }, "R-80070": { "description": "The VNF **MUST** handle errors and exceptions so that they do\nnot interrupt processing of incoming VNF requests to maintain service\ncontinuity (where the error is not directly impacting the software\nhandling the incoming request).", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-80070", @@ -39345,6 +40571,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Application Resilient Error Handling", "sections": [ "Application Resilient Error Handling", @@ -39365,6 +40592,7 @@ }, "R-80335": { "description": "For all GUI and command-line interfaces, the VNF **MUST** provide the\nability to present a warning notice that is set by the Operator. A warning\nnotice is a formal statement of resource intent presented to everyone\nwho accesses the system.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-80335", @@ -39373,6 +40601,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -39393,6 +40622,7 @@ }, "R-80374": { "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty ``metadata`` key/value pair ``vf_module_name``\nparameter ``vf_module_name`` **MUST NOT**\nbe enumerated in the Heat Orchestration Template's environment file.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-80374", @@ -39401,6 +40631,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_name", "sections": [ "vf_module_name", @@ -39421,6 +40652,7 @@ }, "R-80829": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-80829", @@ -39429,6 +40661,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ "Property: fixed_ips, Map Property: subnet", @@ -39449,6 +40682,7 @@ }, "R-80898": { "description": "TThe xNF **MUST** support heartbeat via a <get> with null filter.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-80898", @@ -39457,6 +40691,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -39479,6 +40714,7 @@ }, "R-809261": { "description": "The PNF **MUST** use a IP address to contact ONAP.\n\nNote: it is expected that an ONAP operator can ascertain the ONAP IP\naddress or the security gateway to reach ONAP on the VID or ONAP portal\nGUI.\n\nNote: The ONAP contact IP address has been previously configured and\nprovisioned prior to this step.\n\nNote: The ONAP IP address could be provisioned or resolved through\nFQDN & DNS.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-809261", @@ -39487,6 +40723,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -39507,6 +40744,7 @@ }, "R-81147": { "description": "The VNF **MUST** support strong authentication, also known as\nmultifactor authentication, on all protected interfaces exposed by the\nVNF for use by human users. Strong authentication uses at least two of the\nthree different types of authentication factors in order to prove the\nclaimed identity of a user.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-81147", @@ -39515,6 +40753,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -39535,6 +40774,7 @@ }, "R-81214": { "description": "A VNF's Heat Orchestration Template's Resource\n``OS::ContrailV2::InterfaceRouteTable``\nResource ID\n**MUST**\ncontain the ``{network-role}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-81214", @@ -39543,6 +40783,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::InterfaceRouteTable", "sections": [ "OS::ContrailV2::InterfaceRouteTable", @@ -39564,6 +40805,7 @@ }, "R-81339": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-81339", @@ -39572,6 +40814,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Base Modules", "sections": [ "Base Modules", @@ -39593,6 +40836,7 @@ }, "R-814377": { "description": "The VNF **MUST** have the capability of allowing the Operator to create,\nmanage, and automatically provision user accounts using an Operator\napproved identity lifecycle management tool using a standard protocol,\ne.g., NETCONF API.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-814377", @@ -39601,6 +40845,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -39621,6 +40866,7 @@ }, "R-81725": { "description": "A VNF's Incremental Module **MUST** have a corresponding Environment File", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-81725", @@ -39629,6 +40875,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -39649,6 +40896,7 @@ }, "R-81777": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-81777", @@ -39657,6 +40905,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Addressing and Delivery Protocol", "sections": [ "Addressing and Delivery Protocol", @@ -39678,6 +40927,7 @@ }, "R-81979": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::NetworkIpam``\nResource ID **MAY** use the naming convention\n\n* ``{network-role}_RNI``\n\nwhere\n\n* ``{network-role}`` is the network-role\n* ``RNI`` signifies that it is the Resource Network IPAM", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-81979", @@ -39686,6 +40936,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::NetworkIpam", "sections": [ "OS::ContrailV2::NetworkIpam", @@ -39707,6 +40958,7 @@ }, "R-82018": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-82018", @@ -39715,6 +40967,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Client Requirements", "sections": [ "Ansible Client Requirements", @@ -39737,6 +40990,7 @@ }, "R-82115": { "description": "When a VNF's Heat Orchestration Template's resource is associated with a\nsingle ``{vm-type}``\nand a single external network, the Resource ID text **MUST** contain both\nthe ``{vm-type}``\nand the ``{network-role}``\n\n- the ``{vm-type}`` **MUST** appear before the ``{network-role}`` and\n **MUST** be separated by an underscore '_'\n\n\n - e.g., ``{vm-type}_{network-role}``, ``{vm-type}_{index}_{network-role}``\n\n\n- note that an ``{index}`` value **MAY** separate the ``{vm-type}`` and the\n ``{network-role}`` and when this occurs underscores **MUST** separate the\n three values. (e.g., ``{vm-type}_{index}_{network-role}``).", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-82115", @@ -39745,6 +40999,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource IDs", "sections": [ "Resource IDs" @@ -39764,6 +41019,7 @@ }, "R-82134": { "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` key/value pair ``vf_module_id`` parameter **MUST**\nbe declared as ``vf_module_id`` and the parameter **MUST**\nbe defined as type: ``string``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-82134", @@ -39772,6 +41028,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_id", "sections": [ "vf_module_id", @@ -39792,6 +41049,7 @@ }, "R-821473": { "description": "The xNF MUST produce heartbeat indicators consisting of events containing\nthe common event header only per the VES Listener Specification.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-821473", @@ -39800,6 +41058,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF telemetry via standardized interface", "sections": [ "VNF telemetry via standardized interface", @@ -39821,6 +41080,7 @@ }, "R-821839": { "description": "The xNF **MUST** deliver event records to ONAP using the common transport\nmechanisms and protocols defined in this document.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-821839", @@ -39829,6 +41089,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Transports and Protocols Supporting Resource Interfaces", "sections": [ "Transports and Protocols Supporting Resource Interfaces", @@ -39849,6 +41110,7 @@ }, "R-82223": { "description": "The VNF **MUST** be decomposed if the functions have\nsignificantly different scaling characteristics (e.g., signaling\nversus media functions, control versus data plane functions).", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-82223", @@ -39857,6 +41119,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -39876,6 +41139,7 @@ }, "R-82481": { "description": "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`` eight mandatory and optional\n ``metadata``\n parameters (i.e., ``vnf_name``, ``vnf_id``, ``vf_module_id``,\n ``vf_module_name``, ``vm_role``,\n ``vf_module_index``, ``environment_context``, ``workload_context``)\n **MUST NOT** be prefixed with a common ``{vm-type}`` identifier.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}", "full_title": "", "hide_links": "", "id": "R-82481", @@ -39884,6 +41148,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "{vm-type}", "sections": [ "{vm-type}" @@ -39903,6 +41168,7 @@ }, "R-82551": { "description": "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}``).", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-82551", @@ -39911,6 +41177,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource IDs", "sections": [ "Resource IDs" @@ -39930,6 +41197,7 @@ }, "R-82732": { "description": "A VNF Heat Orchestration Template's Cinder Volume Module **MUST**\nbe named identical to the base or incremental module it is supporting with\n``_volume`` appended.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-82732", @@ -39938,6 +41206,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Cinder Volume Modules", "sections": [ "Cinder Volume Modules", @@ -39959,6 +41228,7 @@ }, "R-82811": { "description": "The xNF **MUST** support APPC ``StartApplication`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-82811", @@ -39967,6 +41237,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Lifecycle Management Related Commands", "sections": [ "Lifecycle Management Related Commands", @@ -39988,6 +41259,7 @@ }, "R-83015": { "description": "A VNF's ``{network-role}`` assigned to an external network **MUST**\nbe different than the ``{network-role}`` assigned to the VNF's\ninternal networks, if internal networks exist.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-83015", @@ -39996,6 +41268,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "External Networks", "sections": [ "External Networks", @@ -40016,6 +41289,7 @@ }, "R-83146": { "description": "The xNF **MUST** support APPC ``StopApplication`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-83146", @@ -40024,6 +41298,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Lifecycle Management Related Commands", "sections": [ "Lifecycle Management Related Commands", @@ -40045,6 +41320,7 @@ }, "R-83227": { "description": "The VNF **MUST** Provide the capability to encrypt data in\ntransit on a physical or virtual network.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-83227", @@ -40053,6 +41329,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Data Protection Requirements", "sections": [ "VNF Data Protection Requirements", @@ -40073,6 +41350,7 @@ }, "R-83412": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-83412", @@ -40081,6 +41359,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VIP Assignment, External Networks, Supported by Automation", "sections": [ "VIP Assignment, External Networks, Supported by Automation", @@ -40102,6 +41381,7 @@ }, "R-83418": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-83418", @@ -40110,6 +41390,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VIP Assignment, External Networks, Supported by Automation", "sections": [ "VIP Assignment, External Networks, Supported by Automation", @@ -40131,6 +41412,7 @@ }, "R-83500": { "description": "The VNF **MUST** provide the capability of allowing certificate\nrenewal and revocation.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-83500", @@ -40139,6 +41421,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Cryptography Requirements", "sections": [ "VNF Cryptography Requirements", @@ -40159,6 +41442,7 @@ }, "R-83677": { "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n``{network-role}_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-83677", @@ -40167,6 +41451,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ "Property: fixed_ips, Map Property: subnet", @@ -40187,6 +41472,7 @@ }, "R-83706": { "description": "When a VNF's Heat Orchestration Template's Virtual Machine\n(i.e., ``OS::Nova::Server`` resource) boots from an image, the\n``OS::Nova::Server`` resource property ``image`` **MUST** be used.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-83706", @@ -40195,6 +41481,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Boot Options", "sections": [ "Boot Options", @@ -40215,6 +41502,7 @@ }, "R-83790": { "description": "The xNF **MUST** implement the ``:validate`` capability.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-83790", @@ -40223,6 +41511,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -40245,6 +41534,7 @@ }, "R-83873": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-83873", @@ -40253,6 +41543,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -40275,6 +41566,7 @@ }, "R-84123": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-84123", @@ -40283,6 +41575,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ "Property: fixed_ips, Map Property: subnet", @@ -40303,6 +41596,7 @@ }, "R-84160": { "description": "The VNF **MUST** have security logging for VNFs and their\nOSs be active from initialization. Audit logging includes automatic\nroutines to maintain activity records and cleanup programs to ensure\nthe integrity of the audit/logging systems.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-84160", @@ -40311,6 +41605,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -40331,6 +41626,7 @@ }, "R-841740": { "description": "The xNF **SHOULD** support FileReady VES event for event-driven bulk transfer\nof monitoring data.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-841740", @@ -40339,6 +41635,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Bulk Performance Measurement", "sections": [ "Bulk Performance Measurement", @@ -40360,6 +41657,7 @@ }, "R-842258": { "description": "The VNF **MUST** include a configuration, e.g., a heat template or CSAR\npackage, that specifies the targetted parameters, e.g. a limited set of\nports, over which the VNF will communicate (including internal, external\nand management communication).", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-842258", @@ -40368,6 +41666,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -40388,6 +41687,7 @@ }, "R-84322": { "description": "A VNF's Heat Orchestration Template's Resource property parameter that\nis associated with an internal network **MUST** include\n``int_{network-role}`` as part of the parameter name,\nwhere ``int_`` is a hard coded string.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}", "full_title": "", "hide_links": "", "id": "R-84322", @@ -40396,6 +41696,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "{network-role}", "sections": [ "{network-role}" @@ -40415,6 +41716,7 @@ }, "R-84366": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-84366", @@ -40423,6 +41725,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Description", "sections": [ "Resource Description", @@ -40438,10 +41741,12 @@ "title_from_content": "", "type_name": "Requirement", "updated": "", - "validated_by": "", "validation_mode": "" + "validated_by": "", + "validation_mode": "" }, "R-844011": { "description": "The VNF MUST not store authentication credentials to itself in clear\ntext or any reversible form and must use salting.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-844011", @@ -40450,6 +41755,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -40470,6 +41776,7 @@ }, "R-84457": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::PortTuple``\nResource ID **MAY** use the naming convention\n\n* ``{vm-type}_RPT``\n\nwhere\n\n* ``{vm-type}`` is the vm-type\n* ``RPT`` signifies that it is the Resource Port Tuple", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-84457", @@ -40478,6 +41785,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::PortTuple", "sections": [ "OS::ContrailV2::PortTuple", @@ -40499,6 +41807,7 @@ }, "R-84473": { "description": "The VNF **MUST** enable DPDK in the guest OS for VNF's requiring\nhigh packets/sec performance. High packet throughput is defined as greater\nthan 500K packets/sec.", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-84473", @@ -40507,6 +41816,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -40526,6 +41836,7 @@ }, "R-84517": { "description": "The Contrail GUI has a limitation displaying special characters.\nThe issue is documented in\nhttps://bugs.launchpad.net/juniperopenstack/+bug/1590710.\nIt is recommended that special **SHOULD** characters be avoided.\nHowever, if special characters must be used, note that for\nthe following resources:\n\n* Virtual Machine\n* Virtual Network\n* Port\n* Security Group\n* Policies\n* IPAM Creation\n\nthe only special characters supported\nare - \\\" ! $\\ \\ ' ( ) = ~ ^ | @ ` { } [ ] > , . _\"", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource Property", "full_title": "", "hide_links": "", "id": "R-84517", @@ -40534,6 +41845,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Contrail Issue with Values for the Property Name", "sections": [ "Contrail Issue with Values for the Property Name", @@ -40554,6 +41866,7 @@ }, "R-84879": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-84879", @@ -40562,6 +41875,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Addressing and Delivery Protocol", "sections": [ "Addressing and Delivery Protocol", @@ -40583,6 +41897,7 @@ }, "R-85235": { "description": "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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-85235", @@ -40591,6 +41906,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -40611,6 +41927,7 @@ }, "R-85328": { "description": "A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property\n``metadata`` **MAY**\ncontain the key/value pair ``vm_role`` and the value **MUST** be\nobtained either via\n\n- ``get_param``\n- hard coded in the key/value pair ``vm_role``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-85328", @@ -40619,6 +41936,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "vm_role", "sections": [ "vm_role", @@ -40639,6 +41957,7 @@ }, "R-85419": { "description": "The VNF **SHOULD** support OAuth 2.0 authorization using an external\nAuthorization Server.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-85419", @@ -40647,6 +41966,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -40667,6 +41987,7 @@ }, "R-85653": { "description": "The xNF **MUST** provide metrics (e.g., number of sessions,\nnumber of subscribers, number of seats, etc.) to ONAP for tracking\nevery license.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-85653", @@ -40675,6 +41996,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Licensing Requirements", "sections": [ "Licensing Requirements", @@ -40695,6 +42017,7 @@ }, "R-85734": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource Property", "full_title": "", "hide_links": "", "id": "R-85734", @@ -40703,6 +42026,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Property \u201cname\u201d", "sections": [ "Resource Property \u201cname\u201d" @@ -40722,6 +42046,7 @@ }, "R-85800": { "description": "When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``name`` parameter is defined as a ``comma_delimited_list``,\na parameter **MUST** be delcared once for all ``OS::Nova::Server`` resources\nassociated with the ``{vm-type}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-85800", @@ -40730,6 +42055,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: Name", "sections": [ "Property: Name", @@ -40747,8 +42073,10 @@ "updated": "casablanca", "validated_by": "", "validation_mode": "static" - }, "R-859208": { + }, + "R-859208": { "description": "The VNF **MUST** log automated remote activities performed with\nelevated privileges.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-859208", @@ -40757,6 +42085,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -40777,6 +42106,7 @@ }, "R-85959": { "description": "The VNF **SHOULD** automatically enable/disable added/removed\nsub-components or component so there is no manual intervention required.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-85959", @@ -40785,6 +42115,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "System Resource Optimization", "sections": [ "System Resource Optimization", @@ -40805,6 +42136,7 @@ }, "R-85991": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-85991", @@ -40813,6 +42145,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Licensing Requirements", "sections": [ "Licensing Requirements", @@ -40833,6 +42166,7 @@ }, "R-86182": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-86182", @@ -40841,6 +42175,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: network", "sections": [ "Property: network", @@ -40861,6 +42196,7 @@ }, "R-86235": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-86235", @@ -40869,6 +42205,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -40889,6 +42226,7 @@ }, "R-86237": { "description": "If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource\nproperty\n``metadata`` key/value pair ``vf_module_id`` is passed into a\nNested YAML\nfile, the key/value pair name ``vf_module_id`` **MUST NOT** change.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-86237", @@ -40897,6 +42235,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_id", "sections": [ "vf_module_id", @@ -40917,6 +42256,7 @@ }, "R-86261": { "description": "The VNF **MUST** support the ability to prohibit remote access to the VNF\nvia a host based security mechanism.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-86261", @@ -40925,6 +42265,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -40945,6 +42286,7 @@ }, "R-86285": { "description": "A VNF's Heat Orchestration template **MUST** have a\ncorresponding environment file.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-86285", @@ -40953,6 +42295,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Environment File Format", "sections": [ "Environment File Format", @@ -40973,6 +42316,7 @@ }, "R-86476": { "description": "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., '_').", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-86476", @@ -40981,6 +42325,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "vm_role", "sections": [ "vm_role", @@ -41001,6 +42346,7 @@ }, "R-86497": { "description": "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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-86497", @@ -41009,6 +42355,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Cinder::VolumeAttachment", "sections": [ "OS::Cinder::VolumeAttachment", @@ -41030,6 +42377,7 @@ }, "R-86585": { "description": "The VNFC **SHOULD** minimize the use of state within\na VNFC to facilitate the movement of traffic from one instance\nto another.", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-86585", @@ -41038,6 +42386,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -41057,6 +42406,7 @@ }, "R-86586": { "description": "The xNF **MUST** use the YANG configuration models and RESTCONF\n[RFC8040] (https://tools.ietf.org/html/rfc8040).", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-86586", @@ -41065,6 +42415,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Asynchronous and Synchronous Data Delivery", "sections": [ "Asynchronous and Synchronous Data Delivery", @@ -41086,6 +42437,7 @@ }, "R-86588": { "description": "A VNF's Heat Orchestration Template's ``{network-role}`` case in Resource\nproperty parameter names **SHOULD** match the case of ``{network-role}``\nin Resource IDs and vice versa.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}", "full_title": "", "hide_links": "", "id": "R-86588", @@ -41094,6 +42446,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "{network-role}", "sections": [ "{network-role}" @@ -41113,6 +42466,7 @@ }, "R-86758": { "description": "The VNF **SHOULD** provide an automated test suite to validate\nevery new version of the software on the target environment(s). The tests\nshould be of sufficient granularity to independently test various\nrepresentative VNF use cases throughout its lifecycle. Operations might\nchoose to invoke these tests either on a scheduled basis or on demand to\nsupport various operations functions including test, turn-up and\ntroubleshooting.", + "docname": "Chapter4/Devops", "full_title": "", "hide_links": "", "id": "R-86758", @@ -41121,6 +42475,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Devops", "sections": [ "VNF Devops" @@ -41140,6 +42495,7 @@ }, "R-86835": { "description": "The VNF **MUST** set the default settings for user access\nto deny authorization, except for a super user type of account.\nWhen a VNF is added to the network, nothing should be able to use\nit until the super user configures the VNF to allow other users\n(human and application) have access.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-86835", @@ -41148,6 +42504,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -41168,6 +42525,7 @@ }, "R-86926": { "description": "A VNF's incremental module **MAY** be used for scale out only.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-86926", @@ -41176,6 +42534,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -41196,6 +42555,7 @@ }, "R-86972": { "description": "A VNF **SHOULD** create the internal network in the VNF's Heat\nOrchestration Template Base Module.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-86972", @@ -41204,6 +42564,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Internal Networks", "sections": [ "Internal Networks", @@ -41224,6 +42585,7 @@ }, "R-87004": { "description": "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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-87004", @@ -41232,6 +42594,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "OS::Cinder::Volume", "sections": [ "OS::Cinder::Volume", @@ -41253,6 +42616,7 @@ }, "R-87096": { "description": "A VNF **MAY** contain zero, one or more than one internal network.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-87096", @@ -41261,6 +42625,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Internal Networks", "sections": [ "Internal Networks", @@ -41281,6 +42646,7 @@ }, "R-87123": { "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_{network-role}_v6_ip_{index}``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-87123", @@ -41289,6 +42655,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -41309,6 +42676,7 @@ }, "R-87234": { "description": "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,", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-87234", @@ -41317,6 +42685,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Package Structure and Format", "sections": [ "VNF Package Structure and Format", @@ -41338,6 +42707,7 @@ }, "R-87247": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-87247", @@ -41346,6 +42716,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Incremental Modules", "sections": [ "Incremental Modules", @@ -41364,8 +42735,10 @@ "updated": "casablanca", "validated_by": "", "validation_mode": "static" - }, "R-872986": { + }, + "R-872986": { "description": "The VNF **MUST** store Authentication Credentials used to authenticate to\nother systems encrypted except where there is a technical need to store\nthe password unencrypted in which case it must be protected using other\nsecurity techniques that include the use of file and directory permissions.\nIdeally, credentials SHOULD rely on a HW Root of Trust, such as a\nTPM or HSM.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-872986", @@ -41374,6 +42747,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -41394,6 +42768,7 @@ }, "R-87352": { "description": "The VNF **SHOULD** utilize Cloud health checks, when available\nfrom the Network Cloud, from inside the application through APIs to check\nthe network connectivity, dropped packets rate, injection, and auto failover\nto alternate sites if needed.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-87352", @@ -41402,6 +42777,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Monitoring & Dashboard", "sections": [ "Monitoring & Dashboard", @@ -41422,6 +42798,7 @@ }, "R-87485": { "description": "A VNF's Heat Orchestration Template's file extension **MUST**\nbe in the lower case format ``.yaml`` or ``.yml``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-87485", @@ -41430,6 +42807,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP Heat Orchestration Template Filenames", "sections": [ "ONAP Heat Orchestration Template Filenames", @@ -41450,6 +42828,7 @@ }, "R-87563": { "description": "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 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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-87563", @@ -41458,6 +42837,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::InstanceIp", "sections": [ "OS::ContrailV2::InstanceIp", @@ -41479,6 +42859,7 @@ }, "R-87564": { "description": "The xNF **SHOULD** conform its YANG model to RFC 7317,\n\"A YANG Data Model for System Management\".", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-87564", @@ -41487,6 +42868,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -41509,6 +42891,7 @@ }, "R-87817": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-87817", @@ -41517,6 +42900,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: Name", "sections": [ "Property: Name", @@ -41537,6 +42921,7 @@ }, "R-87848": { "description": "When using the intrinsic function get_file, ONAP does not support\na directory hierarchy for included files. All files must be in a\nsingle, flat directory per VNF. A VNF's Heat Orchestration\nTemplate's ``get_file`` target files **MUST** be in the same\ndirectory hierarchy as the VNF's Heat Orchestration Templates.", + "docname": "Chapter5/Heat/ONAP Heat Template Constructs", "full_title": "", "hide_links": "", "id": "R-87848", @@ -41545,6 +42930,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Heat Files Support (get_file)", "sections": [ "Heat Files Support (get_file)", @@ -41565,6 +42951,7 @@ }, "R-88026": { "description": "The xNF **MUST** include a NETCONF server enabling\nruntime configuration and lifecycle management capabilities.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-88026", @@ -41573,6 +42960,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Management", "sections": [ "Configuration Management", @@ -41595,6 +42983,7 @@ }, "R-88031": { "description": "The xNF **SHOULD** implement the protocol operation:\n``delete-config(target)`` - Delete the named configuration\ndata store target.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-88031", @@ -41603,6 +42992,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -41619,12 +43009,13 @@ "title": "", "title_from_content": "", "type_name": "Requirement", - "updated": "", + "updated": "casablanca", "validated_by": "", "validation_mode": "" }, "R-88199": { "description": "The VNF **MUST** utilize a persistent datastore service that\ncan meet the data performance/latency requirements. (For example:\nDatastore service could be a VNFC in VNF or a DBaaS in the Cloud\nexecution environment)", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-88199", @@ -41633,6 +43024,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -41652,6 +43044,7 @@ }, "R-88482": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-88482", @@ -41660,6 +43053,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Addressing and Delivery Protocol", "sections": [ "Addressing and Delivery Protocol", @@ -41681,6 +43075,7 @@ }, "R-88524": { "description": "A VNF's Heat Orchestration Template's Volume Template\nOutput Parameter names\n**MUST** contain ``{vm-type}`` when appropriate.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names", "full_title": "", "hide_links": "", "id": "R-88524", @@ -41689,6 +43084,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP Volume Template Output Parameters:", "sections": [ "ONAP Volume Template Output Parameters:", @@ -41709,6 +43105,7 @@ }, "R-88536": { "description": "A VNF's Heat Orchestration Template's OS::Nova::Server\nResource **SHOULD** contain the metadata map value parameter\n'environment_context'.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-88536", @@ -41717,6 +43114,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "environment_context", "sections": [ "environment_context", @@ -41737,6 +43135,7 @@ }, "R-88540": { "description": "A VNF's Heat Orchestration Template's Resource ``OS::ContrailV2::InstanceIp``\nthat is configuring an IPv6 Address on a sub-interface port attached to a\nsub-interface network Resource ID **MUST**\nuse the naming convention\n\n* ``{vm-type}_{vm-type_index}_subint_{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 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", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-88540", @@ -41745,6 +43144,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::InstanceIp", "sections": [ "OS::ContrailV2::InstanceIp", @@ -41766,6 +43166,7 @@ }, "R-88863": { "description": "A VNF's Heat Orchestration Template's parameter defined\nin a non-nested YAML file as type\n``number`` **MUST** have a parameter constraint of ``range`` or\n``allowed_values`` defined.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-88863", @@ -41774,6 +43175,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "constraints", "sections": [ "constraints", @@ -41796,6 +43198,7 @@ }, "R-88899": { "description": "The xNF **MUST** support simultaneous <commit> operations\nwithin the context of this locking requirements framework.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-88899", @@ -41804,6 +43207,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -41826,6 +43230,7 @@ }, "R-89010": { "description": "The VNF **MUST** survive any single points of software failure\ninternal to the VNF (e.g., in memory structures, JMS message queues).", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-89010", @@ -41834,6 +43239,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "All Layer Redundancy", "sections": [ "All Layer Redundancy", @@ -41854,6 +43260,7 @@ }, "R-894004": { "description": "When the PNF sets up a HTTP or HTTPS connection, it **MUST** provide a\nusername 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.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-894004", @@ -41862,6 +43269,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -41882,6 +43290,7 @@ }, "R-89474": { "description": "The VNF **MUST** log the field \"Login ID\" in the security audit logs.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-89474", @@ -41890,6 +43299,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -41910,6 +43320,7 @@ }, "R-89571": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-89571", @@ -41918,6 +43329,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Configuration", "sections": [ "Resource Configuration", @@ -41938,6 +43350,7 @@ }, "R-89800": { "description": "The VNF **MUST NOT** require Hypervisor-level customization\nfrom the cloud provider.", + "docname": "Chapter4/Devops", "full_title": "", "hide_links": "", "id": "R-89800", @@ -41946,6 +43359,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Devops", "sections": [ "VNF Devops" @@ -41965,6 +43379,7 @@ }, "R-89913": { "description": "A VNF's Heat Orchestration Template's Cinder Volume Module Output\nParameter(s)\n**MUST** include the\nUUID(s) of the Cinder Volumes created in template,\nwhile others **MAY** be included.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-89913", @@ -41973,6 +43388,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP Volume Module Output Parameters", "sections": [ "ONAP Volume Module Output Parameters", @@ -41994,6 +43410,7 @@ }, "R-90007": { "description": "The xNF **MUST** implement the protocol operation:\n``close-session()`` - Gracefully close the current session.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-90007", @@ -42002,6 +43419,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -42018,12 +43436,13 @@ "title": "", "title_from_content": "", "type_name": "Requirement", - "updated": "", + "updated": "casablanca", "validated_by": "", "validation_mode": "" }, "R-90022": { "description": "A VNF's Nested YAML file **MAY** be invoked more than\nonce by a VNF's Heat Orchestration Template.", + "docname": "Chapter5/Heat/ONAP Heat Template Constructs", "full_title": "", "hide_links": "", "id": "R-90022", @@ -42032,6 +43451,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Nested Heat Template Requirements", "sections": [ "Nested Heat Template Requirements", @@ -42053,6 +43473,7 @@ }, "R-901331": { "description": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty ``image`` value **MUST** be be obtained via a ``get_param``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-901331", @@ -42061,6 +43482,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: image", "sections": [ "Property: image", @@ -42081,6 +43503,7 @@ }, "R-90152": { "description": "A VNF's Heat Orchestration Template's\n``resources:`` section **MUST** contain the declaration of at\nleast one resource.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-90152", @@ -42089,6 +43512,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "resources", "sections": [ "resources", @@ -42110,6 +43534,7 @@ }, "R-90206": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-90206", @@ -42118,6 +43543,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -42138,6 +43564,7 @@ }, "R-90279": { "description": "A VNF Heat Orchestration's template's parameter **MUST** be used\nin a resource with the exception of the parameters for the\n``OS::Nova::Server`` resource property ``availability_zone``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-90279", @@ -42146,6 +43573,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "parameters", "sections": [ "parameters", @@ -42167,6 +43595,7 @@ }, "R-90526": { "description": "A VNF Heat Orchestration Template parameter declaration **MUST NOT**\ncontain the ``default`` attribute.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-90526", @@ -42175,6 +43604,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "default", "sections": [ "default", @@ -42197,6 +43627,7 @@ }, "R-90632": { "description": "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.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-90632", @@ -42205,6 +43636,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Control Loop", "sections": [ "Resource Control Loop", @@ -42225,6 +43657,7 @@ }, "R-90748": { "description": "A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume\n**MAY** be defined in an Incremental Module.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-90748", @@ -42233,6 +43666,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -42253,6 +43687,7 @@ }, "R-908291": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-908291", @@ -42261,6 +43696,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Bulk Telemetry Transmission", "sections": [ "Bulk Telemetry Transmission", @@ -42282,6 +43718,7 @@ }, "R-91125": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-91125", @@ -42290,6 +43727,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: image", "sections": [ "Property: image", @@ -42310,6 +43748,7 @@ }, "R-91273": { "description": "A VNF Heat Orchestration's template's parameter for the\n``OS::Nova::Server`` resource property ``availability_zone``\n**MAY NOT** be used in any ``OS::Nova::Server``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-91273", @@ -42318,6 +43757,7 @@ "keyword": "MAY NOT", "links": [], "notes": "", + "parts": {}, "section_name": "parameters", "sections": [ "parameters", @@ -42339,6 +43779,7 @@ }, "R-91342": { "description": "A VNF Heat Orchestration Template's Base Module's Environment File\n**MUST** be named identical to the VNF Heat Orchestration Template's\nBase Module with ``.y[a]ml`` replaced with ``.env``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-91342", @@ -42347,6 +43788,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Base Modules", "sections": [ "Base Modules", @@ -42368,6 +43810,7 @@ }, "R-91497": { "description": "A VNF's incremental module **MAY** be used for both deployment and\nscale out.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-91497", @@ -42376,6 +43819,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP VNF Modularity Overview", "sections": [ "ONAP VNF Modularity Overview", @@ -42396,6 +43840,7 @@ }, "R-91745": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-91745", @@ -42404,6 +43849,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Client Requirements", "sections": [ "Ansible Client Requirements", @@ -42420,12 +43866,13 @@ "title": "", "title_from_content": "", "type_name": "Requirement", - "updated": "", + "updated": "casablanca", "validated_by": "", "validation_mode": "" }, "R-91810": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-91810", @@ -42434,6 +43881,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "VIP Assignment, External Networks, Supported by Automation", "sections": [ "VIP Assignment, External Networks, Supported by Automation", @@ -42455,6 +43903,7 @@ }, "R-92193": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Contrail Resource Parameters", "full_title": "", "hide_links": "", "id": "R-92193", @@ -42463,6 +43912,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "External Networks", "sections": [ "External Networks", @@ -42484,6 +43934,7 @@ }, "R-92207": { "description": "The VNF **SHOULD** provide a mechanism that enables the operators to\nperform automated system configuration auditing at configurable time\nintervals.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-92207", @@ -42492,6 +43943,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -42512,6 +43964,7 @@ }, "R-92571": { "description": "The VNF **MUST** provide operational instrumentation such as\nlogging, so as to facilitate quick resolution of issues with the VNF to\nprovide service continuity.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-92571", @@ -42520,6 +43973,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Monitoring & Dashboard", "sections": [ "Monitoring & Dashboard", @@ -42540,6 +43994,7 @@ }, "R-92635": { "description": "A VNF's Heat Orchestration Template **MUST** be compliant with the\nOpenStack Template Guide.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-92635", @@ -42548,6 +44003,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP Heat Orchestration Template Format", "sections": [ "ONAP Heat Orchestration Template Format" @@ -42567,6 +44023,7 @@ }, "R-92866": { "description": "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).", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-92866", @@ -42575,6 +44032,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Client Requirements", "sections": [ "Ansible Client Requirements", @@ -42597,6 +44055,7 @@ }, "R-92935": { "description": "The VNF **SHOULD** minimize the propagation of state information\nacross multiple data centers to avoid cross data center traffic.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-92935", @@ -42605,6 +44064,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "Minimize Cross Data-Center Traffic", "sections": [ "Minimize Cross Data-Center Traffic", @@ -42625,6 +44085,7 @@ }, "R-93030": { "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_{network-role}_v6_ips``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-93030", @@ -42633,6 +44094,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -42653,6 +44115,7 @@ }, "R-931076": { "description": "The VNF **MUST** support account names that contain at least A-Z, a-z,\n0-9 character sets and be at least 6 characters in length.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-931076", @@ -42661,6 +44124,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -42681,6 +44145,7 @@ }, "R-93177": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-93177", @@ -42689,6 +44154,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: network", "sections": [ "Property: network", @@ -42709,6 +44175,7 @@ }, "R-932071": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-932071", @@ -42717,6 +44184,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Transports and Protocols Supporting Resource Interfaces", "sections": [ "Transports and Protocols Supporting Resource Interfaces", @@ -42737,6 +44205,7 @@ }, "R-93272": { "description": "A VNF **MAY** have one or more ports connected to a unique\nexternal network. All VNF ports connected to the unique external\nnetwork **MUST** have cloud assigned IP Addresses\nor **MUST** have ONAP SDN-C assigned IP addresses.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-93272", @@ -42745,6 +44214,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Items to Note", "sections": [ "Items to Note", @@ -42766,6 +44236,7 @@ }, "R-93443": { "description": "The xNF **MUST** define all data models in YANG [RFC6020],\nand the mapping to NETCONF shall follow the rules defined in this RFC.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-93443", @@ -42774,6 +44245,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -42796,6 +44268,7 @@ }, "R-93496": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-93496", @@ -42804,6 +44277,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -42824,6 +44298,7 @@ }, "R-93860": { "description": "The VNF **SHOULD** provide the capability to integrate with an\nexternal encryption service.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-93860", @@ -42832,6 +44307,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Cryptography Requirements", "sections": [ "VNF Cryptography Requirements", @@ -42852,6 +44328,7 @@ }, "R-94084": { "description": "The xNF **MUST** support APPC/SDN-C ``ConfigScaleOut`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-94084", @@ -42860,6 +44337,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Commands", "sections": [ "Configuration Commands", @@ -42881,6 +44359,7 @@ }, "R-94509": { "description": "A VNF Heat Orchestration Template's Incremental Module's Environment File\n**MUST** be named identical to the VNF Heat Orchestration Template's\nIncremental Module with ``.y[a]ml`` replaced with ``.env``.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-94509", @@ -42889,6 +44368,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Incremental Modules", "sections": [ "Incremental Modules", @@ -42910,6 +44390,7 @@ }, "R-94525": { "description": "The VNF **MUST** log connections to the network listeners of the\nresource.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-94525", @@ -42918,6 +44399,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -42938,6 +44420,7 @@ }, "R-94567": { "description": "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.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-94567", @@ -42946,6 +44429,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Client Requirements", "sections": [ "Ansible Client Requirements", @@ -42968,6 +44452,7 @@ }, "R-94669": { "description": "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``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names", "full_title": "", "hide_links": "", "id": "R-94669", @@ -42976,6 +44461,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OAM Management IP Addresses", "sections": [ "OAM Management IP Addresses", @@ -42997,6 +44483,7 @@ }, "R-94978": { "description": "The VNF **MUST** provide a mechanism and tool to perform a graceful\nshutdown of all the containers (VMs) in the VNF without impacting service\nor service quality assuming another VNF in same or other geographical\nlocation can take over traffic and process service requests.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-94978", @@ -43005,6 +44492,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Application Resilient Error Handling", "sections": [ "Application Resilient Error Handling", @@ -43025,6 +44513,7 @@ }, "R-952314": { "description": "If the PNF set up a TLS connection and mutual (two-way) authentication is\nbeing used, then the PNF **MUST** provide its own X.509v3 Certificate to\nthe DCAE VES Collector for authentication.\n\nNote: This allows TLS authentication by DCAE VES Collector.\n\nNote: The PNF got its X.509 certificate through Enrollment with an\noperator certificate authority or a X.509 vendor certificate from the\nvendor factory CA.\n\nNote: In R3 three authentication options are supported:\n\n(1) HTTP with Username & Password and no TLS.\n\n(2) HTTP with Username & Password & TLS with two-way certificate\n authentication.\n\n(3) HTTP with Username & Password & TLS with server-side\n certificate authentication.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-952314", @@ -43033,6 +44522,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -43053,6 +44543,7 @@ }, "R-95303": { "description": "A VNF's Heat Orchestration Template **MUST** be defined using valid YAML.", + "docname": "Chapter5/Heat/General Guidelines for Heat", "full_title": "", "hide_links": "", "id": "R-95303", @@ -43061,6 +44552,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "YAML Format", "sections": [ "YAML Format", @@ -43081,6 +44573,7 @@ }, "R-95321": { "description": "The VNFD provided by VNF vendor may use the below described TOSCA\nrelationships. An on-boarding entity (ONAP SDC) **MUST** support them.\n\n **tosca.relationships.nfv.VirtualBindsTo**\n\n This relationship type represents an association relationship between\n VDU and CP node types.\n\n **tosca.relationships.nfv.VirtualLinksTo**\n\n This relationship type represents an association relationship between\n the VduCpd's and VirtualLinkDesc node types.", + "docname": "Chapter5/Tosca", "full_title": "", "hide_links": "", "id": "R-95321", @@ -43089,6 +44582,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Relationship Types", "sections": [ "Relationship Types", @@ -43110,6 +44604,7 @@ }, "R-95430": { "description": "If a VNF's Heat Orchestration Template's ``OS::Nova::Server``\nresource property\n``metadata`` key/value pair ``vm_role`` value is obtained via\n``get_param``, the parameter **MUST** be declared as ``vm_role``\nand the parameter **MUST** be defined as type: ``string``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-95430", @@ -43118,6 +44613,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "vm_role", "sections": [ "vm_role", @@ -43138,6 +44634,7 @@ }, "R-95864": { "description": "The VNF **MUST** support digital certificates that comply with X.509\nstandards.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-95864", @@ -43146,6 +44643,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Data Protection Requirements", "sections": [ "VNF Data Protection Requirements", @@ -43166,6 +44664,7 @@ }, "R-95950": { "description": "The xNF **MUST** provide a NETCONF interface fully defined\nby supplied YANG models for the embedded NETCONF server.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-95950", @@ -43174,6 +44673,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Configuration Management", "sections": [ "Configuration Management", @@ -43196,6 +44696,7 @@ }, "R-96227": { "description": "A VNF's Heat Orchestration Template's parameter defined\nin a non-nested YAML file as type\n``json`` **MAY** have a parameter constraint defined.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Template Format", "full_title": "", "hide_links": "", "id": "R-96227", @@ -43204,6 +44705,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "constraints", "sections": [ "constraints", @@ -43226,6 +44728,7 @@ }, "R-96253": { "description": "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 the vmi on the vm-type\n attached to the network of ``{network-role}``", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-96253", @@ -43234,6 +44737,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::VirtualMachineInterface", "sections": [ "OS::ContrailV2::VirtualMachineInterface", @@ -43255,6 +44759,7 @@ }, "R-96482": { "description": "When a VNF's Heat Orchestration Template's resource is associated\nwith a single external network, the Resource ID **MUST** contain the text\n``{network-role}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-96482", @@ -43263,6 +44768,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource IDs", "sections": [ "Resource IDs" @@ -43282,6 +44788,7 @@ }, "R-96554": { "description": "The xNF **MUST** implement the protocol operation:\n``unlock(target)`` - Unlock the configuration data store target.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-96554", @@ -43290,6 +44797,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -43306,12 +44814,13 @@ "title": "", "title_from_content": "", "type_name": "Requirement", - "updated": "", + "updated": "casablanca", "validated_by": "", "validation_mode": "" }, "R-96634": { "description": "The xNF provider **MUST** describe scaling capabilities\nto manage scaling characteristics of the xNF.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-96634", @@ -43320,6 +44829,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Compute, Network, and Storage Requirements", "sections": [ "Compute, Network, and Storage Requirements", @@ -43340,6 +44850,7 @@ }, "R-96983": { "description": "A VNF's Heat Orchestration Template's Resource ID that is associated\nwith an internal network **MUST** include ``int_{network-role}`` as part\nof the Resource ID, where ``int_`` is a hard coded string.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{network-role}", "full_title": "", "hide_links": "", "id": "R-96983", @@ -43348,6 +44859,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "{network-role}", "sections": [ "{network-role}" @@ -43367,6 +44879,7 @@ }, "R-97102": { "description": "The VNF Package **MUST** include VM requirements via a Heat\ntemplate that provides the necessary data for VM specifications\nfor all VNF components - for hypervisor, CPU, memory, storage.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-97102", @@ -43375,6 +44888,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Compute, Network, and Storage Requirements", "sections": [ "Compute, Network, and Storage Requirements", @@ -43395,6 +44909,7 @@ }, "R-97201": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-97201", @@ -43403,6 +44918,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -43423,6 +44939,7 @@ }, "R-97293": { "description": "The xNF provider **MUST NOT** require audits\nof Service Provider's business.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-97293", @@ -43431,6 +44948,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Licensing Requirements", "sections": [ "Licensing Requirements", @@ -43451,6 +44969,7 @@ }, "R-97343": { "description": "The xNF **MUST** support APPC/SDN-C ``UpgradeBackup`` command.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-97343", @@ -43459,6 +44978,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Lifecycle Management Related Commands", "sections": [ "Lifecycle Management Related Commands", @@ -43480,6 +45000,7 @@ }, "R-97345": { "description": "The xNF **MUST** permit authentication, using root account, only right\nafter instantiation and until post-instantiation configuration is\ncompleted.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-97345", @@ -43488,6 +45009,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Client Requirements", "sections": [ "Ansible Client Requirements", @@ -43510,6 +45032,7 @@ }, "R-97445": { "description": "The VNF **MUST** log the field \"date/time\" in the security audit\nlogs.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-97445", @@ -43518,6 +45041,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -43538,6 +45062,7 @@ }, "R-97451": { "description": "The xNF **MUST** provide the ability to remove root access once\npost-instantiation configuration (Configure) is completed.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-97451", @@ -43546,6 +45071,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Ansible Client Requirements", "sections": [ "Ansible Client Requirements", @@ -43568,6 +45094,7 @@ }, "R-97529": { "description": "The xNF **SHOULD** implement the protocol operation:\n``get-schema(identifier, version, format)`` - Retrieve the YANG schema.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-97529", @@ -43576,6 +45103,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "NETCONF Server Requirements", "sections": [ "NETCONF Server Requirements", @@ -43598,6 +45126,7 @@ }, "R-97726": { "description": "A VNF's Heat Orchestration Template's Base Module Output Parameter names\n**MUST** contain ``{vm-type}`` and/or ``{network-role}`` when appropriate.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/ONAP Output Parameter Names", "full_title": "", "hide_links": "", "id": "R-97726", @@ -43606,6 +45135,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP Base Module Output Parameters:", "sections": [ "ONAP Base Module Output Parameters:", @@ -43626,6 +45156,7 @@ }, "R-978752": { "description": "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", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-978752", @@ -43634,6 +45165,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Google Protocol Buffers (GPB)", "sections": [ "Google Protocol Buffers (GPB)", @@ -43655,6 +45187,7 @@ }, "R-980039": { "description": "The PNF **MUST** send the pnfRegistration VES event periodically.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-980039", @@ -43663,6 +45196,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -43683,6 +45217,7 @@ }, "R-98138": { "description": "When a VNF's Heat Orchestration Template's resource is associated with a\nsingle internal network, the Resource ID **MUST** contain the text\n``int_{network-role}``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-98138", @@ -43691,6 +45226,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource IDs", "sections": [ "Resource IDs" @@ -43710,6 +45246,7 @@ }, "R-981585": { "description": "The pnfRegistration VES event periodicity **MUST** be configurable.\n\nNote: The PNF uses the service configuration request as a semaphore to\nstop sending the pnfRegistration sent. See the requirement PNP-5360\nrequirement.", + "docname": "Chapter7/PNF-Plug-and-Play", "full_title": "", "hide_links": "", "id": "R-981585", @@ -43718,6 +45255,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "PNF Plug and Play", "sections": [ "PNF Plug and Play", @@ -43738,6 +45276,7 @@ }, "R-98191": { "description": "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.", + "docname": "Chapter7/Monitoring-And-Management", "full_title": "", "hide_links": "", "id": "R-98191", @@ -43746,6 +45285,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Reporting Frequency", "sections": [ "Reporting Frequency", @@ -43767,6 +45307,7 @@ }, "R-98374": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Metadata Parameters", "full_title": "", "hide_links": "", "id": "R-98374", @@ -43775,6 +45316,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "vf_module_id", "sections": [ "vf_module_id", @@ -43795,6 +45337,7 @@ }, "R-98391": { "description": "The VNF **MUST**, if not integrated with the Operator's Identity and\nAccess Management system, support Role-Based Access Control to enforce\nleast privilege.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-98391", @@ -43803,6 +45346,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -43823,6 +45367,7 @@ }, "R-98407": { "description": "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_``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/{vm-type}", "full_title": "", "hide_links": "", "id": "R-98407", @@ -43831,6 +45376,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "{vm-type}", "sections": [ "{vm-type}" @@ -43850,6 +45396,7 @@ }, "R-98450": { "description": "The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``\nproperty\n``availability_zone`` parameter name **MUST** follow the naming convention\n``availability_zone_{index}`` where the ``{index}``\n**MUST** start at zero and\nincrement by one.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-98450", @@ -43858,6 +45405,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: availability_zone", "sections": [ "Property: availability_zone", @@ -43878,6 +45426,7 @@ }, "R-98569": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-98569", @@ -43886,6 +45435,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -43906,6 +45456,7 @@ }, "R-98617": { "description": "The xNF provider **MUST** provide information regarding any\ndependency (e.g., affinity, anti-affinity) with other xNFs and resources.", + "docname": "Chapter7/VNF-On-boarding-and-package-management", "full_title": "", "hide_links": "", "id": "R-98617", @@ -43914,6 +45465,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Description", "sections": [ "Resource Description", @@ -43934,6 +45486,7 @@ }, "R-98748": { "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``allowed_address_pairs``\nmap property ``ip_address`` parameter\n**MUST** be declared as type ``string``.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-98748", @@ -43942,6 +45495,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VIP Assignment, External Networks, Supported by Automation", "sections": [ "VIP Assignment, External Networks, Supported by Automation", @@ -43963,6 +45517,7 @@ }, "R-98905": { "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``ip_address`` parameter\n``{vm-type}_{network-role}_ips``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters", "full_title": "", "hide_links": "", "id": "R-98905", @@ -43971,6 +45526,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Property: fixed_ips, Map Property: ip_address", "sections": [ "Property: fixed_ips, Map Property: ip_address", @@ -43991,6 +45547,7 @@ }, "R-98911": { "description": "The xNF **MUST NOT** use any instance specific parameters\nfor the xNF in roles/cookbooks/recipes invoked for a xNF action.", + "docname": "Chapter7/Configuration-Management", "full_title": "", "hide_links": "", "id": "R-98911", @@ -43999,6 +45556,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Chef Roles/Requirements", "sections": [ "Chef Roles/Requirements", @@ -44021,6 +45579,7 @@ }, "R-98989": { "description": "The VNF **SHOULD** utilize resource pooling (threads,\nconnections, etc.) within the VNF application so that resources\nare not being created and destroyed resulting in resource management\noverhead.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-98989", @@ -44029,6 +45588,7 @@ "keyword": "SHOULD", "links": [], "notes": "", + "parts": {}, "section_name": "System Resource Optimization", "sections": [ "System Resource Optimization", @@ -44049,6 +45609,7 @@ }, "R-99110": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource IDs", "full_title": "", "hide_links": "", "id": "R-99110", @@ -44057,6 +45618,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "OS::ContrailV2::VirtualNetwork", "sections": [ "OS::ContrailV2::VirtualNetwork", @@ -44078,6 +45640,7 @@ }, "R-99174": { "description": "The VNF **MUST**, if not integrated with the Operator's Identity and\nAccess Management system, support the creation of multiple IDs so that\nindividual accountability can be supported.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-99174", @@ -44086,6 +45649,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Identity and Access Management Requirements", "sections": [ "VNF Identity and Access Management Requirements", @@ -44106,6 +45670,7 @@ }, "R-99646": { "description": "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.", + "docname": "Chapter5/Heat/ONAP Heat Orchestration Templates Overview", "full_title": "", "hide_links": "", "id": "R-99646", @@ -44114,6 +45679,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "ONAP Heat Orchestration Template Filenames", "sections": [ "ONAP Heat Orchestration Template Filenames", @@ -44134,6 +45700,7 @@ }, "R-99656": { "description": "The VNF **MUST** NOT terminate stable sessions if a VNFC\ninstance fails.", + "docname": "Chapter4/Design", "full_title": "", "hide_links": "", "id": "R-99656", @@ -44142,6 +45709,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Design", "sections": [ "VNF Design" @@ -44161,6 +45729,7 @@ }, "R-99730": { "description": "The VNF **MUST** include the field \"Login ID\" in the Security\nalarms (where applicable and technically feasible).", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-99730", @@ -44169,6 +45738,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF Security Analytics Requirements", "sections": [ "VNF Security Analytics Requirements", @@ -44189,6 +45759,7 @@ }, "R-99766": { "description": "The VNF **MUST** allow configurations and configuration parameters\nto be managed under version control to ensure the ability to rollback to\na known valid configuration.", + "docname": "Chapter4/Resiliency", "full_title": "", "hide_links": "", "id": "R-99766", @@ -44197,6 +45768,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "Application Configuration Management", "sections": [ "Application Configuration Management", @@ -44217,6 +45789,7 @@ }, "R-99771": { "description": "The VNF **MUST** have all code (e.g., QCOW2) and configuration files\n(e.g., HEAT template, Ansible playbook, script) hardened, or with\ndocumented recommended configurations for hardening and interfaces that\nallow the Operator to harden the VNF. Actions taken to harden a system\ninclude disabling all unnecessary services, and changing default values\nsuch as default credentials and community strings.", + "docname": "Chapter4/Security", "full_title": "", "hide_links": "", "id": "R-99771", @@ -44225,6 +45798,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "VNF General Security Requirements", "sections": [ "VNF General Security Requirements", @@ -44245,6 +45819,7 @@ }, "R-99794": { "description": "An external network **MUST** have one subnet. An external network\n**MAY** have more than one subnet.", + "docname": "Chapter5/Heat/ONAP Heat Networking", "full_title": "", "hide_links": "", "id": "R-99794", @@ -44253,6 +45828,7 @@ "keyword": "MUST", "links": [], "notes": "", + "parts": {}, "section_name": "External Networks", "sections": [ "External Networks", @@ -44273,6 +45849,7 @@ }, "R-99798": { "description": "A VNF's Heat Orchestration Template's Virtual Machine\n(i.e., ``OS::Nova::Server`` resource) **MAY** boot from an image or\n**MAY** boot from a Cinder Volume.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Nova Parameters", "full_title": "", "hide_links": "", "id": "R-99798", @@ -44281,6 +45858,7 @@ "keyword": "MAY", "links": [], "notes": "", + "parts": {}, "section_name": "Boot Options", "sections": [ "Boot Options", @@ -44301,6 +45879,7 @@ }, "R-99812": { "description": "A value for VNF's Heat Orchestration Template's property ``name``\nfor a non ``OS::Nova::Server`` resource **MUST NOT** be declared\nin the VNF's Heat Orchestration Template's Environment File.", + "docname": "Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Resource Property", "full_title": "", "hide_links": "", "id": "R-99812", @@ -44309,6 +45888,7 @@ "keyword": "MUST NOT", "links": [], "notes": "", + "parts": {}, "section_name": "Resource Property \u201cname\u201d", "sections": [ "Resource Property \u201cname\u201d" |