The VNF Requirements Project maintains repos for the source documentation of various deliverable:
Repo | Published for | Description | EPIC supported | Deliverable document Title(s) |
---|---|---|---|---|
/guidelines | External audience | This is aspirational, forward looking, narrative text for use in prototype RFP text. | VNFRQTS-6 |
|
/requirements | External Audience | This is narrative text for use in prototype RFP text. | VNFRQTS-6 |
|
/epics | Internal Audience | Formalized requirements descriptions e.g. "As a ROLE I need SOMETHING so that SOME PURPOSE IS REALIZED" | see Project Charter | |
/usecases | Internal audience | This is a template structure providing a context for specific requirements. This illustrates behavior, sequences of operation, variants, error conditions, etc. There may be multiple use cases associated with a single requirement. Documents VNF specific use cases in support of ONAP E2E use cases. | see Project Charter |
|
/testcases | Internal Audience | This expands the use case template structure to supply the additional fields necessary to describe a test scenario. There may be multiple test case descriptions associated with a single use case | VNFRQTS-8 |
|
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
Reqt # | Requirement text |
---|---|
xxx | As a ROLE I need SOMETHING so that SOME PURPOSE IS REALIZED |
Use Case Template
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 )