When introducing significant changes to the VNF Requirements project or changes that may require discussion. It recommended that a Proposal be created. The wiki page will be the place to collaborate and track changes as the proposal is reviewed, revised, and ultimately accepted or rejected.
Please follow these steps when creating a proposal.
- Copy the Proposal Template and create a page under the Proposals section of the VNF Requirements Wiki.
- Update the content of your proposal and set the status to Draft
- Create a JIRA ticket in the VNF Requirements project announcing the ticket, and put a reference to the ticket on the Proposals page
- Project: VNF Requirements
- Issue Type: Task
- Summary: Proposal Review:Title of Proposal
- Description: Link to proposal
The VNF Requirements Project maintains repos for the source documentation of various deliverable:
...
- ONAP VNF Guidelines
...
- ONAP VNF Requirements
...
- Mapping VNF use cases and with E2E Release A use cases
...
- ONAP VNF Requirements Test Descriptions
VNF Guidelines Document Outline
- Introduction
- VNF Context
- VNF Characteristics
- Summary
VNF Requirements Document Outline
- Introduction
- VNF Design
- VNF Resiliency
- VNF Security
- VNF Modularity
- Devops
- Heat Guidelines
- TOSCA
- ONAP Service Design Time Requirements on VNFs
- Configuration Management
- Monitoring & Management
- Data Record Formats
EPIC statement structure for requirements
For each requirement adopt a standardized numbering scheme, and format
...
For each use case adopt a standardized format
- Title
- Requirement #
- summary
- Actors (VNF, Operator, ONAP Platform etc.)
- Preconditions
- Operational sequence ( e.g. Message Sequence chart + text explanations)
- Post conditions
Test Case Description Template
- Title
- Requirement #
- Use Case #
- summary
- ONAP Actors (VNF, Operator, ONAP Platform components etc.)
- Preconditions ( ONAP, VNF states, test equipment/ data patterns, measurements)
- Operational sequence ( e.g. Message Sequence chart + text explanations)
- Post conditions (any post processing of the measurements, any cleanup of the ONAP configuration, reset of the test equipment etc.)
- Test Result decision ( measurement decision criteria )