VNF Documentation Requirements

These are the 33 requirements from Casablanca containing the string "document".

~22 of these clearly reference VNF Package documentations requirements. The remaining ~11 use documentation in some other context e.g. referencing specifications . Some rewording of these 11 requirements ( red with Marked X in the table below) for editorial clarity may be helpful. Whether the remaining 22 should be retargeted to a new, more specific requirement target e.g.VNF Package Documentation is for further study.

ID	Content	Target	Keyword	Section Name	Reword
R-821839	The xNF MUST deliver event records to ONAP using the common transport mechanisms and protocols defined in this document.	XNF	MUST	Transports and Protocols Supporting Resource Interfaces	X
R-99771	The VNF MUST have all code (e.g., QCOW2) and configuration files (e.g., HEAT template, Ansible playbook, script) hardened, or with documented recommended configurations for hardening and interfaces that allow the Operator to harden the VNF. Actions taken to harden a system include disabling all unnecessary services, and changing default values such as default credentials and community strings.	VNF	MUST	VNF General Security Requirements	X
R-84517	The Contrail GUI has a limitation displaying special characters. The issue is documented in https://bugs.launchpad.net/juniperopenstack/+bug/1590710. It is recommended that special SHOULD characters be avoided. However, if special characters must be used, note that for the following resources: * Virtual Machine * Virtual Network * Port * Security Group * Policies * IPAM Creation the only special characters supported are - \" ! $\ \ ' ( ) = ~ ^ \| @ ` { } [ ] > , . _"	VNF	SHOULD	Contrail Issue with Values for the Property Name	X
R-74763	The xNF provider MUST provide an artifact per xNF that contains all of the xNF Event Records supported. The artifact should include reference to the specific release of the xNF Event Stream Common Event Data Model document it is based on. (e.g., `VES Event Listener <https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/VESEventListener.html>`__)	XNF	MUST	Resource Control Loop	X
R-65486	The VNFD MUST comply with ETSI GS NFV-SOL001 document endorsing the above mentioned NFV Profile and maintaining the gaps with the requirements specified in ETSI GS NFV-IFA011 standard.	VNF	MUST	General	X
R-56920	The VNF MUST protect all security audit logs (including API, OS and application-generated logs), security audit software, data, and associated documentation from modification, or unauthorized viewing, by standard OS access control mechanisms, by sending to a remote system, or by encryption.	VNF	MUST	VNF Security Analytics Requirements	X
R-53317	The xNF MUST conform its YANG model to RFC 6087, "Guidelines for Authors and Reviewers of YANG Data Model Documents".	XNF	MUST	NETCONF Server Requirements	X
R-47849	The xNF provider MUST support the metadata about licenses (and their applicable entitlements) as defined in this document for xNF software, and any license keys required to authorize use of the xNF software. This metadata will be used to facilitate onboarding the xNF into the ONAP environment and automating processes for putting the licenses into use and managing the full lifecycle of the licenses. The details of this license model are described in Tables C1 to C8 in the Appendix. Note: License metadata support in ONAP is not currently available and planned for 1Q 2018.	XNF	MUST	Licensing Requirements	X
R-34957	The VNF MUST provide a method of metrics gathering for each layer's performance to identify/document variances in the allocations so they can be addressed.	VNF	MUST	Monitoring & Dashboard	X
R-384337	The VNF documentation MUST contain a list of the files within the VNF package that are static during the VNF's runtime.	VNF	MUST	Resource Description
R-90632	The xNF Package MUST include documentation about KPIs and metrics that need to be collected at each VM for capacity planning and performance management purposes.	XNF	MUST	Resource Control Loop
R-86235	The xNF Package MUST include documentation about the monitoring parameters that must include latencies, success rates, retry rates, load and quality (e.g., DPM) for the key transactions/functions supported by the xNF and those that must be exercised by the xNF in order to perform its function.	XNF	MUST	Resource Control Loop
R-84366	The xNF Package MUST include documentation describing xNF Functional APIs that are utilized to build network and application services. This document describes the externally exposed functional inputs and outputs for the xNF, including interface format and protocols supported.	XNF	MUST	Resource Description
R-73560	The xNF Package MUST include documentation about monitoring parameters/counters exposed for virtual resource management and xNF application management.	XNF	MUST	Resource Control Loop
R-69877	The xNF Package MUST include documentation for each KPI, identify the suggested actions that need to be performed when a threshold crossing alert event is recorded.	XNF	MUST	Resource Control Loop
R-69565	The xNF Package MUST include documentation describing xNF Management APIs, which must include information and tools for ONAP to deploy and configure (initially and ongoing) the xNF application(s) (e.g., NETCONF APIs) which includes a description of configurable parameters for the xNF and whether the parameters can be configured after xNF instantiation.	XNF	MUST	Resource Description
R-56815	The xNF Package MUST include documentation describing supported xNF scaling capabilities and capacity limits (e.g., number of users, bandwidth, throughput, concurrent calls).	XNF	MUST	Resource Control Loop
R-53598	The xNF Package MUST include documentation to, when relevant, provide a threshold crossing alert point for each KPI and describe the significance of the threshold crossing.	XNF	MUST	Resource Control Loop
R-48596	The xNF Package MUST include documentation describing the characteristics for the xNF reliability and high availability.	XNF	MUST	Resource Control Loop
R-43958	The xNF Package MUST include documentation describing the tests that were conducted by the xNF provider and the test results.	XNF	MUST	Testing
R-42018	The xNF Package MUST include documentation which must include all events (fault, measurement for xNF Scaling, Syslogs, State Change and 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.	XNF	MUST	Resource Control Loop
R-36280	The xNF provider MUST provide documentation describing xNF Functional Capabilities that are utilized to operationalize the xNF and compose complex services.	XNF	MUST	Resource Description
R-35960	The xNF Package MUST include documentation which must include all events, severity level (e.g., informational, warning, error) and descriptions including causes/fixes if applicable for the event.	XNF	MUST	Resource Control Loop
R-33904	The xNF Package MUST include documentation for each KPI, provide lower and upper limits.	XNF	MUST	Resource Control Loop
R-33694	The xNF Package MUST include documentation to when applicable, provide calculators needed to convert raw data into appropriate reporting artifacts.	XNF	MUST	Resource Control Loop
R-22888	The xNF provider MUST provide documentation for the xNF Policy Description to manage the xNF runtime lifecycle. The document must include a description of how the policies (conditions and actions) are implemented in the xNF.	XNF	MUST	Resource Control Loop
R-22680	The xNF Package MUST include documentation that describes any requirements for the monitoring component of tools for Network Cloud automation and management to provide these records to components of the xNF.	XNF	MUST	Resource Control Loop
R-16875	The xNF Package MUST include documentation which must include a unique identification string for the specific xNF, a description of the problem that caused the error, and steps or procedures to perform Root Cause Analysis and resolve the issue.	XNF	MUST	Resource Control Loop
R-12678	The xNF Package MUST include documentation which includes a description of runtime lifecycle events and related actions (e.g., control responses, tests) which can be performed for the xNF.	XNF	MUST	Resource Description
R-01556	The xNF Package MUST include documentation describing the fault, performance, capacity events/alarms and other event records that are made available by the xNF.	XNF	MUST	Resource Control Loop
R-01478	The xNF Package MUST include documentation describing all parameters that are available to monitor the xNF after instantiation (includes all counters, OIDs, PM data, KPIs, etc.) that must be collected for reporting purposes.	XNF	MUST	Resource Control Loop
R-00156	The xNF Package MUST include documentation describing xNF Management APIs, which must include information and tools for ONAP to monitor the health of the xNF (conditions that require healing and/or scaling responses).	XNF	MUST	Resource Description
R-00068	The xNF Package MUST include documentation which includes a description of parameters that can be monitored for the xNF and event records (status, fault, flow, session, call, control plane, etc.) generated by the xNF after instantiation.	XNF	MUST	Resource Description